# Cml\Entity\Collection [集合]

# 简介

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

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

$users = UserEntity::where('active', 1)->select();

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

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

$users = UserEntity::findMany();

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

# 可用方法

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

另外,Cml\Entity\Collection 类提供了一套上层的方法来帮你管理你的模型集合。

# remove

将数据集合删除

# update

更新数据集合

# toArray

将集合转换成数组

# toJson

将集合转换为json