Eloquent 集合

未匹配的标注

Eloquent: 集合

简介

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

而且,所有的集合都可以作为迭代器,你可以像遍历简单的 PHP 数组一样来遍历它们:

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

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

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

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

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

注意:大多数 Eloquent 集合方法会返回新的 Eloquent 集合实例,但是 pluck, keys, zipcollapseflattenflip 方法除外,它们会返回一个 Base Collection 实例。同样,如果 map 操作返回的集合不包括任何 Eloquent 模型,那么它会被自动转换成集合基类。

可用的方法

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

另外,Illuminate\Database\Eloquent\Collection 类提供了一套上层的方法来帮你管理你的模型集合。大多数方法返回 Illuminate\Database\Eloquent\Collection 实例; 然而,也会有一些方法返回基于 Illuminate\Support\Collection 类的实例。

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 将会使用 whereIn() 返回所有匹配 $keys 的模型:

$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 方法会提前加载集合中所有模型的指定关系:

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

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

loadMissing($relations)

如果尚未加载关系,loadMissing 方法将会为集合中的所有模型加载给定的关系:

$users->loadMissing('comments', 'posts');

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

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

toQuery()

toQuery 方法返回一个 Eloquent 查询构建器实例,该实例在集合模型的主键上包含一个 whereIn 约束:

$users = App\Models\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\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 方法, 你将随时可以从你的自定义集合中接收一个 Collection 返回的一个模型实例.。如果要为应用程序的每个模型使用自定义集合,就应该重写所有模型扩展的基类模型中 newCollection 方法。

本文章首发在 LearnKu.com 网站上。

本译文仅用于学习和交流目的,转载请务必注明文章译者、出处、和本文链接
我们的翻译工作遵照 CC 协议,如果我们的工作有侵犯到您的权益,请及时联系我们。
上一篇 下一篇
Summer
《L02 从零构建论坛系统》
以构建论坛项目 LaraBBS 为线索,展开对 Laravel 框架的全面学习。应用程序架构思路贴近 Laravel 框架的设计哲学。
《L04 微信小程序从零到发布》
从小程序个人账户申请开始,带你一步步进行开发一个微信小程序,直到提交微信控制台上线发布。
贡献者:5
讨论数量: 0
发起讨论 只看当前版本


暂无话题~