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;
}

但是，如前所述，集合比数组强大得多，并公开了可以使用直观界面链接的各种 map / reduce 操作。例如，我们可以删除所有不活动的模型，然后收集每个剩余用户的名字

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

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