Laravel模型中的動態屬性

Laravel的文檔里對于Model的動態屬性講的比較簡略,理解起來有些模糊,最近在偉大的蝦米的帶領下終于搞明白了,在此做一個比較詳細的總結。

一、引入

首先上Laravel文檔相關部分。一對一關聯是很基本的關聯。例如一個User模型也許會對應一個Phone。要定義這種關聯,我們必須將phone方法放置于User模型上。phone方法應該要返回基類Eloquent上的hasOne方法的結果:

<?phpnamespace App;
use Illuminate\Database\Eloquent\Model;
class User extends Model
{ 
    /** 
    * 獲取與指定用戶互相關聯的電話紀錄。 
    */ 
    public function phone() { 
        return $this->hasOne('App\Phone'); 
    }
}

傳到hasOne方法里的第一個參數是關聯模型的類名稱。定義好關聯之后,我們就可以使用Eloquent的動態屬性來獲取關聯紀錄。動態屬性讓你能夠訪問關聯函數,就像他們是在模型中定義的屬性:

$phone = User::find(1)->phone;

但這里只講了動態屬性的最簡單的一種形式,也就是調用的屬性不存在,但存在同名的方法時,則會調用同名的方法,返回的類型是collection類型(Eloquent的集合)。下文讓我們走一遍Laravel的源代碼看看還有其他幾種不同種類的動態屬性。

二、Laravel源代碼trace

1、對于動態屬性疑問的產生

蝦米在梅林項目的blade里用到了一個方法,但是usermodel里并不存在同名的avatar_src()方法,但是存在一個getAvatarSrcAttribute()名字有點像的方法,當時就覺得很懵逼,看代碼的確是調用了這個方法,但不知是如何關聯起來的,所以想搞明白這里面的邏輯究竟是怎么回事。

<a href="#"><img src="{{ Auth::user()->avatar_src }}" alt=""></a>

2、__get()

那么問題來了,如何追溯?這里需要的一個預備知識是關于PHP的魔術方法__get(),當讀取不可訪問屬性的值時,__get()會被調用。所以決定從這個方法開始進行追溯。具體的方法是在PhpStorm里打開user模型的代碼,在菜單欄選擇Navigate-File Structure,彈出的框子里勾選Show inherited members,英文輸入狀態下輸入get可以找到我們想要的方法,點進去可以看到__get()方法源代碼如下:

    /**
     * Dynamically retrieve attributes on the model.
     *
     * @param  string  $key
     * @return mixed
     */
    public function __get($key)
    {
        return $this->getAttribute($key);
    }

3、getAttribute($key)

    /**
     * Get an attribute from the model.
     *
     * @param  string  $key
     * @return mixed
     */
    public function getAttribute($key)
    {
        if (array_key_exists($key, $this->attributes) || $this->hasGetMutator($key)) {
            return $this->getAttributeValue($key);
        }

        return $this->getRelationValue($key);
    }

第一個if的左半邊,如果這個model有這個attribute那么就直接返回,沒什么可說的。
第一個if的右半邊mutator是變異體的意思事實上處理了本節開頭的疑問,看一下源代碼:

    /**
     * Determine if a get mutator exists for an attribute.
     *
     * @param  string  $key
     * @return bool
     */
    public function hasGetMutator($key)
    {
        return method_exists($this, 'get'.Str::studly($key).'Attribute');
    }

本方法的作用是判斷所調用的這個不存在的屬性是否存在“按照一定格式變形的類似名字的方法”。所謂的“一定格式”可以參考Studly caps命名法,對應的源代碼:

    /**
     * Convert a value to studly caps case.
     *
     * @param  string  $value
     * @return string
     */
    public static function studly($value)
    {
        $key = $value;

        if (isset(static::$studlyCache[$key])) {
            return static::$studlyCache[$key];
        }

        $value = ucwords(str_replace(['-', '_'], ' ', $value));

        return static::$studlyCache[$key] = str_replace(' ', '', $value);
    }

