Eloquent:關聯

簡介

資料表通常會互相關聯。例如,一篇部落格文章可能有很多評論,或是一張訂單與下單的客戶相關聯。Eloquent 讓管理和處理這些關聯變得很容易,並支援多種類型的關聯:

定義關聯

你會在你的 Eloquent 模型類別內將 Eloquent 關聯定義為函式。因為關聯像 Eloquent 模型一樣也可以作為強大的查詢產生器,定義關聯為函式提供了強而有力的方法鏈結及查詢功能。例如:

$user->posts()->where('active', 1)->get();

不過,在深入了解使用關聯之前,先讓我們學習如何定義每個類型:

一對一

一對一關聯是很基本的關聯。例如一個 User 模型也許會對應到一個 Phone。要定義這種關聯,我們必須將 phone 方法放置於 User 模型上。phone 方法應該要回傳基底 Eloquent 模型類別上 hasOne 方法的結果:

<?php

namespace 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;

Eloquent 會假設對應的關聯的外鍵名稱是基於模型名稱。在這個例子裡,它會自動假設 Phone 模型擁有 user_id 外鍵。如果你想要複寫這個慣例,可以傳入第二個參數到 hasOne 方法裡。

return $this->hasOne('App\Phone', 'foreign_key');

此外,Eloquent 預設外鍵會在上層模型的 id 欄位有個對應值。換句話說,Eloquent 會尋找使用者的 id 欄位與 Phone 模型的 user_id 欄位的值相同的紀錄。如果你想讓關聯使用 id 以外的值,你可以傳遞第三個參數至 hasOne 方法來指定你自定的鍵:

return $this->hasOne('App\Phone', 'foreign_key', 'local_key');

定義相對的關聯

所以,我們可以從我們的 User 存取 Phone 模型。現在,讓我們在 Phone 模型定義一個關聯,此關聯能夠讓我們存取擁有此電話的 User。我們可以定義與 hasOne 關聯相對的 belongsTo 方法:

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Phone extends Model
{
    /**
     * 取得擁有此電話的使用者。
     */
    public function user()
    {
        return $this->belongsTo('App\User');
    }
}

在上述例子中,Eloquent 會嘗試匹配 Phone 模型的 user_idUser 模型的 id。Eloquent 判斷的預設外鍵名稱參考於關聯模型的方法,並在方法名稱後面加上 _id。當然,如果 Phone 模型的外鍵不是 user_id,你可以傳遞自定的鍵名至 belongsTo 方法的第二個參數:

/**
 * 取得擁有此電話的使用者。
 */
public function user()
{
    return $this->belongsTo('App\User', 'foreign_key');
}

如果你的上層模型不是使用 id 作為主鍵,或是你希望以不同的欄位 join 下層模型,你可以傳遞第三參數至 belongsTo 方法指定上層資料表的自定鍵:

/**
 * 取得擁有此電話的使用者。
 */
public function user()
{
    return $this->belongsTo('App\User', 'foreign_key', 'other_key');
}

一對多

一個「一對多」關聯使用於定義單一模型擁有任意數量的其他關聯模型。例如,一篇部落格文章可能有無限多筆評論。就像其他的 Eloquent 關聯一樣,可以藉由放置一個函式至你的 Eloquent 模型來定義一對多關聯:

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Post extends Model
{
    /**
     * 取得部落格文章的評論。
     */
    public function comments()
    {
        return $this->hasMany('App\Comment');
    }
}

切記,Eloquent 會自動判斷 Comment 模型上正確的外鍵欄位。以慣例來說,Eloquent 會取用自身模型的「蛇底式命名」後的名稱,並在後方加上 _id。所以,以此例來說,Eloquent 會假設 Comment 模型的外鍵是 post_id

一旦關聯被定義之後,我們可以透過 comments 屬性存取評論的集合。切記,因為 Eloquent 提供了「動態屬性」,我們可以存取關聯函式,就像他們是在模型中定義的屬性:

$comments = App\Post::find(1)->comments;

foreach ($comments as $comment) {
    //
}

當然,因為所有的關聯也提供查詢產生器的功能,你可以對取得的評論進一步增加條件,透過呼叫 comments 方法,接著在該查詢的後方鏈結上條件:

$comments = App\Post::find(1)->comments()->where('title', 'foo')->first();

