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

然而，如前所述，集合比陣列強大得多，並公開了各種 map / reduce 操作，這些操作可以使用直覺的介面串聯起來。例如，我們可以移除所有不活躍的模型，然後收集每個剩餘使用者的名字：

$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']);

mergeVisible($attributes)

mergeVisible 方法使其他屬性可見，同時保留現有的可見屬性：

$users = $users->mergeVisible(['middle_name']);

mergeHidden($attributes)

mergeHidden 方法隱藏其他屬性，同時保留現有的隱藏屬性：

$users = $users->mergeHidden(['last_login_at']);

only($keys)

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

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

partition

partition 方法回傳一個包含 Illuminate\Database\Eloquent\Collection 集合實例的 Illuminate\Support\Collection 實例：

$partition = $users->partition(fn ($user) => $user->age > 18);

dump($partition::class);    // Illuminate\Support\Collection
dump($partition[0]::class); // Illuminate\Database\Eloquent\Collection
dump($partition[1]::class); // Illuminate\Database\Eloquent\Collection

setAppends($attributes)

setAppends 方法暫時覆寫集合中每個模型上的所有附加屬性：

$users = $users->setAppends(['is_admin']);

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();

withoutAppends()

withoutAppends 方法暫時移除集合中每個模型上的所有附加屬性：

$users = $users->withoutAppends();

自訂集合

如果您想在與給定模型互動時使用自訂的 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
    {
        $collection = new UserCollection($models);

        if (Model::isAutomaticallyEagerLoadingRelationships()) {
            $collection->withRelationshipAutoloading();
        }

        return $collection;
    }
}

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

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