注意到經studly caps處理過的-和_都會被去掉。再回到hasGetMutator($key)這個方法,我們可以看到Laravel會嘗試去尋找名字形似getStudlyCapsNameAttribute()的方法,如果有的話則會在getAttribute($key)里返回相關的值。第一小節提到的例子對應的方法名我們可以知道當調用這個不存在的屬性avatar_src時,Laravel會嘗試調用getAvatarSrcAttribute()這個方法,看了下代碼果然是存在這個方法的,開始的疑問解決啦~

4、getRelationValue($key)

回到getAttribute($key)這個方法,如果在第一個if里沒有返回則會調用getRelationValue($key)這個方法,源代碼如下:

    /**
     * Get a relationship.
     *
     * @param  string  $key
     * @return mixed
     */
    public function getRelationValue($key)
    {
        // If the key already exists in the relationships array, it just means the
        // relationship has already been loaded, so we'll just return it out of
        // here because there is no need to query within the relations twice.
        if ($this->relationLoaded($key)) {
            return $this->relations[$key];
        }

        // If the "attribute" exists as a method on the model, we will just assume
        // it is a relationship and will load and return results from the query
        // and hydrate the relationship's value on the "relationships" array.
        if (method_exists($this, $key)) {
            return $this->getRelationshipFromMethod($key);
        }
    }

第一個if注釋寫得很清楚了,第二個if就是判斷是否存在和所調用屬性同名的方法,如果存在則調用getRelationshipFromMethod($key)方法。

5、getRelationshipFromMethod($method)

這個方法比較關鍵,我們看一下源代碼:

    /**
     * Get a relationship value from a method.
     *
     * @param  string  $method
     * @return mixed
     *
     * @throws \LogicException
     */
    protected function getRelationshipFromMethod($method)
    {
        $relations = $this->$method();

        if (! $relations instanceof Relation) {
            throw new LogicException('Relationship method must return an object of type '
                .'Illuminate\Database\Eloquent\Relations\Relation');
        }

        $this->setRelation($method, $results = $relations->getResults());

        return $results;
    }

注意if語句塊那里的判斷,意味著與屬性同名的方法的返回類型必須是Relation類型或者是它的子類,例如hasMany等。所以如果要另外做處理,返回的類型不為Relation的話可以參考第四小節那樣的命名法構造相關方法名。另外,setRelation那一行的意思是將沒有加載的relation進行加載,那么下次需要時就可以在getRelationValue($key)的第一個if中即返回需要的結果。還有值得注意的是此方法最后的返回值返回的$resultsCollection類型,也就是說如果調用不存在的動態屬性后返回的是Collection類型,而如果我們直接調用方法返回的則是Relation類型,可以在其上構造查詢進一步處理,而再調用getResults()后才能再獲得Collection類型的返回值。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,431評論 6 544
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,637評論 3 429
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 178,555評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,900評論 1 318
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,629評論 6 412
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,976評論 1 328
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,976評論 3 448
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 43,139評論 0 290
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,686評論 1 336
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,411評論 3 358
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,641評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,129評論 5 364
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,820評論 3 350
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,233評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,567評論 1 295
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,362評論 3 400
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,604評論 2 380

推薦閱讀更多精彩內容

  • 國家電網公司企業標準(Q/GDW)- 面向對象的用電信息數據交換協議 - 報批稿:20170802 前言: 排版 ...
    庭說閱讀 11,075評論 6 13
  • Spring Cloud為開發人員提供了快速構建分布式系統中一些常見模式的工具(例如配置管理,服務發現,斷路器,智...
    卡卡羅2017閱讀 134,828評論 18 139
  • 1. Java基礎部分 基礎部分的順序:基本語法,類相關的語法,內部類的語法,繼承相關的語法,異常的語法,線程的語...
    子非魚_t_閱讀 31,737評論 18 399
  • 轉至元數據結尾創建: 董瀟偉,最新修改于: 十二月 23, 2016 轉至元數據起始第一章:isa和Class一....
    40c0490e5268閱讀 1,755評論 0 9
  • 那是遺落在冷清街道的一個影子 憑身形,依稀辨來是個醉漢 旁邊癱坐著幾個酒瓶,唱得有氣無力: 生活,已是如此艱難 我...
    青色的木頭閱讀 245評論 1 2