就像 hasOne 方法,你也可以透過傳遞額外的參數至 hasMany 方法複寫外鍵與本地鍵:

return $this->hasMany('App\Comment', 'foreign_key');

return $this->hasMany('App\Comment', 'foreign_key', 'local_key');

定義相對的關聯

現在我們能存取所有文章的評論,讓我們定義一個透過評論存取上層文章的關聯。若要定義相對於 hasMany 的關聯,在下層模型定義一個叫做 belongsTo 方法的關聯函式:

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Comment extends Model
{
    /**
     * 取得擁有此評論的文章。
     */
    public function post()
    {
        return $this->belongsTo('App\Post');
    }
}

一旦關聯被定義之後,我們可以透過 post「動態屬性」取得 CommentPost 模型:

$comment = App\Comment::find(1);

echo $comment->post->title;

在上述例子中,Eloquent 會嘗試匹配 Comment 模型的 post_idPost 模型的 id。Eloquent 判斷的預設外鍵名稱參考於關聯模型的方法,並在方法名稱後面加上 _id。當然,如果 Comment 模型的外鍵不是 post_id,你可以傳遞自定的鍵名至 belongsTo 方法的第二個參數:

/**
 * 取得擁有此評論的文章。
 */
public function post()
{
    return $this->belongsTo('App\Post', 'foreign_key');
}

如果你的上層模型不是使用 id 作為主鍵,或是你希望以不同的欄位 join 下層模型,你可以傳遞第三參數至 belongsTo 方法指定上層資料表的自定鍵:

/**
 * Get the post that owns the comment.
 */
public function post()
{
    return $this->belongsTo('App\Post', 'foreign_key', 'other_key');
}

多對多

多對多關聯稍微比 hasOnehasMany 關聯還複雜。這種關聯的例子如,一個使用者可能用有很多身份,而一種身份可能很多使用者都有。舉例來說,很多使用者都擁有「管理者」的身份。要定義這種關聯,需要使用三個資料表:usersrolesrole_userrole_user 表命名是以相關聯的兩個模型資料表,依照字母順序命名,並包含了 user_idrole_id 欄位。

多對多關聯的定義是透過撰寫一個在自身 Eloquent 類別呼叫 belongsToMany 的方法。舉個例子,讓我們在 User 模型定義 roles 方法:

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * 屬於該使用者的身份。
     */
    public function roles()
    {
        return $this->belongsToMany('App\Role');
    }
}

一旦關聯被定義,你可以使用 roles 動態屬性存取使用者的身份:

$user = App\User::find(1);

foreach ($user->roles as $role) {
    //
}

當然,就像所有的其他關聯類型,你可以呼叫 roles 方法,接著在該關聯之後鏈結上查詢的條件:

$roles = App\User::find(1)->roles()->orderBy('name')->get();

如前文所提,若要判斷關聯合併的資料表名稱,Eloquent 會合併兩個關聯模型的名稱並依照字母順序命名。當然你可以自由的複寫這個慣例。你可以透過傳遞第二個參數至 belongsToMany 方法來達成:

return $this->belongsToMany('App\Role', 'user_roles');

除了自定合併資料表的名稱,你也可以透過傳遞額外參數至 belongsToMany 方法來自定資料表裡鍵的欄位名稱。第三個參數是你定義在關聯中的模型的外鍵名稱,而第四個參數則是你要合併的模型中的外鍵名稱:

return $this->belongsToMany('App\Role', 'user_roles', 'user_id', 'role_id');

定義相對的關聯

要定義相對於多對多的關聯,你只需要簡單的放置另一個名為 belongsToMany 至你關聯的模型。繼續我們的使用者身份範例,讓我們在 Role 模型定義 users 方法:

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Role extends Model
{
    /**
     * 屬於該身份的使用者
     */
    public function users()
    {
        return $this->belongsToMany('App\User');
    }
}

如你所見,此定義除了簡單的參考 App\User 模型外,與 User 的對應完全相同。因為我們重複使用了 belongsToMany 方法,當定義相對於多對多的關聯時,所有常用的自定資料表與鍵的選項都是可用的。

取得中介表欄位

如你所知,要操作多對多關聯需要一個中介的資料表。Eloquent 提供了一些有用的方法和這張表互動。例如,假設 User 物件關聯到很多 Role 物件。存取這些關聯物件時,我們可以在模型使用 pivot 屬性存取中介資料表的資料:

