雄辩：集合

• Introduction
• 可用方法
• 自定义集合

#Introduction

所有返回多个模型结果的 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 实例。

append($attributes)

这append 方法可用于指示属性应该是appended 对于集合中的每个模型。此方法接受属性数组或单个属性：

$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);

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 方法 eager 加载集合中所有模型的给定关系：

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

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

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

loadMissing($relations)

这loadMissing 如果尚未加载关系，方法 eager 会加载集合中所有模型的给定关系：

$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 与给定模型交互时的对象，您可以定义一个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 方法，您将在任何时候收到自定义集合的实例，Eloquent 通常会返回一个Illuminate\Database\Eloquent\Collection实例。如果您想为应用程序中的每个模型使用自定义集合，您应该定义newCollection 由所有应用程序模型扩展的基本模型类上的方法。