Eloquent: 集合

优质

小牛编辑

195浏览

2023-12-01

简介

Eloquent 返回的所有多结果集都是 Illuminate\Database\Eloquent\Collection 对象的实例，包括通过 get 方法检索或通过访问关联关系获取到的结果。 Eloquent 的集合对象继承了 Laravel 的集合基类，因此它自然也继承了数十种能优雅地处理 Eloquent 模型底层数组的方法。

当然，所有的集合都可以作为迭代器，你可以像遍历简单的 PHP 数组一样来遍历它们：

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

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

不过，集合比数组更加强大，它通过更直观的接口暴露出可链式调用的 map/reduce 等操作。例如，让我们移除所有未激活的用户并收集剩余用户的名字：

$users = App\User::all();

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

{note} 大多数 Eloquent 集合方法会返回新的 Eloquent 集合实例，但是 pluck, keys, zip, collapse, flatten 和 flip 方法除外，它们会返回一个集合基类实例。同样，如果 map 操作返回的集合不包含任何 Eloquent 模型，那么它会被自动转换成集合基类。

可用方法

集合基类

所有 Eloquent 都继承了基础的 Laravel 集合对象。因此，它们也继承了所有集合基类提供的强大的方法：

all average avg chunk collapse combine concat contains containsStrict count crossJoin dd diff diffKeys dump each eachSpread every except filter first flatMap flatten flip forget forPage get groupBy has implode intersect isEmpty isNotEmpty keyBy keys last map mapInto mapSpread mapToGroups mapWithKeys max median merge min mode nth only pad partition pipe pluck pop prepend pull push put random reduce reject reverse search shift shuffle slice sort sortBy sortByDesc splice split sum take tap toArray toJson transform union unique uniqueStrict unless values when where whereStrict whereIn whereInStrict whereNotIn whereNotInStrict zip

自定义集合

如果你需要在自己的扩展方法中使用自定义的 Collection 对象，可以在你自己的模型中重写 newCollection 方法：

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