如何在PHPDoc中棄用PHP的魔術屬性？

Question

有沒有辦法將magic property標記爲已棄用？考慮下面，簡化代碼：

/** 
* Example class 
* 
* @property string $foo A foo variable. 
*/ 
class Example { 
    /** 
    * Magic getter 
    */ 
    public function __get($var) { 
     if('foo' === $var) { 
      // do & return something 
     } 
    } 
} 

現在，如何指示其他開發人員，他們不應該用Example::$foo了嗎？這使我想到的唯一的工作解決方法是：

/** 
* Example class 
*/ 
class Example { 
    /** 
    * A foo variable. 
    * 
    * @var string 
    * @deprecated 
    */ 
    public $foo; 

    /** 
    * Magic getter 
    */ 
    public function __get($var) { 
     if('foo' === $var) { 
      // do & return something 
     } 
    } 
} 

但這兩者打破我的代碼（吸氣不叫），並不會覺得很優雅。

Answer 1

這對於PHPDoc來說是不可能的，因爲@deprecated只能與結構元素（documentation）關聯。

如果真的是重要的開發人員知道，他們不應該再使用這個魔法屬性，可以觸發一個E_USER_DEPRECATED錯誤：

/** 
* Example class 
* 
* @property string $foo A foo variable. 
*/ 
class Example { 

    public function __get($name) 
    { 
     if ($name === 'foo') { 
      trigger_error('Property $foo is deprecated and should no longer be used', E_USER_DEPRECATED); 
     } 
     // ... 
    } 
} 

Answer 2

我覺得這裏你最好的選擇將是顯式定義$foo財產，以便您可以用@deprecated對其進行記錄。爲了保持當前使用$myExample->foo所導致的// do & return something行爲，您可以在構造函數中將一個匿名函數分配給$this->foo。因此，該邏輯不再存在於__get()中，只要$foo被明確定義，該邏輯就落在執行路徑之外。

/** 
* Example class 
*/ 
class Example { 

    /** 
    * A foo variable. 
    * 
    * @var string 
    * @deprecated 
    */ 
    public $foo; 

    /** 
    * constructor 
    */ 
    public function __construct() { 
     $this->foo = function() { 
      // do & return something 
     }; 
    } 

    /** 
    * Magic getter 
    */ 
    public function __get($var) { 
     // no longer handles calls to $this->foo 
    } 
}