PHPDocでPHPの魔法のプロパティを非難する方法は？

Question

magic propertyを非推奨とする方法はありますか？彼らはもうExample::$fooを使用してはならないこと、

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

は今、どのように他の開発者を示すために、次の、簡略化されたコードを考えてみましょうか？

/** 
* 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

@deprecatedは構造要素（documentation）としか関連付けられていないため、これはPHPDocでは不可能です。

開発者が、彼らはもはや、この魔法のプロパティを使用するべきではないことを知っているために、あなたは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に無名関数を割り当てることができます。したがって、そのロジックは、$fooが明示的に定義されるとすぐに実行パスから外れた__get()に存在しなくなりました。

/** 
* 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 
    } 
}