Laravel 11.x 中文文档

简体中文

English

简体中文

English

主题

Eloquent: 集合 ​

介绍 ​

所有返回多个模型结果的 Eloquent 方法将返回 Illuminate\Database\Eloquent\Collection 类的实例，包括通过 get 方法检索的结果或通过关系访问的结果。Eloquent 集合对象扩展了 Laravel 的 基础集合，因此它自然继承了用于流畅处理 Eloquent 模型底层数组的数十种方法。请务必查看 Laravel 集合文档，以了解所有这些有用的方法！

所有集合还充当迭代器，允许您像处理简单的 PHP 数组一样循环遍历它们：

php
use App\Models\User;

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

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

然而，如前所述，集合比数组强大得多，并且暴露了多种可以使用直观接口链接的映射/减少操作。例如，我们可以删除所有非活动模型，然后收集每个剩余用户的名字：

php
$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 实例。

appendcontainsdiffexceptfindfindOrFailfreshintersectloadloadMissingmodelKeysmakeVisiblemakeHiddenonlysetVisiblesetHiddentoQueryunique

append($attributes) ​

append 方法可用于指示每个模型在集合中应 附加 的属性。此方法接受一个属性数组或单个属性：

php
$users->append('team');

$users->append(['team', 'is_admin']);

contains($key, $operator = null, $value = null) ​

contains 方法可用于确定给定模型实例是否包含在集合中。此方法接受主键或模型实例：

php
$users->contains(1);

$users->contains(User::find(1));

diff($items) ​

diff 方法返回不在给定集合中的所有模型：

php
use App\Models\User;

$users = $users->diff(User::whereIn('id', [1, 2, 3])->get());

except($keys) ​

except 方法返回所有没有给定主键的模型：

php
$users = $users->except([1, 2, 3]);

find($key) ​

find 方法返回主键与给定键匹配的模型。如果 $key 是模型实例，find 将尝试返回与主键匹配的模型。如果 $key 是键的数组，find 将返回所有主键在给定数组中的模型：

php
$users = User::all();

$user = $users->find(1);

findOrFail($key) ​

findOrFail 方法返回主键与给定键匹配的模型，如果在集合中找不到匹配的模型，则抛出 Illuminate\Database\Eloquent\ModelNotFoundException 异常：

php
$users = User::all();

$user = $users->findOrFail(1);

fresh($with = []) ​

fresh 方法从数据库中检索集合中每个模型的最新实例。此外，任何指定的关系将被急切加载：

php
$users = $users->fresh();

$users = $users->fresh('comments');

intersect($items) ​

intersect 方法返回在给定集合中也存在的所有模型：

php
use App\Models\User;

$users = $users->intersect(User::whereIn('id', [1, 2, 3])->get());

load($relations) ​

load 方法为集合中所有模型急切加载给定的关系：

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

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

$users->load(['comments', 'posts' => fn ($query) => $query->where('active', 1)]);

loadMissing($relations) ​

loadMissing 方法为集合中所有模型急切加载给定的关系，如果这些关系尚未加载：

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

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

$users->loadMissing(['comments', 'posts' => fn ($query) => $query->where('active', 1)]);

modelKeys() ​

modelKeys 方法返回集合中所有模型的主键：

php
$users->modelKeys();

// [1, 2, 3, 4, 5]

makeVisible($attributes) ​

makeVisible 方法 使属性可见，这些属性通常在集合中每个模型上是“隐藏”的：

php
$users = $users->makeVisible(['address', 'phone_number']);

makeHidden($attributes) ​

makeHidden 方法 隐藏属性，这些属性通常在集合中每个模型上是“可见”的：

php
$users = $users->makeHidden(['address', 'phone_number']);

only($keys) ​

only 方法返回所有具有给定主键的模型：

php
$users = $users->only([1, 2, 3]);

setVisible($attributes) ​

setVisible 方法 临时覆盖 集合中每个模型的所有可见属性：

php
$users = $users->setVisible(['id', 'name']);

setHidden($attributes) ​

setHidden 方法 临时覆盖 集合中每个模型的所有隐藏属性：

php
$users = $users->setHidden(['email', 'password', 'remember_token']);

toQuery() ​

toQuery 方法返回一个 Eloquent 查询构建器实例，其中包含对集合模型主键的 whereIn 约束：

php
use App\Models\User;

$users = User::where('status', 'VIP')->get();

$users->toQuery()->update([
    'status' => 'Administrator',
]);

unique($key = null, $strict = false) ​

unique 方法返回集合中所有唯一的模型。任何与集合中另一个模型具有相同主键的模型都会被移除：

php
$users = $users->unique();

自定义集合 ​

如果您希望在与给定模型交互时使用自定义 Collection 对象，可以将 CollectedBy 属性添加到您的模型中：

php
<?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
<?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
    {
        return new UserCollection($models);
    }
}

一旦您定义了 newCollection 方法或将 CollectedBy 属性添加到模型中，您将在 Eloquent 通常返回 Illuminate\Database\Eloquent\Collection 实例的任何地方收到自定义集合的实例。

如果您希望在应用程序中的每个模型上使用自定义集合，您应该在所有应用程序模型扩展的基模型类上定义 newCollection 方法。

版权所有 © 2024-2025 laravel.wiki