Skip to content

Latest commit

 

History

History
333 lines (231 loc) · 9.61 KB

eloquent-collections.md

File metadata and controls

333 lines (231 loc) · 9.61 KB

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

<style>
    .collection-method-list > p {
        columns: 14.4em 1; -moz-columns: 14.4em 1; -webkit-columns: 14.4em 1;
    }

    .collection-method-list a {
        display: block;
        overflow: hidden;
        text-overflow: ellipsis;
        white-space: nowrap;
    }

    .collection-method code {
        font-size: 14px;
    }

    .collection-method:not(.first-collection-method) {
        margin-top: 50px;
    }
</style>

<div class="collection-method-list" markdown="1">

[append](#method-append)
[contains](#method-contains)
[diff](#method-diff)
[except](#method-except)
[find](#method-find)
[findOrFail](#method-find-or-fail)
[fresh](#method-fresh)
[intersect](#method-intersect)
[load](#method-load)
[loadMissing](#method-loadMissing)
[modelKeys](#method-modelKeys)
[makeVisible](#method-makeVisible)
[makeHidden](#method-makeHidden)
[only](#method-only)
[setVisible](#method-setVisible)
[setHidden](#method-setHidden)
[toQuery](#method-toquery)
[unique](#method-unique)

</div>

<a name="method-append"></a>
#### `append($attributes)` {.collection-method .first-collection-method}

`append` 方法可用於指示應為集合中的每個模型附加的屬性。此方法接受一個屬性數組或單個屬性：

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

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

contains($key, $operator = null, $value = null) {.collection-method}

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

$users->contains(1);

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

diff($items) {.collection-method}

diff 方法返回不在給定集合中的所有模型：

use App\Models\User;

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

except($keys) {.collection-method}


`except` 方法返回所有不具有給定主鍵的模型：

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

find($key) {.collection-method}

find 方法返回具有與給定鍵匹配的主鍵的模型。如果 $key 是模型實例，find 將嘗試返回與主鍵匹配的模型。如果 $key 是一組鍵，find 將返回具有給定陣列中主鍵的所有模型：

$users = User::all();

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

findOrFail($key) {.collection-method}

findOrFail 方法返回具有與給定鍵匹配的主鍵的模型，如果集合中找不到匹配的模型，則拋出 Illuminate\Database\Eloquent\ModelNotFoundException 例外：

$users = User::all();

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

fresh($with = []) {.collection-method}

fresh 方法從資料庫中檢索集合中每個模型的新實例。此外，將急切載入任何指定的關聯：

$users = $users->fresh();

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

intersect($items) {.collection-method}

intersect 方法返回在給定集合中也存在的所有模型：

use App\Models\User;

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

load($relations) {.collection-method}

load 方法為集合中的所有模型急切載入給定的關聯：

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

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

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

loadMissing($relations) {.collection-method}

loadMissing 方法為集合中的所有模型急切載入給定的關聯，如果關聯尚未載入：

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

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

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

modelKeys() {.collection-method}

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

$users->modelKeys();

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

makeVisible($attributes) {.collection-method}

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

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

makeHidden($attributes) {.collection-method}

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

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

only($keys) {.collection-method}

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

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

setVisible($attributes) {.collection-method}

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

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

setHidden($attributes) {.collection-method}

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

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

toQuery() {.collection-method}

toQuery 方法會返回包含對集合模型主鍵的 whereIn 約束的 Eloquent 查詢生成器實例：

use App\Models\User;

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

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

unique($key = null, $strict = false) {.collection-method}

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 方法，該基本模型類別由應用程序的所有模型擴展。