$user = App\User::find(1);

foreach ($user->roles as $role) {
    echo $role->pivot->created_at;
}

注意我們取出的每個 Role 模型物件,會自動被賦予 pivot 屬性。此屬性是代表中介表的模型,且可以像其它的 Eloquent 模型一樣被使用。

預設來說,pivot 物件只提供模型的鍵。如果你的 pivot 資料表包含了其他的屬性,可以在定義關聯方法時指定那些欄位:

return $this->belongsToMany('App\Role')->withPivot('column1', 'column2');

如果你想要樞紐表自動維護 created_atupdated_at 時間戳,在定義關聯方法時加上 withTimestamps 方法:

return $this->belongsToMany('App\Role')->withTimestamps();

遠層一對多

「遠層一對多」提供了方便簡短的方法,可以透過中介的關聯取得遠層的關聯。例如,一個 Country 模型可能透過中介的 Users 模型關聯到多個 Posts 模型。讓我們看看定義此種關聯的資料表:

countries
    id - integer
    name - string

users
    id - integer
    country_id - integer
    name - string

posts
    id - integer
    user_id - integer
    title - string

雖然 posts 本身不包含 country_id 欄位,但 hasManyThrough 關聯透過 $country->posts 來提供我們存取一個國家的文章。要執行此查詢,Eloquent 會檢查中介表 userscountry_id。在找到匹配的使用者 IDs 後,就會在 posts 資料表使用它們來查詢。

現在我們已經檢查了關聯的資料表結構,讓我們將它定義在 Country 模型:

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Country extends Model
{
    /**
     * 取得該國家的所有文章。
     */
    public function posts()
    {
        return $this->hasManyThrough('App\Post', 'App\User');
    }
}

傳遞至 hasManyThrough 方法的第一個參數為我們希望最終存取的模型名稱,而第二個參數為中介模型的名稱。

當執行關聯的查詢時,通常將會使用 Eloquent 的外鍵慣例。如果你想要自定關聯的鍵,你可以傳遞它們至 hasManyThrough 方法的第三與第四個參數。第三個參數為中介模型的外鍵名稱,而第四個參數為最終模型的外鍵名稱。

class Country extends Model
{
    public function posts()
    {
        return $this->hasManyThrough('App\Post', 'App\User', 'country_id', 'user_id');
    }
}

多型關聯

資料表結構

多型關聯允許一個模型在單一的關聯從屬一個以上的其他模型。舉個例子,假設你想儲存照片給你的工作人員及你的產品。使用多型關聯,你可以對這兩種情況使用單一的 photos 資料表。首先,讓我們查看建立這種關聯所需的資料表結構:

staff
    id - integer
    name - string

products
    id - integer
    price - integer

photos
    id - integer
    path - string
    imageable_id - integer
    imageable_type - string

有兩個要注意的重要欄位是 photos 資料表的 imageable_idimageable_type 欄位。imageable_id 欄位會包含所屬的工作人員或產品的 ID 值,而 imageable_type 欄位會包含所屬的模型類別名稱。當存取 imageable 關聯時,imageable_type 欄位會被 ORM 用於判斷所屬的模型是哪個「類型」。

模型結構

接著,讓我們查看建立這種關聯所需的模型定義:

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Photo extends Model
{
    /**
     * 取得所有所屬的可擁有圖片的模型。
     */
    public function imageable()
    {
        return $this->morphTo();
    }
}

class Staff extends Model
{
    /**
     * 取得所有工作人員的照片。
     */
    public function photos()
    {
        return $this->morphMany('App\Photo', 'imageable');
    }
}

class Product extends Model
{
    /**
     * 取得所有產品的照片。
     */
    public function photos()
    {
        return $this->morphMany('App\Photo', 'imageable');
    }
}

取得多型關聯

一旦你的資料表及模型被定義後,你可以透過你的模型存取關聯。例如,若要存取工作人員的所有照片,我們可以簡單的使用 photos 動態屬性:

$staff = App\Staff::find(1);

foreach ($staff->photos as $photo) {
    //
}

你也可以從多型模型的多型關聯裡,透過存取執行呼叫 morphTo 的方法名稱取得擁有者。在我們例子中,就是 Phone 模型中的 imageable 方法。所以,我們可以存取使用動態屬性存取這個方法:

