Eloquent:集合

简介

Eloquent 返回的所有多结果集都是 Illuminate\Database\Eloquent\Collection 对象的实例,

默认情况下 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::where('active', 1)->get();

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

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

可用的方法

集合基类

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

[all](/docs/{{version}}/collections#method-all) [average](/docs/{{version}}/collections#method-average) [avg](/docs/{{version}}/collections#method-avg) [chunk](/docs/{{version}}/collections#method-chunk) [collapse](/docs/{{version}}/collections#method-collapse) [combine](/docs/{{version}}/collections#method-combine) [contains](/docs/{{version}}/collections#method-contains) [containsStrict](/docs/{{version}}/collections#method-containsstrict) [count](/docs/{{version}}/collections#method-count) [diff](/docs/{{version}}/collections#method-diff) [diffKeys](/docs/{{version}}/collections#method-diffkeys) [each](/docs/{{version}}/collections#method-each) [every](/docs/{{version}}/collections#method-every) [except](/docs/{{version}}/collections#method-except) [filter](/docs/{{version}}/collections#method-filter) [first](/docs/{{version}}/collections#method-first) [flatMap](/docs/{{version}}/collections#method-flatmap) [flatten](/docs/{{version}}/collections#method-flatten) [flip](/docs/{{version}}/collections#method-flip) [forget](/docs/{{version}}/collections#method-forget) [forPage](/docs/{{version}}/collections#method-forpage) [get](/docs/{{version}}/collections#method-get) [groupBy](/docs/{{version}}/collections#method-groupby) [has](/docs/{{version}}/collections#method-has) [implode](/docs/{{version}}/collections#method-implode) [intersect](/docs/{{version}}/collections#method-intersect) [isEmpty](/docs/{{version}}/collections#method-isempty) [isNotEmpty](/docs/{{version}}/collections#method-isnotempty) [keyBy](/docs/{{version}}/collections#method-keyby) [keys](/docs/{{version}}/collections#method-keys) [last](/docs/{{version}}/collections#method-last) [map](/docs/{{version}}/collections#method-map) [mapWithKeys](/docs/{{version}}/collections#method-mapwithkeys) [max](/docs/{{version}}/collections#method-max) [median](/docs/{{version}}/collections#method-median) [merge](/docs/{{version}}/collections#method-merge) [min](/docs/{{version}}/collections#method-min) [mode](/docs/{{version}}/collections#method-mode) [nth](/docs/{{version}}/collections#method-nth) [only](/docs/{{version}}/collections#method-only) [partition](/docs/{{version}}/collections#method-partition) [pipe](/docs/{{version}}/collections#method-pipe) [pluck](/docs/{{version}}/collections#method-pluck) [pop](/docs/{{version}}/collections#method-pop) [prepend](/docs/{{version}}/collections#method-prepend) [pull](/docs/{{version}}/collections#method-pull) [push](/docs/{{version}}/collections#method-push) [put](/docs/{{version}}/collections#method-put) [random](/docs/{{version}}/collections#method-random) [reduce](/docs/{{version}}/collections#method-reduce) [reject](/docs/{{version}}/collections#method-reject) [reverse](/docs/{{version}}/collections#method-reverse) [search](/docs/{{version}}/collections#method-search) [shift](/docs/{{version}}/collections#method-shift) [shuffle](/docs/{{version}}/collections#method-shuffle) [slice](/docs/{{version}}/collections#method-slice) [sort](/docs/{{version}}/collections#method-sort) [sortBy](/docs/{{version}}/collections#method-sortby) [sortByDesc](/docs/{{version}}/collections#method-sortbydesc) [splice](/docs/{{version}}/collections#method-splice) [split](/docs/{{version}}/collections#method-split) [sum](/docs/{{version}}/collections#method-sum) [take](/docs/{{version}}/collections#method-take) [tap](/docs/{{version}}/collections#method-tap) [toArray](/docs/{{version}}/collections#method-toarray) [toJson](/docs/{{version}}/collections#method-tojson) [transform](/docs/{{version}}/collections#method-transform) [union](/docs/{{version}}/collections#method-union) [unique](/docs/{{version}}/collections#method-unique) [uniqueStrict](/docs/{{version}}/collections#method-uniquestrict) [values](/docs/{{version}}/collections#method-values) [when](/docs/{{version}}/collections#method-when) [where](/docs/{{version}}/collections#method-where) [whereStrict](/docs/{{version}}/collections#method-wherestrict) [whereIn](/docs/{{version}}/collections#method-wherein) [whereInStrict](/docs/{{version}}/collections#method-whereinstrict) [whereNotIn](/docs/{{version}}/collections#method-wherenotin) [whereNotInStrict](/docs/{{version}}/collections#method-wherenotinstrict) [zip](/docs/{{version}}/collections#method-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 方法。

译者署名

用户名 头像 职能 签名
@springjk 翻译 再怎么说我也是我西北一匹狼

{note} 欢迎任何形式的转载,但请务必注明出处,尊重他人劳动共创开源社区。

转载请注明:本文档由 Laravel China 社区 laravel-china.org 组织翻译,详见 翻译召集帖

文档永久地址: https://d.laravel-china.org