集合

简介

Illuminate\Support\Collection 类提供一个流畅、便利的封装来操控数组数据。如下面的示例代码，我们用 collect 函数从数组中创建新的集合实例，对每一个元素运行 strtoupper 函数，然后移除所有的空元素：

  1. $collection = collect(['taylor', 'abigail', null])->map(function ($name) {
  2.     return strtoupper($name);
  3. })
  4. ->reject(function ($name) {
  5.     return empty($name);
  6. });

如你所见，Collection 类支持链式调用，一般来说，每一个 Collection 方法会返回一个全新的 Collection 实例，你可以放心地进行链接调用。

创建集合

如上所述，collect 辅助函数会利用传入的数组生成一个新的 Illuminate\Support\Collection 实例。所以要创建一个集合就这么简单：

  1. $collection = collect([1, 2, 3]);

默认 Eloquent 模型的集合总是以 Collection 实例返回；然而，你可以随意的在你应用程序中使用 Collection 类。

可用的方法

在这份文档剩余的部份，我们将会探讨 Collection 类的所有方法。要记得的是，所有方法都支持链式调用，几乎所有的方法都会返回新的 Collection 实例，让你保留原版的集合以备不时之需。

你可以从这张数据库表中选择任一方法看使用例子：

方法清单

all() {#collection-method .first-collection-method}

返回该集合所代表的底层 数组：

  1. collect([1, 2, 3])->all();
  3. // [1, 2, 3]

avg() {#collection-method}

返回集合中所有项目的平均值：

  1. collect([1, 2, 3, 4, 5])->avg();
  3. // 3

如果集合包含了嵌套数组或对象，你可以通过传递「键」来指定使用哪些值计算平均值：

  1. $collection = collect([
  2.     ['name' => 'JavaScript: The Good Parts', 'pages' => 176],
  3.     ['name' => 'JavaScript: The Definitive Guide', 'pages' => 1096],
  4. ]);
  6. $collection->avg('pages');
  8. // 636

chunk() {#collection-method}

将集合拆成多个指定大小的较小集合：

  1. $collection = collect([1, 2, 3, 4, 5, 6, 7]);
  3. $chunks = $collection->chunk(4);
  5. $chunks->toArray();
  7. // [[1, 2, 3, 4], [5, 6, 7]]

这个方法在适用于网格系统如 Bootstrap 的 视图 。想像你有一个 Eloquent 模型的集合要显示在一个网格内：

  1. @foreach ($products->chunk(3) as $chunk)
  2.     <div class="row">
  3.         @foreach ($chunk as $product)
  4.             <div class="col-xs-4">{{ $product->name }}</div>
  5.         @endforeach
  6.     </div>
  7. @endforeach

collapse() {#collection-method}

将多个数组组成的集合合成单个数组集合：

  1. $collection = collect([[1, 2, 3], [4, 5, 6], [7, 8, 9]]);
  3. $collapsed = $collection->collapse();
  5. $collapsed->all();
  7. // [1, 2, 3, 4, 5, 6, 7, 8, 9]

combine() {#collection-method}

将集合的值作为「键」，合并另一个数组或者集合作为「键」对应的值。

  1. $collection = collect(['name', 'age']);
  3. $combined = $collection->combine(['George', 29]);
  5. $combined->all();
  7. // ['name' => 'George', 'age' => 29]

contains() {#collection-method}

判断集合是否含有指定项目：

  1. $collection = collect(['name' => 'Desk', 'price' => 100]);
  3. $collection->contains('Desk');
  5. // true
  7. $collection->contains('New York');
  9. // false

你可以将一对键/值传入 contains 方法，用来判断该组合是否存在于集合内：

  1. $collection = collect([
  2.     ['product' => 'Desk', 'price' => 200],
  3.     ['product' => 'Chair', 'price' => 100],
  4. ]);
  6. $collection->contains('product', 'Bookcase');
  8. // false

最后，你也可以传入一个回调函数到 contains 方法内运行你自己的判断语句：

  1. $collection = collect([1, 2, 3, 4, 5]);
  3. $collection->contains(function ($key, $value) {
  4.     return $value > 5;
  5. });
  7. // false

count() {#collection-method}

返回该集合内的项目总数：

  1. $collection = collect([1, 2, 3, 4]);
  3. $collection->count();
  5. // 4

diff() {#collection-method}

将集合与其它集合或纯 PHP 数组 进行比较：

  1. $collection = collect([1, 2, 3, 4, 5]);
  3. $diff = $collection->diff([2, 4, 6, 8]);
  5. $diff->all();
  7. // [1, 3, 5]

diffKeys() {#collection-method}

将集合与其它集合或纯 PHP 数组 的「键」进行比较，返回「键」不一致的集合：

  1. $collection = collect([
  2.     'one' => 10,
  3.     'two' => 20,
  4.     'three' => 30,
  5.     'four' => 40,
  6.     'five' => 50,
  7. ]);
  9. $diff = $collection->diffKeys([
  10.     'two' => 2,
  11.     'four' => 4,
  12.     'six' => 6,
  13.     'eight' => 8,
  14. ]);
  16. $diff->all();
  18. // ['one' => 10, 'three' => 30, 'five' => 50]

each() {#collection-method}

遍历集合中的项目，并将之传入回调函数：

  1. $collection = $collection->each(function ($item, $key) {
  2.     //
  3. });

回调函数返回 false 以中断循环：

  1. $collection = $collection->each(function ($item, $key) {
  2.     if (/* some condition */) {
  3.         return false;
  4.     }
  5. });

every() {#collection-method}

创建一个包含每 第 n 个 元素的新集合：

  1. $collection = collect(['a', 'b', 'c', 'd', 'e', 'f']);
  3. $collection->every(4);
  5. // ['a', 'e']

你可以选择性的传递偏移值作为第二个参数：

  1. $collection->every(4, 1);
  3. // ['b', 'f']

except() {#collection-method}

返回集合中除了指定键的所有项目：

  1. $collection = collect(['product_id' => 1, 'name' => 'Desk', 'price' => 100, 'discount' => false]);
  3. $filtered = $collection->except(['price', 'discount']);
  5. $filtered->all();
  7. // ['product_id' => 1, 'name' => 'Desk']

与 except 相反的方法请查看 only。

filter() {#collection-method}

使用回调函数筛选集合，只留下那些通过判断测试的项目：

  1. $collection = collect([1, 2, 3, 4]);
  3. $filtered = $collection->filter(function ($item) {
  4.     return $item > 2;
  5. });
  7. $filtered->all();
  9. // [3, 4]

与 filter 相反的方法可以查看 reject。

first() {#collection-method}

返回集合第一个通过指定测试的元素：

  1. collect([1, 2, 3, 4])->first(function ($key, $value) {
  2.     return $value > 2;
  3. });
  5. // 3

你也可以不传入参数使用 first 方法以获取集合中第一个元素。如果集合是空的，则会返回 null：

  1. collect([1, 2, 3, 4])->first();
  3. // 1

flatMap() {#collection-method}

对集合内所有子集遍历执行回调，并在最后转为一维集合：

  1. $collection = collect([
  2.     ['name' => 'Sally'],
  3.     ['school' => 'Arkansas'],
  4.     ['age' => 28]
  5. ]);
  7. $flattened = $collection->flatMap(function ($values) {
  8.     return array_map('strtoupper', $values);
  9. });
  11. $flattened->all();
  13. // ['name' => 'SALLY', 'school' => 'ARKANSAS', 'age' => '28'];

flatten() {#collection-method}

将多维集合转为一维集合：

  1. $collection = collect(['name' => 'taylor', 'languages' => ['php', 'javascript']]);
  3. $flattened = $collection->flatten();
  5. $flattened->all();
  7. // ['taylor', 'php', 'javascript'];

flip() {#collection-method}

将集合中的键和对应的数值进行互换：

  1. $collection = collect(['name' => 'taylor', 'framework' => 'laravel']);
  3. $flipped = $collection->flip();
  5. $flipped->all();
  7. // ['taylor' => 'name', 'laravel' => 'framework']

forget() {#collection-method}

通过集合的键来移除掉集合中的一个项目：

  1. $collection = collect(['name' => 'taylor', 'framework' => 'laravel']);
  3. $collection->forget('name');
  5. $collection->all();
  7. // [framework' => 'laravel']

注意：与大多数其它集合的方法不同，forget 不会返回修改过后的新集合；它会直接修改调用它的集合。

forPage() {#collection-method}

返回可用来在指定页码显示项目的新集合：

  1. $collection = collect([1, 2, 3, 4, 5, 6, 7, 8, 9]);
  3. $chunk = $collection->forPage(2, 3);
  5. $chunk->all();
  7. // [4, 5, 6]

这个方法需要「页码」和「每页显示数量」。

get() {#collection-method}

返回指定键的项目。如果该键不存在，则返回 null：

  1. $collection = collect(['name' => 'taylor', 'framework' => 'laravel']);
  3. $value = $collection->get('name');
  5. // taylor

你可以选择性地传入一个默认值作为第二个参数：

  1. $collection = collect(['name' => 'taylor', 'framework' => 'laravel']);
  3. $value = $collection->get('foo', 'default-value');
  5. // default-value

你甚至可以传入回调函数当默认值。如果指定的键不存在，就会返回回调函数的运行结果：

  1. $collection->get('email', function () {
  2.     return 'default-value';
  3. });
  5. // default-value

groupBy() {#collection-method}

根据指定的「键」为集合内的项目分组：

  1. $collection = collect([
  2.     ['account_id' => 'account-x10', 'product' => 'Chair'],
  3.     ['account_id' => 'account-x10', 'product' => 'Bookcase'],
  4.     ['account_id' => 'account-x11', 'product' => 'Desk'],
  5. ]);
  7. $grouped = $collection->groupBy('account_id');
  9. $grouped->toArray();
  11. /*
  12.     [
  13.         'account-x10' => [
  14.             ['account_id' => 'account-x10', 'product' => 'Chair'],
  15.             ['account_id' => 'account-x10', 'product' => 'Bookcase'],
  16.         ],
  17.         'account-x11' => [
  18.             ['account_id' => 'account-x11', 'product' => 'Desk'],
  19.         ],
  20.     ]
  21. */

除了传入字符串的「键」之外，你也可以传入回调函数。该函数应该返回你希望用来分组的键的值。

  1. $grouped = $collection->groupBy(function ($item, $key) {
  2.     return substr($item['account_id'], -3);
  3. });
  5. $grouped->toArray();
  7. /*
  8.     [
  9.         'x10' => [
  10.             ['account_id' => 'account-x10', 'product' => 'Chair'],
  11.             ['account_id' => 'account-x10', 'product' => 'Bookcase'],
  12.         ],
  13.         'x11' => [
  14.             ['account_id' => 'account-x11', 'product' => 'Desk'],
  15.         ],
  16.     ]
  17. */

has() {#collection-method}

检查集合中是否含有指定的「键」：

  1. $collection = collect(['account_id' => 1, 'product' => 'Desk']);
  3. $collection->has('email');
  5. // false

implode() {#collection-method}

implode 方法合并集合中的项目。它的参数依集合中的项目类型而定。

假如集合含有数组或对象，你应该传入你希望连接的属性的「键」，以及你希望放在数值之间的拼接字符串：

  1. $collection = collect([
  2.     ['account_id' => 1, 'product' => 'Desk'],
  3.     ['account_id' => 2, 'product' => 'Chair'],
  4. ]);
  6. $collection->implode('product', ', ');
  8. // Desk, Chair

假如集合只含有简单的字符串或数字，则只需要传入拼接的字符串作为该方法的唯一参数即可：

  1. collect([1, 2, 3, 4, 5])->implode('-');
  3. // '1-2-3-4-5'

intersect() {#collection-method}

移除任何指定 数组 或集合内所没有的数值：

  1. $collection = collect(['Desk', 'Sofa', 'Chair']);
  3. $intersect = $collection->intersect(['Desk', 'Chair', 'Bookcase']);
  5. $intersect->all();
  7. // [0 => 'Desk', 2 => 'Chair']

相当于去「交集」。

isEmpty() {#collection-method}

如果集合是空的，isEmpty 方法会返回 true：否则返回 false：

  1. collect([])->isEmpty();
  3. // true

keyBy() {#collection-method}

以指定键的值作为集合项目的键：

  1. $collection = collect([
  2.     ['product_id' => 'prod-100', 'name' => 'desk'],
  3.     ['product_id' => 'prod-200', 'name' => 'chair'],
  4. ]);
  6. $keyed = $collection->keyBy('product_id');
  8. $keyed->all();
  10. /*
  11.     [
  12.         'prod-100' => ['product_id' => 'prod-100', 'name' => 'Desk'],
  13.         'prod-200' => ['product_id' => 'prod-200', 'name' => 'Chair'],
  14.     ]
  15. */

如果多个项目有同样的键，只有最后一个会出现在新的集合内。

你也可以传入自己的回调函数，该函数应该返回集合的键的值：

  1. $keyed = $collection->keyBy(function ($item) {
  2.     return strtoupper($item['product_id']);
  3. });
  5. $keyed->all();
  7. /*
  8.     [
  9.         'PROD-100' => ['product_id' => 'prod-100', 'name' => 'Desk'],
  10.         'PROD-200' => ['product_id' => 'prod-200', 'name' => 'Chair'],
  11.     ]
  12. */

keys() {#collection-method}

返回该集合所有的键：

  1. $collection = collect([
  2.     'prod-100' => ['product_id' => 'prod-100', 'name' => 'Desk'],
  3.     'prod-200' => ['product_id' => 'prod-200', 'name' => 'Chair'],
  4. ]);
  6. $keys = $collection->keys();
  8. $keys->all();
  10. // ['prod-100', 'prod-200']

last() {#collection-method}

返回集合中，最后一个通过指定测试的元素：

  1. collect([1, 2, 3, 4])->last(function ($key, $value) {
  2.     return $value < 3;
  3. });
  5. // 2

你也可以不传入参数使用 last 方法以获取集合中最后一个元素。如果集合是空的，则会返回 null：

  1. collect([1, 2, 3, 4])->last();
  3. // 4

map() {#collection-method}

遍历整个集合并将每一个数值传入回调函数。回调函数可以任意修改并返回项目，形成修改过的项目组成的新集合：

  1. $collection = collect([1, 2, 3, 4, 5]);
  3. $multiplied = $collection->map(function ($item, $key) {
  4.     return $item * 2;
  5. });
  7. $multiplied->all();
  9. // [2, 4, 6, 8, 10]

注意：正如集合大多数其它的方法一样，map 返回一个新集合实例；它并没有修改被调用的集合。假如你想改变原始的集合，得使用 transform 方法。

max() {#collection-method}

计算指定键的最大值：

  1. $max = collect([['foo' => 10], ['foo' => 20]])->max('foo');
  3. // 20
  5. $max = collect([1, 2, 3, 4, 5])->max();
  7. // 5

merge() {#collection-method}

合并数组进集合。数组「键」对应的数值会覆盖集合「键」对应的数值：

  1. $collection = collect(['product_id' => 1, 'name' => 'Desk']);
  3. $merged = $collection->merge(['price' => 100, 'discount' => false]);
  5. $merged->all();
  7. // ['product_id' => 1, 'name' => 'Desk', 'price' => 100, 'discount' => false]

如果指定数组的「键」为数字，则「值」将会合并到集合的后面：

  1. $collection = collect(['Desk', 'Chair']);
  3. $merged = $collection->merge(['Bookcase', 'Door']);
  5. $merged->all();
  7. // ['Desk', 'Chair', 'Bookcase', 'Door']

min() {#collection-method}

计算指定「键」的最小值：

  1. $min = collect([['foo' => 10], ['foo' => 20]])->min('foo');
  3. // 10
  5. $min = collect([1, 2, 3, 4, 5])->min();
  7. // 1

only() {#collection-method}

返回集合中指定键的所有项目：

  1. $collection = collect(['product_id' => 1, 'name' => 'Desk', 'price' => 100, 'discount' => false]);
  3. $filtered = $collection->only(['product_id', 'name']);
  5. $filtered->all();
  7. // ['product_id' => 1, 'name' => 'Desk']

与 only 相反的方法请查看 except。

pluck() {#collection-method}

获取所有集合中指定「键」对应的值：

  1. $collection = collect([
  2.     ['product_id' => 'prod-100', 'name' => 'Desk'],
  3.     ['product_id' => 'prod-200', 'name' => 'Chair'],
  4. ]);
  6. $plucked = $collection->pluck('name');
  8. $plucked->all();
  10. // ['Desk', 'Chair']

你也可以指定要怎么给最后出来的集合分配键：

  1. $plucked = $collection->pluck('name', 'product_id');
  3. $plucked->all();
  5. // ['prod-100' => 'Desk', 'prod-200' => 'Chair']

pop() {#collection-method}

移除并返回集合最后一个项目：

  1. $collection = collect([1, 2, 3, 4, 5]);
  3. $collection->pop();
  5. // 5
  7. $collection->all();
  9. // [1, 2, 3, 4]

prepend() {#collection-method}

在集合前面增加一个项目：

  1. $collection = collect([1, 2, 3, 4, 5]);
  3. $collection->prepend(0);
  5. $collection->all();
  7. // [0, 1, 2, 3, 4, 5]

你可以传递选择性的第二个参数来设置前置项目的键：

  1. $collection = collect(['one' => 1, 'two', => 2]);
  3. $collection->prepend(0, 'zero');
  5. $collection->all();
  7. // ['zero' => 0, 'one' => 1, 'two', => 2]

pull() {#collection-method}

把「键」对应的值从集合中移除并返回：

  1. $collection = collect(['product_id' => 'prod-100', 'name' => 'Desk']);
  3. $collection->pull('name');
  5. // 'Desk'
  7. $collection->all();
  9. // ['product_id' => 'prod-100']

push() {#collection-method}

在集合的后面新添加一个元素：

  1. $collection = collect([1, 2, 3, 4]);
  3. $collection->push(5);
  5. $collection->all();
  7. // [1, 2, 3, 4, 5]

put() {#collection-method}

在集合内设置一个「键/值」：

  1. $collection = collect(['product_id' => 1, 'name' => 'Desk']);
  3. $collection->put('price', 100);
  5. $collection->all();
  7. // ['product_id' => 1, 'name' => 'Desk', 'price' => 100]

random() {#collection-method}

random 方法从集合中随机返回一个项目：

  1. $collection = collect([1, 2, 3, 4, 5]);
  3. $collection->random();
  5. // 4 - (随机返回)

你可以选择性地传入一个整数到 random。如果该整数大于 1，则会返回一个集合：

  1. $random = $collection->random(3);
  3. $random->all();
  5. // [2, 4, 5] - (随机返回)

reduce() {#collection-method}

reduce 方法将集合缩减到单个数值，该方法会将每次迭代的结果传入到下一次迭代：

  1. $collection = collect([1, 2, 3]);
  3. $total = $collection->reduce(function ($carry, $item) {
  4.     return $carry + $item;
  5. });
  7. // 6

第一次迭代时 $carry 的数值为 null；然而你也可以传入第二个参数进 reduce 以指定它的初始值：

  1. $collection->reduce(function ($carry, $item) {
  2.     return $carry + $item;
  3. }, 4);
  5. // 10

reject() {#collection-method}

reject 方法以指定的回调函数筛选集合。该回调函数应该对希望从最终集合移除掉的项目返回 true：

  1. $collection = collect([1, 2, 3, 4]);
  3. $filtered = $collection->reject(function ($item) {
  4.     return $item > 2;
  5. });
  7. $filtered->all();
  9. // [1, 2]

与 reject 相反的方法可以查看 filter 方法。

reverse() {#collection-method}

reverse 方法倒转集合内项目的顺序：

  1. $collection = collect([1, 2, 3, 4, 5]);
  3. $reversed = $collection->reverse();
  5. $reversed->all();
  7. // [5, 4, 3, 2, 1]

search() {#collection-method}

search 方法在集合内搜索指定的数值并返回找到的键。假如找不到项目，则返回 false：

  1. $collection = collect([2, 4, 6, 8]);
  3. $collection->search(4);
  5. // 1

搜索是用「宽松」比对来进行。要使用严格比对，就传入 true 为该方法的第二个参数：

  1. $collection->search('4', true);
  3. // false

另外，你可以传入你自己的回调函数来搜索第一个通过你判断测试的项目：

  1. $collection->search(function ($item, $key) {
  2.     return $item > 5;
  3. });
  5. // 2

shift() {#collection-method}

shift 方法移除并返回集合的第一个项目：

  1. $collection = collect([1, 2, 3, 4, 5]);
  3. $collection->shift();
  5. // 1
  7. $collection->all();
  9. // [2, 3, 4, 5]

shuffle() {#collection-method}

shuffle 方法随机排序集合的项目：

  1. $collection = collect([1, 2, 3, 4, 5]);
  3. $shuffled = $collection->shuffle();
  5. $shuffled->all();
  7. // [3, 2, 5, 1, 4] // (generated randomly)

slice() {#collection-method}

slice 方法返回集合从指定索引开始的一部分切片：

  1. $collection = collect([1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);
  3. $slice = $collection->slice(4);
  5. $slice->all();
  7. // [5, 6, 7, 8, 9, 10]

如果你想限制返回切片的大小，就传入想要的大小为方法的第二个参数：

  1. $slice = $collection->slice(4, 2);
  3. $slice->all();
  5. // [5, 6]

返回的切片将会有以数字索引的新键。假如你希望保留原始的键，传入 true 为方法的第三个参数。

sort() {#collection-method}

对集合排序：

  1. $collection = collect([5, 3, 1, 2, 4]);
  3. $sorted = $collection->sort();
  5. $sorted->values()->all();
  7. // [1, 2, 3, 4, 5]

排序过的集合保有原来的数组键。在这个例子中我们用了 values 方法重设键为连续的数字索引。

要排序内含数组或对象的集合，见 sortBy 和 sortByDesc 方法。

假如你需要更高级的排序，你可以传入回调函数以你自己的算法进行排序。参考 PHP 文档的 usort，这是集合的 sort 方法在背后所调用的函数。

sortBy() {#collection-method}

以指定的键排序集合：

  1. $collection = collect([
  2.     ['name' => 'Desk', 'price' => 200],
  3.     ['name' => 'Chair', 'price' => 100],
  4.     ['name' => 'Bookcase', 'price' => 150],
  5. ]);
  7. $sorted = $collection->sortBy('price');
  9. $sorted->values()->all();
  11. /*
  12.     [
  13.         ['name' => 'Chair', 'price' => 100],
  14.         ['name' => 'Bookcase', 'price' => 150],
  15.         ['name' => 'Desk', 'price' => 200],
  16.     ]
  17. */

排序过的集合保有原来的数组键。在这个例子中我们用了 values 方法重设键为连续的数字索引。

你也可以传入自己的回调函数以决定如何排序集合数值：

  1. $collection = collect([
  2.     ['name' => 'Desk', 'colors' => ['Black', 'Mahogany']],
  3.     ['name' => 'Chair', 'colors' => ['Black']],
  4.     ['name' => 'Bookcase', 'colors' => ['Red', 'Beige', 'Brown']],
  5. ]);
  7. $sorted = $collection->sortBy(function ($product, $key) {
  8.     return count($product['colors']);
  9. });
  11. $sorted->values()->all();
  13. /*
  14.     [
  15.         ['name' => 'Chair', 'colors' => ['Black']],
  16.         ['name' => 'Desk', 'colors' => ['Black', 'Mahogany']],
  17.         ['name' => 'Bookcase', 'colors' => ['Red', 'Beige', 'Brown']],
  18.     ]
  19. */

sortByDesc() {#collection-method}

与 sortBy 有着一样的形式，但是会以相反的顺序来排序集合：

splice() {#collection-method}

返回从指定的索引开始的一小切片项目，原本集合也会被切除：

  1. $collection = collect([1, 2, 3, 4, 5]);
  3. $chunk = $collection->splice(2);
  5. $chunk->all();
  7. // [3, 4, 5]
  9. $collection->all();
  11. // [1, 2]

你可以传入第二个参数以限制大小：

  1. $collection = collect([1, 2, 3, 4, 5]);
  3. $chunk = $collection->splice(2, 1);
  5. $chunk->all();
  7. // [3]
  9. $collection->all();
  11. // [1, 2, 4, 5]

此外，你可以传入含有新项目的第三个参数以取代集合中被移除的项目：

  1. $collection = collect([1, 2, 3, 4, 5]);
  3. $chunk = $collection->splice(2, 1, [10, 11]);
  5. $chunk->all();
  7. // [3]
  9. $collection->all();
  11. // [1, 2, 10, 11, 4, 5]

sum() {#collection-method}

返回集合内所有项目的总和：

  1. collect([1, 2, 3, 4, 5])->sum();
  3. // 15

如果集合包含数组或对象，你应该传入一个「键」来指定要用哪些数值来计算总合：

  1. $collection = collect([
  2.     ['name' => 'JavaScript: The Good Parts', 'pages' => 176],
  3.     ['name' => 'JavaScript: The Definitive Guide', 'pages' => 1096],
  4. ]);
  6. $collection->sum('pages');
  8. // 1272

此外，你可以传入自己的回调函数来决定要用哪些数值来计算总合：

  1. $collection = collect([
  2.     ['name' => 'Chair', 'colors' => ['Black']],
  3.     ['name' => 'Desk', 'colors' => ['Black', 'Mahogany']],
  4.     ['name' => 'Bookcase', 'colors' => ['Red', 'Beige', 'Brown']],
  5. ]);
  7. $collection->sum(function ($product) {
  8.     return count($product['colors']);
  9. });
  11. // 6

take() {#collection-method}

返回有着指定数量项目的集合：

  1. $collection = collect([0, 1, 2, 3, 4, 5]);
  3. $chunk = $collection->take(3);
  5. $chunk->all();
  7. // [0, 1, 2]

你也可以传入负整数以获取从集合后面来算指定数量的项目：

  1. $collection = collect([0, 1, 2, 3, 4, 5]);
  3. $chunk = $collection->take(-2);
  5. $chunk->all();
  7. // [4, 5]

toArray() {#collection-method}

将集合转换成纯 PHP 数组。假如集合的数值是 Eloquent 模型，也会被转换成数组：

  1. $collection = collect(['name' => 'Desk', 'price' => 200]);
  3. $collection->toArray();
  5. /*
  6.     [
  7.         ['name' => 'Desk', 'price' => 200],
  8.     ]
  9. */

注意：toArray 也会转换所有内嵌的对象为数组。假如你希望获取原本的底层数组，改用 all 方法。

toJson() {#collection-method}

将集合转换成 JSON：

  1. $collection = collect(['name' => 'Desk', 'price' => 200]);
  3. $collection->toJson();
  5. // '{"name":"Desk","price":200}'

transform() {#collection-method}

遍历集合并对集合内每一个项目调用指定的回调函数。集合的项目将会被回调函数返回的数值取代掉：

  1. $collection = collect([1, 2, 3, 4, 5]);
  3. $collection->transform(function ($item, $key) {
  4.     return $item * 2;
  5. });
  7. $collection->all();
  9. // [2, 4, 6, 8, 10]

注意：与大多数其它集合的方法不同，transform 会修改集合本身。如果你希望创建新集合，就改用 map 方法。

union() {#collection-method}

将给定的数组合并到集合中，如果数组中含有与集合一样的「键」，集合的键值会被保留：

  1. $collection = collect([1 => ['a'], 2 => ['b']]);
  3. $union = $collection->union([3 => ['c'], 1 => ['b']]);
  5. $union->all();
  7. // [1 => ['a'], 2 => ['b'], [3 => ['c']]

unique() {#collection-method}

unique 方法返回集合中所有唯一的项目：

  1. $collection = collect([1, 1, 2, 2, 3, 4, 2]);
  3. $unique = $collection->unique();
  5. $unique->values()->all();
  7. // [1, 2, 3, 4]

排序过的集合保有原来的数组键。在这个例子中我们用了 values 方法重设键为连续的数字索引。

当处理内嵌的数组或对象，你可以指定用来决定唯一性的键：

  1. $collection = collect([
  2.     ['name' => 'iPhone 6', 'brand' => 'Apple', 'type' => 'phone'],
  3.     ['name' => 'iPhone 5', 'brand' => 'Apple', 'type' => 'phone'],
  4.     ['name' => 'Apple Watch', 'brand' => 'Apple', 'type' => 'watch'],
  5.     ['name' => 'Galaxy S6', 'brand' => 'Samsung', 'type' => 'phone'],
  6.     ['name' => 'Galaxy Gear', 'brand' => 'Samsung', 'type' => 'watch'],
  7. ]);
  9. $unique = $collection->unique('brand');
  11. $unique->values()->all();
  13. /*
  14.     [
  15.         ['name' => 'iPhone 6', 'brand' => 'Apple', 'type' => 'phone'],
  16.         ['name' => 'Galaxy S6', 'brand' => 'Samsung', 'type' => 'phone'],
  17.     ]
  18. */

你可以传入自己的回调函数来决定项目的唯一性：

  1. $unique = $collection->unique(function ($item) {
  2.     return $item['brand'].$item['type'];
  3. });
  5. $unique->values()->all();
  7. /*
  8.     [
  9.         ['name' => 'iPhone 6', 'brand' => 'Apple', 'type' => 'phone'],
  10.         ['name' => 'Apple Watch', 'brand' => 'Apple', 'type' => 'watch'],
  11.         ['name' => 'Galaxy S6', 'brand' => 'Samsung', 'type' => 'phone'],
  12.         ['name' => 'Galaxy Gear', 'brand' => 'Samsung', 'type' => 'watch'],
  13.     ]
  14. */

values() {#collection-method}

返回「键」重新被设为「连续整数」的新集合：

  1. $collection = collect([
  2.     10 => ['product' => 'Desk', 'price' => 200],
  3.     11 => ['product' => 'Desk', 'price' => 200]
  4. ]);
  6. $values = $collection->values();
  8. $values->all();
  10. /*
  11.     [
  12.         0 => ['product' => 'Desk', 'price' => 200],
  13.         1 => ['product' => 'Desk', 'price' => 200],
  14.     ]
  15. */

where() {#collection-method}

以一对指定的「键／数值」筛选集合：

  1. $collection = collect([
  2.     ['product' => 'Desk', 'price' => 200],
  3.     ['product' => 'Chair', 'price' => 100],
  4.     ['product' => 'Bookcase', 'price' => 150],
  5.     ['product' => 'Door', 'price' => 100],
  6. ]);
  8. $filtered = $collection->where('price', 100);
  10. $filtered->all();
  12. /*
  13. [
  14.     ['product' => 'Chair', 'price' => 100],
  15.     ['product' => 'Door', 'price' => 100],
  16. ]
  17. */

以严格比对检查数值。使用 whereLoose 方法以宽松比对进行筛选。

whereLoose() {#collection-method}

这个方法与 where 方法有着一样的形式；但是会以「宽松」比对来比对数值：

whereIn() {#collection-method}

基于参数中的键值数组进行过滤：

  1. $collection = collect([
  2.     ['product' => 'Desk', 'price' => 200],
  3.     ['product' => 'Chair', 'price' => 100],
  4.     ['product' => 'Bookcase', 'price' => 150],
  5.     ['product' => 'Door', 'price' => 100],
  6. ]);
  8. $filtered = $collection->whereIn('price', [150, 200]);
  10. $filtered->all();
  12. /*
  13. [
  14.     ['product' => 'Bookcase', 'price' => 150],
  15.     ['product' => 'Desk', 'price' => 200],
  16. ]
  17. */

此方法是用严格的比较，你可以使用 whereInLoose 做比较 宽松 的比较。

whereInLoose() {#collection-method}

此方法的使用于 whereIn 方法类似，相比之下使用比较 宽松 的过滤。

zip() {#collection-method}

zip 方法将集合与指定数组同样索引的值合并在一起：

$collection = collect(['Chair', 'Desk']);

$zipped = $collection->zip([100, 200]);

$zipped->all();

// [['Chair', 100], ['Desk', 200]]

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

转载请注明：本文档由 Laravel China 社区 [laravel-china.org] 组织翻译。

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