$photo = App\Photo::find(1);

$imageable = $photo->imageable;

Photo 模型的 imageable 關聯會回傳 StaffProduct 實例,這取決於照片所屬模型的類型。

自訂多型

Laravel 會使用完全符合的類別名稱來儲存關聯模型的類型,例如:根據上面範例給定的 Like 可能屬於一個 Post 或一個 Comment,預設 likable_type 分別會是 App\PostApp\Comment。然而,你可能想要從你的應用程式內部的結構將資料庫解耦。在這種情況下,你可以定義一個關聯「變形對映」,指示 Eloquent 是使用每個模型的資料名稱關聯而不是類別名稱:

Relation::morphMap([
    App\Post::class,
    App\Comment::class,
]);

或者,你也可以指定自訂的字串來關聯每個模型:

Relation::morphMap([
    'posts' => App\Post::class,
    'likes' => App\Like::class,
]);

你可以在你的 AppServiceProvider 註冊 morphMap,或者如果你希望的話,可以單獨建立一個服務提供者。

多型多對多關聯

資料表結構

除了一般的多型關聯,你也可以定義「多對多」的多型關聯。例如,部落格的 PostVideo 模型可以共用多型關聯至 Tag 模型。使用多對多的多型關聯能夠讓你的部落格文章及影片共用獨立標籤的單一列表。首先,讓我們查看資料表結構:

posts
    id - integer
    name - string

videos
    id - integer
    name - string

tags
    id - integer
    name - string

taggables
    tag_id - integer
    taggable_id - integer
    taggable_type - string

模型結構

接著,我們已經準備好定義模型的關聯。PostVideo 模型會都擁有 tags 方法,並在該方法內呼叫自身 Eloquent 類別的 morphToMany 方法:

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Post extends Model
{
    /**
     * 取得該文章的所有標籤。
     */
    public function tags()
    {
        return $this->morphToMany('App\Tag', 'taggable');
    }
}

定義相對的關聯

然後,在 Tag 模型上,你必須對每個要關聯的模型定義一個方法。所以,在這個例子裡,我們需要定義一個 posts 方法及一個 videos 方法:

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Tag extends Model
{
    /**
     * 取得所有被賦予該標籤的文章。
     */
    public function posts()
    {
        return $this->morphedByMany('App\Post', 'taggable');
    }

    /**
     * 取得所有被賦予該標籤的影片。
     */
    public function videos()
    {
        return $this->morphedByMany('App\Video', 'taggable');
    }
}

取得關聯

一旦你的資料表及模型被定義後,你可以透過你的模型存取關聯。例如,若要存取文章的所有標籤,你可以簡單的使用 tags 動態屬性:

$post = App\Post::find(1);

foreach ($post->tags as $tag) {
    //
}

你也可以從多型模型的多型關聯裡,透過存取執行呼叫 morphedByMany 的方法名稱取得擁有者。在我們例子中,就是 Tag 模型中的 postsvideos 方法。所以,你可以存取使用動態屬性存取這個方法:

$tag = App\Tag::find(1);

foreach ($tag->videos as $video) {
    //
}

查詢關聯

因為所有類型的 Eloquent 關聯都是透過函式定義,你可以呼叫這些函式獲得關聯的一個實例,並不需要實際執行關聯的查詢。此外,所有類型的 Eloquent 關聯也提供了查詢產生器的功能,讓你能夠在你對你的資料庫執行該 SQL 前,在關聯查詢接著鏈結上條件。

例如,假設有一個部落格系統,其中 User 模型擁有許多關聯的 Post 模型:

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * 取得該使用者的所有文章。
     */
    public function posts()
    {
        return $this->hasMany('App\Post');
    }
}

你可以查詢 posts 關聯並增加額外的條件至關聯,像是:

$user = App\User::find(1);

$user->posts()->where('active', 1)->get();

請注意,你可以在關聯使用查詢產生器的任何方法!

關聯方法與動態屬性

如果你不需要增加額外的條件至 Eloquent 的關聯查詢,你可以簡單的存取關聯就如同屬性一樣。例如,延續我們剛剛的 UserPost 範例模型,我們可以存取所有使用者的文章,像是:

$user = App\User::find(1);

foreach ($user->posts as $post) {
    //
}

