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

追加包含差异排除查找 findOrFail 最新交集加载加载缺失模型键设为可见设为隐藏仅设为可见设为隐藏转换为查询唯一

`append($attributes)`

append 方法可用于指示应为集合中的每个模型追加属性。此方法接受属性数组或单个属性。

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

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

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

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

`diff($items)`

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

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

`except($keys)`

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

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

`find($key)`

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

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

`findOrFail($key)`

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

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

`fresh($with = [])`

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

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

`intersect($items)`

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

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

`load($relations)`

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

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

`loadMissing($relations)`

loadMissing 方法急切加载集合中所有模型的给定关联（如果关联尚未加载）。

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

`modelKeys()`

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

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

`makeVisible($attributes)`

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

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

`makeHidden($attributes)`

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

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

`only($keys)`

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

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

`setVisible($attributes)`

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

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

`setHidden($attributes)`

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

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

`toQuery()`

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

use App\Models\User;
 
$users = User::where('status', 'VIP')->get();
 
$users->toQuery()->update([
    'status' => 'Administrator',
]);

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

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