正確註釋@return讓PHPstorm動態返回類

場景是這樣的，有一個BaseModel（繼承自ActionRecord），全部的其餘model都繼承自它，而後其中有一個方法，簡單貼下這個類的代碼，：

class BaseModel extends ActiveRecord
{
    protected $temp_model;
    
    public function getCacheModel()
    {
        return $this->temp_model;
    }
}

這個方法的做用是取得在作參數驗證時，從數據庫查出的，緩存下來的實例對象。
這個時候，問題來了，我在取出這個對象的時候，PHPstorm沒有了提示（如方法提示，屬性提示等），按照通常的狀況，只須要在方法前面加上@return註釋就能夠了。

/**
 * @return static
 */
public function getCacheModel()
{
    return $this->temp_model;
}

咱們繼續深刻研究一下，關於這個static的意思，我特意在PHPDoc上查閱了一下，

static
An object of the class where this value was consumed, if inherited it will represent the child class. (see late static binding in the PHP manual).

Google翻譯一下，大意以下：
消耗此值的類的對象，若是繼承它將表示子類。
（參見PHP手冊中的後期靜態綁定）。

大概意思就是就會返回調用這個方法的類，若是是父類方法子類調用，那麼將返回子類。

相似的還有2個

self
An object of the class where this type was used, if inherited it will still represent the class where it was originally defined.
$this
This exact object instance, usually used to denote a fluent interface.

直譯以下，
self:使用此類型的類的對象，若是繼承它，它仍將表示最初定義它的類。
大意就是和static差很少，可是父類方法子類調用，仍然返回父類。
$this:這個確切的對象實例，一般用於表示流暢的界面。
和self差很少。

可是到了這裏，個人問題仍然沒有解決，不管我@return的值改爲什麼，仍然返回的是BaseModel，儘管我在這個getCacheModel()方法裏打印 self::className() 時，出現的是子類名。

因而咱們繼續往上面看，我是在controller調用的，controller的代碼以下：

public function actionCommitReward()
{
    $model=$this->goCheck(new TakeRewards(['scenario'=>'commit_reward']));

    //獲取實際要修改的數據
    $reward = $model->getCacheModel();
}

看起來沒有什麼問題，這個時候咱們要注意了， $model 是由$this->goCheck()調用獲得的，咱們去看一下goCheck方法：

//驗證參數是否合法
public function goCheck($model, $dada = '')
{
    $data = $this->postData;//post傳入的數據
    if ($model->load($data, '') && $model->validate())//數據效驗

return $model;

else (new PublicFunction())->returnWayTip('1001', PublicFunction::getModelError($model));//這裏理解成拋異常
}

這裏不規範的地方出現了，因爲這裏傳入的是model（對象類型），因此PHPstorm並無法知道咱們具體傳入的是什麼類，加上註釋後：

/**
 * @param object $model
 * @param string $dada
 * @return model1|model2
 */

這樣後，問題「勉強解決」。只是每增長一個表，會須要在@return裏增長表相對應的類名，並且會有類原本不該該存在的屬性被提示。

爲何這裏不能用static呢？ 由於這裏是$this調用的，返回controller類，並無什麼用，而這個也致使了後面使用$model->getCacheModel()方法時，沒有辦法正常識別應該返回的類（返回什麼類取決與goCheck的@return註釋是什麼）。

固然你能夠不寫註釋，那麼你會發現，因此的提示都沒有了。
此次我才真正意識到了註釋的重要性。。。原來PHPstorm之因此都提示，都是由於你們按PHPDoc的規範寫了註釋啊！

最後可能有同窗會問了，爲何不把goChekc方法放到BaseModel裏呢？對的，實際上規範的作法是應該這樣的，可是由於我這樣把Yii::$app->request->post()賦值在controller裏的$this->postData裏（雖然這樣方便一丟丟），並且在作token換id的一些操做了進行了手動賦值，因此沒有辦法，由於在model獲取不到這個postData，固然你必定要挪進去也是能夠的，只不過每次都須要傳參$this->postData，見仁見智吧。

可是，這2個方法都並不規範，$this->postData = Yii::$app->request->post(); 把全局的變量變成了一個局部變量，規範的作法應該是使用Yii::$app->request->post($name,$dafaultValue)來給post數據賦值。

最後，由於並非我一我的在寫，因此沒有辦法進行大刀闊斧地改動，只能儘量地優化。BTW，但願大佬們有更好的意見能夠說說，由於我的比較經驗也比較不足，都是本身摸索。