動態屬性是「延遲載入」,意指它們只會在你需要存取它們的時候載入關聯資料。正因為如此,開發者通常使用預載入來預先載入在載入模型後將會被存取的關聯資料。預載入提供了一個明顯減少會被執行於載入模型關聯的 SQL 查詢。

查詢關聯是否存在

當存取模型的紀錄時,你可能希望根據關聯的存在限制你的結果。例如,假設你想取得部落格的所有至少有一篇評論的文章。要達成這項功能,你可以傳遞名稱至關聯的 has 方法:

// 取得所有至少有一篇評論的文章...
$posts = App\Post::has('comments')->get();

你也可以制定運算子及數量來進一步的自定該查詢:

// 取得所有至少有三篇評論的文章...
$posts = Post::has('comments', '>=', 3)->get();

也可以使用「點」符號建構巢狀的 has 語句。例如,你可能想取得所有至少有一篇評論被評分的文章:

// 取得所有至少有一篇評論被評分的文章...
$posts = Post::has('comments.votes')->get();

如果你想要更進階的用法,可以使用 whereHasorWhereHas 方法,在 has 查詢裡設定「where」條件。此方法可以讓你增加自訂的條件至關聯條件中,像是檢查評論的內容:

// 取得所有至少有一篇評論相似於 foo% 的文章
$posts = Post::whereHas('comments', function ($query) {
    $query->where('content', 'like', 'foo%');
})->get();

預載入

當透過屬性存取 Eloquent 關聯時,該關聯資料會被「延遲載入」。意指該關聯資料直到你第一次以屬性存取前,實際上並沒有被載入。不過,Eloquent 可以在你查詢上層模型時「預載入」關聯資料。預載入避免了 N + 1 查詢的問題。要說明 N + 1 查詢的問題,試想一個 Book 模型會關聯至 Author

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Book extends Model
{
    /**
     * 取得撰寫該書的作者。
     */
    public function author()
    {
        return $this->belongsTo('App\Author');
    }
}

現在,讓我們取得所有的書籍及其作者:

$books = App\Book::all();

foreach ($books as $book) {
    echo $book->author->name;
}

上方的迴圈會執行一次查詢並取回所有資料表上的書籍,然後每本書都會執行一次查詢取得作者。所以,若有 25 本書,迴圈就會進行 26 次查詢:1 次是原本的書籍,及對每本書查詢並取得作者的額外 25 次。

很幸運地,我們可以使用預載入將查詢的操作減少至 2 次。當查詢時,使用 with 方法指定想要預載入的關聯資料:

$books = App\Book::with('author')->get();

foreach ($books as $book) {
    echo $book->author->name;
}

對於該操作,只會執行兩次查詢:

select * from books

select * from authors where id in (1, 2, 3, 4, 5, ...)

預載入多種關聯

有時你可能想要在單次操作中預載入多種不同的關聯。要這麼做,只需要傳遞額外的參數至 方法

$books = App\Book::with('author', 'publisher')->get();

巢狀預載入

若要預載入巢狀關聯,你可以使用「點」語法。例如,讓我們在一個 Eloquent 語法中,預載入所有書籍的作者,及所有作者的個人聯絡方式:

$books = App\Book::with('author.contacts')->get();

預載入條件限制

有時你可能想要預載入關聯,並且指定預載入額外的查詢條件。下面有一個例子:

$users = App\User::with(['posts' => function ($query) {
    $query->where('title', 'like', '%first%');

}])->get();

在這個例子裡,Eloquent 只會預載入文章標題欄位包含 first 的文章。當然,你也可以呼叫其他的查詢產生器來進一步自定預載入的操作:

$users = App\User::with(['posts' => function ($query) {
    $query->orderBy('created_at', 'desc');

}])->get();

延遲預載入

有時你可能需要在上層模型已經被取得後才預載入關聯。例如,當你需要動態決定是否載入關聯模型時相當有幫助:

$books = App\Book::all();

if ($someCondition) {
    $books->load('author', 'publisher');
}

如果你想設定預載入查詢的額外條件,你可以傳遞一個 閉包load 方法:

$books->load(['author' => function ($query) {
    $query->orderBy('published_date', 'asc');
}]);

寫入關聯模型

Save 方法

Eloquent 提供了方便的方法來增加新的模型至關聯中。例如,也許你需要寫入新的 CommnetPost 模型中。除了手動設定 Commnetpost_id 屬性外,你也可以直接使用關聯的 save 方法寫入 Comment

