Skip to content

Eloquent: 集合

介绍

所有由 Eloquent 返回的多结果集都是 Illuminate\Database\Eloquent\Collection 对象的实例,包括通过 get 方法检索的结果或通过关系访问的结果。Eloquent 集合对象扩展了 Laravel 的基础集合,因此它自然继承了数十种用于流畅地处理 Eloquent 模型底层数组的方法。

当然,所有集合也可以作为迭代器使用,允许您像简单的 PHP 数组一样遍历它们:

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

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

然而,集合比数组更强大,并且暴露了多种可链式使用的 map / reduce 操作。例如,让我们移除所有非活动模型并收集每个剩余用户的名字:

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

$names = $users->reject(function ($user) {
    return $user->active === false;
})
->map(function ($user) {
    return $user->name;
});
lightbulb

虽然大多数 Eloquent 集合方法返回一个新的 Eloquent 集合实例,但 pluckkeyszipcollapseflattenflip 方法返回一个基础集合实例。同样,如果 map 操作返回的集合不包含任何 Eloquent 模型,它将自动转换为基础集合。

可用方法

基础集合

所有 Eloquent 集合都扩展了基础 Laravel 集合对象;因此,它们继承了基础集合类提供的所有强大方法:

自定义集合

如果您需要使用带有自定义扩展方法的自定义 Collection 对象,可以在模型上重写 newCollection 方法:

php
<?php

namespace App;

use App\CustomCollection;
use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * 创建一个新的 Eloquent 集合实例。
     *
     * @param  array  $models
     * @return \Illuminate\Database\Eloquent\Collection
     */
    public function newCollection(array $models = [])
    {
        return new CustomCollection($models);
    }
}

一旦定义了 newCollection 方法,任何时候 Eloquent 返回该模型的 Collection 实例时,您将收到自定义集合的实例。如果您希望为应用程序中的每个模型使用自定义集合,您应该在所有模型扩展的基础模型类上重写 newCollection 方法。