Eloquent：集合

简介
可用方法
自定义集合

简介

所有返回多个模型结果的 Eloquent 方法都会返回 Illuminate\Database\Eloquent\Collection 类的实例，包括通过 get 方法检索到的结果或通过关联访问的结果。Eloquent 集合对象继承自 Laravel 的基础集合，因此它自然继承了数十种用于流畅操作底层 Eloquent 模型数组的方法。请务必查看 Laravel 集合文档，以了解所有这些实用方法！

所有集合也充当迭代器，允许您像操作普通的 PHP 数组一样循环遍历它们。

1use App\Models\User;
2 
3$users = User::where('active', 1)->get();
4 
5foreach ($users as $user) {
6    echo $user->name;
7}

use App\Models\User;

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

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

然而，正如之前提到的，集合比数组强大得多，并提供了多种 map / reduce 操作，这些操作可以使用直观的接口进行链式调用。例如，我们可以移除所有不活跃的模型，然后获取每个剩余用户的名字：

1$names = User::all()->reject(function (User $user) {
2    return $user->active === false;
3})->map(function (User $user) {
4    return $user->name;
5});

$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 方法可用于指示应为集合中的每个模型追加某些属性。此方法接受一个属性数组或单个属性。

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

$users->append('team');

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

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

contains 方法可用于确定给定的模型实例是否包含在集合中。此方法接受主键或模型实例。

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

$users->contains(1);

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

`diff($items)`

diff 方法返回所有不存在于给定集合中的模型。

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

use App\Models\User;

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

`except($keys)`

except 方法返回所有不具有给定主键的模型。

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

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

`find($key)`

find 方法返回主键匹配给定键的模型。如果 $key 是一个模型实例，find 将尝试返回匹配该主键的模型。如果 $key 是一个键数组，find 将返回所有主键在给定数组中的模型。

1$users = User::all();
2 
3$user = $users->find(1);

$users = User::all();

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

`findOrFail($key)`

findOrFail 方法返回主键匹配给定键的模型，如果在集合中找不到匹配的模型，则抛出 Illuminate\Database\Eloquent\ModelNotFoundException 异常。

1$users = User::all();
2 
3$user = $users->findOrFail(1);

$users = User::all();

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

`fresh($with = [])`

fresh 方法从数据库中检索集合中每个模型的新实例。此外，任何指定的关联都将被预加载。

1$users = $users->fresh();
2 
3$users = $users->fresh('comments');

$users = $users->fresh();

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

`intersect($items)`

intersect 方法返回所有同样存在于给定集合中的模型。

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

use App\Models\User;

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

`load($relations)`

load 方法为集合中的所有模型预加载给定的关联。

1$users->load(['comments', 'posts']);
2 
3$users->load('comments.author');
4 
5$users->load(['comments', 'posts' => fn ($query) => $query->where('active', 1)]);

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

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

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

`loadMissing($relations)`

loadMissing 方法在关联尚未加载的情况下，为集合中的所有模型预加载给定的关联。

1$users->loadMissing(['comments', 'posts']);
2 
3$users->loadMissing('comments.author');
4 
5$users->loadMissing(['comments', 'posts' => fn ($query) => $query->where('active', 1)]);

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

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

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

`modelKeys()`

modelKeys 方法返回集合中所有模型的主键。

1$users->modelKeys();
2 
3// [1, 2, 3, 4, 5]

$users->modelKeys();

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

`makeVisible($attributes)`

makeVisible 方法使属性可见，这些属性在集合中的每个模型上通常是“隐藏”的。

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

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

`makeHidden($attributes)`

makeHidden 方法隐藏属性，这些属性在集合中的每个模型上通常是“可见”的。

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

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

`mergeVisible($attributes)`

mergeVisible 方法在保留现有可见属性的同时，使额外的属性可见。

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

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

`mergeHidden($attributes)`

mergeHidden 方法在保留现有隐藏属性的同时，隐藏额外的属性。

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

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

`only($keys)`

only 方法返回所有具有给定主键的模型。

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

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

`partition`

partition 方法返回一个 Illuminate\Support\Collection 实例，其中包含 Illuminate\Database\Eloquent\Collection 集合实例。

1$partition = $users->partition(fn ($user) => $user->age > 18);
2 
3dump($partition::class);    // Illuminate\Support\Collection
4dump($partition[0]::class); // Illuminate\Database\Eloquent\Collection
5dump($partition[1]::class); // Illuminate\Database\Eloquent\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 方法临时覆盖集合中每个模型的追加属性。

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

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

`setVisible($attributes)`

setVisible 方法临时覆盖集合中每个模型的所有可见属性。

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

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

`setHidden($attributes)`

setHidden 方法临时覆盖集合中每个模型的所有隐藏属性。

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

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

`toQuery()`

toQuery 方法返回一个 Eloquent 查询构建器实例，该实例包含对集合模型主键的 whereIn 约束。

1use App\Models\User;
2 
3$users = User::where('status', 'VIP')->get();
4 
5$users->toQuery()->update([
6    'status' => 'Administrator',
7]);

use App\Models\User;

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

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

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

unique 方法返回集合中所有唯一的模型。任何与集合中其他模型具有相同主键的模型都会被移除。

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

$users = $users->unique();

`withoutAppends()`

withoutAppends 方法临时移除集合中每个模型的所有追加属性。

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

$users = $users->withoutAppends();

自定义集合

如果您希望在与给定模型交互时使用自定义 Collection 对象，可以将 CollectedBy 属性添加到您的模型中。

 1<?php
 2 
 3namespace App\Models;
 4 
 5use App\Support\UserCollection;
 6use Illuminate\Database\Eloquent\Attributes\CollectedBy;
 7use Illuminate\Database\Eloquent\Model;
 8 
 9#[CollectedBy(UserCollection::class)]
10class User extends Model
11{
12    // ...
13}

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

 1<?php
 2 
 3namespace App\Models;
 4 
 5use App\Support\UserCollection;
 6use Illuminate\Database\Eloquent\Collection;
 7use Illuminate\Database\Eloquent\Model;
 8 
 9class User extends Model
10{
11    /**
12     * Create a new Eloquent Collection instance.
13     *
14     * @param  array<int, \Illuminate\Database\Eloquent\Model>  $models
15     * @return \Illuminate\Database\Eloquent\Collection<int, \Illuminate\Database\Eloquent\Model>
16     */
17    public function newCollection(array $models = []): Collection
18    {
19        $collection = new UserCollection($models);
20 
21        if (Model::isAutomaticallyEagerLoadingRelationships()) {
22            $collection->withRelationshipAutoloading();
23        }
24 
25        return $collection;
26    }
27}

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