Eloquent：集合

• 簡介
• 可用的方法
• 自訂集合

簡介

所有回傳多個模型結果的 Eloquent 方法，都會回傳 Illuminate\Database\Eloquent\Collection 類別的實例，包括透過 get 方法檢索或透過關聯存取的結果。Eloquent 集合物件擴充了 Laravel 的基本集合，因此它自然地繼承了許多方法，可流暢地使用底層的 Eloquent 模型陣列。請務必檢閱 Laravel 集合文件，以了解所有這些有用的方法！

所有集合也充當迭代器，允許您像簡單的 PHP 陣列一樣迴圈處理它們。

use App\Models\User;
 
$users = User::where('active', 1)->get();
 
foreach ($users as $user) {
    echo $user->name;
}

然而，如先前所述，集合比陣列強大得多，並且公開了各種映射/減少操作，可以使用直觀的介面鏈結這些操作。例如，我們可以移除所有非使用中的模型，然後收集每個剩餘使用者的名字。

$names = User::all()->reject(function (User $user) {
    return $user->active === false;
})->map(function (User $user) {
    return $user->name;
});

Eloquent 集合轉換

雖然大多數 Eloquent 集合方法會回傳 Eloquent 集合的新實例，但 collapse、flatten、flip、keys、pluck 和 zip 方法會回傳基本集合的實例。同樣地，如果 map 操作回傳不包含任何 Eloquent 模型的集合，則會將其轉換為基本集合實例。

可用的方法

所有 Eloquent 集合都擴充了基本的Laravel 集合物件；因此，它們繼承了基本集合類別提供的所有強大方法。

此外，Illuminate\Database\Eloquent\Collection 類別提供了一組超集方法，以協助管理您的模型集合。大多數方法會回傳 Illuminate\Database\Eloquent\Collection 實例；但是，有些方法（例如 modelKeys）會回傳 Illuminate\Support\Collection 實例。

append($attributes)

append 方法可用來指示應為集合中的每個模型附加屬性。此方法接受屬性陣列或單一屬性。

$users->append('team');
 
$users->append(['team', 'is_admin']);

contains($key, $operator = null, $value = null)

contains 方法可用來判斷集合是否包含指定的模型實例。此方法接受主鍵或模型實例。

$users->contains(1);
 
$users->contains(User::find(1));

diff($items)

diff 方法會回傳給定集合中不存在的所有模型。

use App\Models\User;
 
$users = $users->diff(User::whereIn('id', [1, 2, 3])->get());

except($keys)

except 方法會回傳沒有給定主鍵的所有模型。

$users = $users->except([1, 2, 3]);

find($key)

find 方法會回傳主鍵與給定索引鍵相符的模型。如果 $key 是模型實例，find 會嘗試回傳主鍵相符的模型。如果 $key 是索引鍵的陣列，find 會回傳主鍵在給定陣列中的所有模型。

$users = User::all();
 
$user = $users->find(1);

findOrFail($key)

findOrFail 方法會回傳主鍵與給定索引鍵相符的模型，如果集合中找不到相符的模型，則會擲回 Illuminate\Database\Eloquent\ModelNotFoundException 例外狀況。

$users = User::all();
 
$user = $users->findOrFail(1);

fresh($with = [])

fresh 方法會從資料庫中檢索集合中每個模型的新實例。此外，任何指定的關聯都會被預先載入。

$users = $users->fresh();
 
$users = $users->fresh('comments');

intersect($items)

intersect 方法會回傳也存在於給定集合中的所有模型。

use App\Models\User;
 
$users = $users->intersect(User::whereIn('id', [1, 2, 3])->get());

load($relations)

load 方法會預先載入集合中所有模型指定的關聯。

$users->load(['comments', 'posts']);
 
$users->load('comments.author');
 
$users->load(['comments', 'posts' => fn ($query) => $query->where('active', 1)]);

loadMissing($relations)

如果關聯尚未載入，loadMissing 方法會預先載入集合中所有模型指定的關聯。

$users->loadMissing(['comments', 'posts']);
 
$users->loadMissing('comments.author');
 
$users->loadMissing(['comments', 'posts' => fn ($query) => $query->where('active', 1)]);

modelKeys()

modelKeys 方法會回傳集合中所有模型的主鍵。

$users->modelKeys();
 
// [1, 2, 3, 4, 5]

makeVisible($attributes)

makeVisible 方法使集合中每個模型上通常「隱藏」的屬性可見。

$users = $users->makeVisible(['address', 'phone_number']);

makeHidden($attributes)

makeHidden 方法隱藏集合中每個模型上通常「可見」的屬性。

$users = $users->makeHidden(['address', 'phone_number']);

only($keys)

only 方法會回傳具有給定主鍵的所有模型。

$users = $users->only([1, 2, 3]);

setVisible($attributes)

setVisible 方法會暫時覆寫集合中每個模型上的所有可見屬性。

$users = $users->setVisible(['id', 'name']);

setHidden($attributes)

setHidden 方法會暫時覆寫集合中每個模型上的所有隱藏屬性。

$users = $users->setHidden(['email', 'password', 'remember_token']);

toQuery()

toQuery 方法會回傳一個 Eloquent 查詢建構器實例，其中包含集合模型主鍵的 whereIn 條件約束。

use App\Models\User;
 
$users = User::where('status', 'VIP')->get();
 
$users->toQuery()->update([
    'status' => 'Administrator',
]);

unique($key = null, $strict = false)

unique 方法會回傳集合中所有唯一的模型。具有與集合中另一個模型相同主鍵的任何模型都會被移除。

$users = $users->unique();

自訂集合

如果您想在與給定模型互動時使用自訂的 Collection 物件，您可以將 CollectedBy 屬性新增至您的模型。

<?php
 
namespace App\Models;
 
use App\Support\UserCollection;
use Illuminate\Database\Eloquent\Attributes\CollectedBy;
use Illuminate\Database\Eloquent\Model;
 
#[CollectedBy(UserCollection::class)]
class User extends Model
{
    // ...
}

或者，您可以在模型上定義 newCollection 方法。

<?php
 
namespace App\Models;
 
use App\Support\UserCollection;
use Illuminate\Database\Eloquent\Collection;
use Illuminate\Database\Eloquent\Model;
 
class User extends Model
{
    /**
     * Create a new Eloquent Collection instance.
     *
     * @param  array<int, \Illuminate\Database\Eloquent\Model>  $models
     * @return \Illuminate\Database\Eloquent\Collection<int, \Illuminate\Database\Eloquent\Model>
     */
    public function newCollection(array $models = []): Collection
    {
        return new UserCollection($models);
    }
}

一旦您在模型上定義了 newCollection 方法或新增了 CollectedBy 屬性，每當 Eloquent 通常回傳 Illuminate\Database\Eloquent\Collection 實例時，您都會收到自訂集合的實例。

如果您想為應用程式中的每個模型使用自訂集合，您應該在所有應用程式模型擴充的基本模型類別上定義 newCollection 方法。