場景是這樣的,有一個BaseModel(繼承自ActionRecord),所有的其他model都繼承自它,然后其中有一個方法,簡單貼下這個類的代碼:
html' target='_blank'>class BaseModel extends ActiveRecord protected $temp_model; public function getCacheModel() return $this- temp_model;}
這個方法的作用是取得在做參數驗證時,從數據庫查出的,緩存下來的實例對象。
這個時候,問題來了,我在取出這個對象的時候,PHPstorm沒有了提示(如方法提示,屬性提示等),按照一般的情況,只需要在方法前面加上@return注釋就可以了。
/** * @return staticpublic 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數據賦值。
最后,因為并不是我一個人在寫,所以沒有辦法進行大刀闊斧地改動,只能盡可能地優化。
相關文章推薦:
php遞歸函數return會出現無法正確返回想要值的情況
PHP中返回引用類型的方法,php返回引用類型
以上就是如何來正確注釋@return來讓PHPstorm動態返回類的詳細內容,PHP教程
鄭重聲明:本文版權歸原作者所有,轉載文章僅為傳播更多信息之目的,如作者信息標記有誤,請第一時間聯系我們修改或刪除,多謝。
新聞熱點
疑難解答