Laradoc

Appearance

Eloquent: 集合 ​

簡介 ​

所有回傳多個模型結果的 Eloquent 方法都會回傳 Illuminate\Database\Eloquent\Collection 類別的實例，包含透過 get 方法取得或透過關聯存取的結果。Eloquent 集合物件擴充自 Laravel 的 基礎集合，因此它自然地繼承了數十種用於流暢處理底層 Eloquent 模型陣列的方法。請務必查閱 Laravel 集合文件以瞭解所有這些好用的方法！

所有集合也同時扮演疊代器的角色，讓你像處理簡單的 PHP 陣列一樣對其進行迴圈：

php
use App\Models\User;

$users = User::where('active', 1)->get();

foreach ($users as $user) {
    echo $user->name;
}

然而，如前所述，集合比陣列強大得多，並提供了多種 map / reduce 操作，可以透過直觀的介面進行鏈式呼叫。例如，我們可以移除所有不活躍的模型，然後收集每個剩餘使用者的名字：

php
$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 實例。

appendcontainsdiffexceptfindfindOrFailfreshintersectloadloadMissingmodelKeysmakeVisiblemakeHiddenmergeVisiblemergeHiddenonlypartitionsetAppendssetVisiblesetHiddentoQueryuniquewithoutAppends

append($attributes) ​

append 方法可用於指示集合中的每個模型都應該 追加 一個屬性。此方法接受屬性陣列或單個屬性：

php
$users->append('team');

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

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

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

php
$users->contains(1);

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

diff($items) ​

diff 方法會回傳所有不存在於指定集合中的模型：

php
use App\Models\User;

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

except($keys) ​

except 方法會回傳所有不具備指定主鍵的模型：

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

find($key) ​

find 方法會回傳主鍵與指定鍵相符的模型。如果 $key 是一個模型實例，find 將嘗試回傳一個與該主鍵相符的模型。如果 $key 是一個鍵的陣列，find 將回傳該陣列中包含的所有主鍵對應的模型：

php
$users = User::all();

$user = $users->find(1);

findOrFail($key) ​

findOrFail 方法會回傳主鍵與指定鍵相符的模型，如果集合中找不到相符的模型，則會拋出 Illuminate\Database\Eloquent\ModelNotFoundException 例外：

php
$users = User::all();

$user = $users->findOrFail(1);

fresh($with = []) ​

fresh 方法從資料庫中為集合中的每個模型檢索一個全新的實例。此外，任何指定的關聯都將被預載 (Eager Loaded)：

php
$users = $users->fresh();

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

intersect($items) ​

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

php
use App\Models\User;

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

load($relations) ​

load 方法為集合中的所有模型預載指定的關聯：

php
$users->load(['comments', 'posts']);

$users->load('comments.author');

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

loadMissing($relations) ​

loadMissing 方法如果關聯尚未載入，則為集合中的所有模型預載指定的關聯：

php
$users->loadMissing(['comments', 'posts']);

$users->loadMissing('comments.author');

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

modelKeys() ​

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

php
$users->modelKeys();

// [1, 2, 3, 4, 5]

makeVisible($attributes) ​

makeVisible 方法讓集合中每個模型通常被「隱藏」的屬性變為 可見：

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

makeHidden($attributes) ​

makeHidden 方法讓集合中每個模型通常「可見」的屬性變為 隱藏：

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

mergeVisible($attributes) ​

mergeVisible 方法在保留現有可見屬性的同時，讓額外的屬性變為 可見：

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

mergeHidden($attributes) ​

mergeHidden 方法在保留現有隱藏屬性的同時，隱藏 額外的屬性：

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

only($keys) ​

only 方法會回傳所有具備指定主鍵的模型：

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

partition ​

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

php
$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 方法暫時覆蓋集合中每個模型的所有 追加屬性：

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

setVisible($attributes) ​

setVisible 方法 暫時覆蓋 集合中每個模型的所有可見屬性：

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

setHidden($attributes) ​

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

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

toQuery() ​

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

php
use App\Models\User;

$users = User::where('status', 'VIP')->get();

$users->toQuery()->update([
    'status' => 'Administrator',
]);

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

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

php
$users = $users->unique();

withoutAppends() ​

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

php
$users = $users->withoutAppends();

自定義集合 ​

若您想在與特定模型互動時使用自定義的 Collection 物件，您可以在模型中加入 CollectedBy 屬性：

php
<?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
<?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 方法。