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 collection 物件；因此，它們繼承了基礎 collection 類別提供的所有強大方法。

此外，Illuminate\Database\Eloquent\Collection 類別提供了更多方法，以協助管理您的 model 集合。大多數方法會回傳 Illuminate\Database\Eloquent\Collection 實例；然而，有些方法，例如 modelKeys，會回傳 Illuminate\Support\Collection 實例。

appendcontainsdiffexceptfindfindOrFailfreshintersectloadloadMissingmodelKeysmakeVisiblemakeHiddenonlypartitionsetVisiblesetHiddentoQueryunique

append($attributes) ​

append 方法可用來指示集合中的每個 model 都應該要 appended 一個屬性。此方法接受一個屬性陣列或單一屬性：

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

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

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

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

php
$users->contains(1);

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

diff($items) ​

diff 方法回傳所有不在給定集合中的 model：

php
use App\Models\User;

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

except($keys) ​

except 方法回傳所有不具備給定主鍵的 model：

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

find($key) ​

find 方法回傳主鍵與給定鍵相符的 model。如果 $key 是 model 實例，find 將嘗試回傳與主鍵相符的 model。如果 $key 是一個鍵的陣列，find 將回傳所有主鍵在給定陣列中的 model：

php
$users = User::all();

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

findOrFail($key) ​

findOrFail 方法回傳主鍵與給定鍵相符的 model，如果集合中找不到相符的 model，則會丟出 Illuminate\Database\Eloquent\ModelNotFoundException 異常：

php
$users = User::all();

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

fresh($with = []) ​

fresh 方法從資料庫中取得集合中每個 model 的全新實例。此外，任何指定的關聯將會被預載入 (eager loaded)：

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

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

intersect($items) ​

intersect 方法回傳所有同時存在於給定集合中的 model：

php
use App\Models\User;

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

load($relations) ​

load 方法為集合中的所有 model 預載入 (eager loads) 給定的關聯：

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

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

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

loadMissing($relations) ​

loadMissing 方法為集合中的所有 model 預載入 (eager loads) 給定的關聯，如果這些關聯尚未載入的話：

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

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

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

modelKeys() ​

modelKeys 方法回傳集合中所有 model 的主鍵：

php
$users->modelKeys();

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

makeVisible($attributes) ​

makeVisible 方法 makes attributes visible 那些通常在集合中每個 model 上被「隱藏」的屬性：

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

makeHidden($attributes) ​

makeHidden 方法 hides attributes 那些通常在集合中每個 model 上被「可見」的屬性：

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

only($keys) ​

only 方法回傳所有具備給定主鍵的 model：

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

partition ​

partition 方法回傳一個 Illuminate\Support\Collection 實例，其中包含 Illuminate\Database\Eloquent\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

setVisible($attributes) ​

setVisible 方法 temporarily overrides 集合中每個 model 上所有可見的屬性：

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

setHidden($attributes) ​

setHidden 方法 temporarily overrides 集合中每個 model 上所有隱藏的屬性：

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

toQuery() ​

toQuery 方法回傳一個 Eloquent 查詢建構器 (query builder) 實例，其中包含對集合 model 主鍵的 whereIn 約束：

php
use App\Models\User;

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

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

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

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

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

自訂集合 ​

如果您想在與指定模型互動時使用自訂的 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 方法。