Eloquent: 集合
介绍
所有由 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;
});
虽然大多数 Eloquent 集合方法返回一个新的 Eloquent 集合实例,但 pluck
、keys
、zip
、collapse
、flatten
和 flip
方法返回一个基础集合实例。同样,如果 map
操作返回的集合不包含任何 Eloquent 模型,它将自动转换为基础集合。
可用方法
所有 Eloquent 集合都扩展了基础 Laravel 集合对象;因此,它们继承了基础集合类提供的所有强大方法。
此外,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\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\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\User::where('status', 'VIP')->get();
$users->toQuery()->update([
'status' => 'Administrator',
]);
unique($key = null, $strict = false)
unique
方法返回集合中所有唯一的模型。集合中与另一个模型具有相同主键的同类型模型将被移除。
$users = $users->unique();
自定义集合
如果您需要使用带有自己扩展方法的自定义 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
方法。