集合

引言

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

省略

自定义集合

如果你希望在操作某个模型时使用自定义集合对象，可以在模型上添加 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
{
    /**
     * 创建一个新的 Eloquent 集合实例。
     *
     * @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 方法，并让应用中的所有模型继承该基础模型类。

关系

Mutators Casts