$comment = new App\Comment(['message' => 'A new comment.']);

$post = App\Post::find(1);

$post->comments()->save($comment);

注意我們並沒有使用動態屬性存取 comments 關聯。相反地,我們呼叫 comments 方法取得關聯的實例。save 方法會自動在新的 Comment 模型增加正確的 post_id 值。

如果你需要儲存多筆關聯模型,你可以使用 saveMany 方法:

$post = App\Post::find(1);

$post->comments()->saveMany([
    new App\Comment(['message' => 'A new comment.']),
    new App\Comment(['message' => 'Another comment.']),
]);

Save 與多對多關聯

當使用多對多關聯時,save 方法允許傳入一個額外的中介表屬性陣列作為第二個參數:

App\User::find(1)->roles()->save($role, ['expires' => $expires]);

Create 方法

除了 savesaveMany 方法,你也可以使用 create 方法,該方法允許傳入屬性的陣列來立模型,並寫入至資料庫。同樣的,savecreate 不同的地方是,save 允許傳入一個完整的 Eloquent 模型實例,但 create 只允許原始的 PHP 陣列

$post = App\Post::find(1);

$comment = $post->comments()->create([
    'message' => 'A new comment.',
]);

在使用 create 方法前,請確定瀏覽了文件的批量賦值章節。

更新「從屬」關聯

當更新一個 belongsTo 關聯時,你可以使用 associate 方法。此方法會設定外鍵至下層模型:

$account = App\Account::find(10);

$user->account()->associate($account);

$user->save();

當刪除一個 belongsTo 關聯時,你可以使用 dissociate 方法。此方法會重置關聯至此下層模型的外鍵:

$user->account()->dissociate();

$user->save();

多對多關聯

附加與卸除

當使用多對多關聯時,Eloquent 提供一些額外的輔助方法讓操作關聯模型時更加方便。例如,讓我們假設一個使用者可以擁有多個身份,且每個身份可以被多個使用者擁有。要附加一個規則至一個使用者,並 join 模型及寫入記錄至中介表,可以使用 attach 方法:

$user = App\User::find(1);

$user->roles()->attach($roleId);

當附加一個關聯至模型時,你也可以傳遞一個需被寫入至中介表的額外資料陣列:

$user->roles()->attach($roleId, ['expires' => $expires]);

當然,有些時候也需要移除使用者的一個身份。要移除一個多對多的紀錄,使用 detach 方法。detach 方法會從中介表中移除正確的紀錄;當然,兩個模型依然會存在於資料庫中:

// 從使用者上移除單一身份...
$user->roles()->detach($roleId);

// 從使用者上移除所有身份...
$user->roles()->detach();

為了方便,attachdetach 都允許傳入 IDs 的陣列:

$user = App\User::find(1);

$user->roles()->detach([1, 2, 3]);

$user->roles()->attach([1 => ['expires' => $expires], 2, 3]);

為了方便的同步

你也可以使用 sync 方法建構多對多關聯。sync 允許傳入放置於中介表的 IDs 陣列。任何不在給定陣列中的 IDs 將會從中介表中被刪除。所以,在此操作結束後,只會有陣列中的 IDs 存在於中介表中:

$user->roles()->sync([1, 2, 3]);

你也可以傳遞中介表上該 IDs 額外的值:

$user->roles()->sync([1 => ['expires' => true], 2, 3]);

連動上層時間戳記

當一個模型 belongsTobelongsToMany 另一個模型時,像是一個 Comment 屬於一個 Post,對於下層模型被更新時,欲更新上層的時間戳記相當有幫助。舉例來說,當一個 Commnet 模型被更新,你可能想要自動的「連動」所屬 Postupdated_at 時間戳記。Eloquent 使得此事相當容易。只要在關聯的下層模型增加一個包含名稱的 touches 屬性即可:

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Comment extends Model
{
    /**
     * 所有的關聯將會被連動。
     *
     * @var array
     */
    protected $touches = ['post'];

    /**
     * 取得擁有此評論的文章。
     */
    public function post()
    {
        return $this->belongsTo('App\Post');
    }
}

現在,當你更新一個 Comment,它所屬的 Post 擁有的 updated_at 欄位也會同時更新:

$comment = App\Comment::find(1);

$comment->text = '編輯此評論!';

$comment->save();