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

appendcontainsdiffexceptfindfindOrFailfreshintersectloadloadMissingmodelKeysmakeVisiblemakeHiddenonlypartitionsetAppendssetVisiblesetHiddentoQueryuniquewithoutAppends

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 方法從資料庫中檢索集合中每個模型的全新實例。此外，任何指定的關聯都會被預先載入：

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

only($keys) ​

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

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

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($attributes) ​

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 方法，並讓應用程式中的所有模型都繼承該基礎模型類別。