扫码一下
查看教程更方便
教程 > Laravel 教程 > Laravel 进阶
阅读：253
Laravel 集合可用函数一
集合方法 一
all()
all 方法简单返回集合表示的底层数组：
collect([1, 2, 3])->all();
// [1, 2, 3]
avg()
avg 方法返回所有集合项的平均值：
$average = collect([['foo' => 10], ['foo' => 10], ['foo' => 20], ['foo' => 40]])->avg('foo');
// 20
$average = collect([1, 1, 2, 4])->avg();
// 2
average()
avg 方法的别名。
chunk()
chunk 方法将一个集合分割成多个小尺寸的小集合：
$collection = collect([1, 2, 3, 4, 5, 6, 7]);
$chunks = $collection->chunk(4);
$chunks->toArray();
// [[1, 2, 3, 4], [5, 6, 7]]
当处理栅栏系统如 Bootstrap 时该方法在视图中尤其有用，假设你有一个想要显示在栅栏中的 Eloquent 模型集合：
@foreach ($products->chunk(3) as $chunk)
<div class="row">
@foreach ($chunk as $product)
<div class="col-xs-4">{{ $product->name }}</div>
@endforeach
</div>
@endforeach
collapse()
collapse 方法将一个多维数组集合收缩成一个一维数组：
$collection = collect([[1, 2, 3], [4, 5, 6], [7, 8, 9]]);
$collapsed = $collection->collapse();
$collapsed->all();
// [1, 2, 3, 4, 5, 6, 7, 8, 9]
combine()
combine 方法可以将一个集合的键和另一个数组或集合的值连接起来：
$collection = collect(['name', 'age']);
$combined = $collection->combine(['George', 29]);
$combined->all();
// ['name' => 'George', 'age' => 29]
collect()
collect 方法返回一个新的包含当前元素的 Collection 实例：
$collectionA = collect([1, 2, 3]);
$collectionB = $collectionA->collect();
$collectionB->all();
// [1, 2, 3]
collect 方法在将懒集合转化为标准 Collection 实例时很有用：
$lazyCollection = LazyCollection::make(function () {
yield 1;
yield 2;
yield 3;
});
$collection = $lazyCollection->collect();
get_class($collection);
// 'Illuminate\Support\Collection'
$collection->all();
// [1, 2, 3]
注：collect 方法在当你有一个 Enumerable 实例并且需要一个非懒集合实例时特别有用，由于 collect() 是 Enumerable 契约的一部分，所以你可以通过它安全获取一个 Collection 实例。
concat()
concat 方法可用于追加给定数组或集合数据到集合末尾：
$collection = collect(['John Doe']);
$concatenated = $collection->concat(['Jane Doe'])->concat(['name' => 'Johnny Doe']);
$concatenated->all();
// ['John Doe', 'Jane Doe', 'Johnny Doe']
contains()
contains 方法判断集合是否包含一个给定项：
$collection = collect(['name' => 'Desk', 'price' => 100]);
$collection->contains('Desk');
// true
$collection->contains('New York');
// false
我们还可以传递一个键值对到 contains 方法，这将会判断给定键值对是否存在于集合中：
$collection = collect([
['product' => 'Desk', 'price' => 200],
['product' => 'Chair', 'price' => 100],
]);
$collection->contains('product', 'Bookcase');
// false
最后，我们还可以传递一个回调到 contains 方法来执行自己的真实测试：
$collection = collect([1, 2, 3, 4, 5]);
$collection->contains(function ($key, $value) {
return $value > 5;
});
// false
contains 方法在检查值的时候使用「宽松」比较，这意味着一个包含整型值的字符串和同样的整型值是相等的（例如，'1' 和 1 相等）。要想进行严格比较，可以使用 containsStrict 方法。
containsStrict()
这个方法和 contains 方法签名一样，不同之处在于所有值都是「严格」比较。
count()
count 方法返回集合中所有项的总数：
$collection = collect([1, 2, 3, 4]);
$collection->count();
// 4
countBy()
countBy 方法用于计算集合中某个值出现的次数。默认情况下，该方法会计算每个元素的出现次数：
$collection = collect([1, 2, 2, 2, 3]);
$counted = $collection->countBy();
$counted->all();
// [1 => 1, 2 => 3, 3 => 1]
我们还可以传递一个回调到该方法以便通过自定义的值计算元素出现次数：
$collection = collect(['alice@gmail.com', 'bob@yahoo.com', 'carlos@gmail.com']);
$counted = $collection->countBy(function ($email) {
return substr(strrchr($email, "@"), 1);
});
$counted->all();
// ['gmail.com' => 2, 'yahoo.com' => 1]
crossJoin()
crossJoin 方法会在给定数组或集合之间交叉组合集合值，然后返回所有可能排列组合的笛卡尔积：
$collection = collect([1, 2]);
$matrix = $collection->crossJoin(['a', 'b']);
$matrix->all();
/*
[
[1, 'a'],
[1, 'b'],
[2, 'a'],
[2, 'b'],
]
*/
$collection = collect([1, 2]);
$matrix = $collection->crossJoin(['a', 'b'], ['I', 'II']);
$matrix->all();
/*
[
[1, 'a', 'I'],
[1, 'a', 'II'],
[1, 'b', 'I'],
[1, 'b', 'II'],
[2, 'a', 'I'],
[2, 'a', 'II'],
[2, 'b', 'I'],
[2, 'b', 'II'],
]
*/
dd()
dd 方法会打印集合项并结束脚本执行：
$collection = collect(['John Doe', 'Jane Doe']);
$collection->dd();
/*
Collection {
#items: array:2 [
0 => "John Doe"
1 => "Jane Doe"
]
}
*/
如果你不想要终止脚本执行，可以使用 dump 方法来替代。
dump()
dump 方法会打印集合项而不终止脚本执行：
$collection = collect(['John Doe', 'Jane Doe']);
$collection->dump();
/*
Collection {
#items: array:2 [
0 => "John Doe"
1 => "Jane Doe"
]
}
*/
如果你想要在打印集合之后终止脚本执行，可以使用 dd 方法来替代。
diff()
diff方法将集合和另一个集合或原生 PHP 数组以基于值的方式作比较，这个方法会返回存在于原来集合而不存在于给定集合的值：
$collection = collect([1, 2, 3, 4, 5]);
$diff = $collection->diff([2, 4, 6, 8]);
$diff->all();
// [1, 3, 5]
注：该方法的行为在使用 Eloquent 集合时会发生改变。
diffAssoc()
diffAssoc 方法会基于键值将一个集合和另一个集合或原生 PHP 数组进行比较。该方法返回只存在于第一个集合中的键值对：
$collection = collect([
'color' => 'orange',
'type' => 'fruit',
'remain' => 6
]);
$diff = $collection->diffAssoc([
'color' => 'yellow',
'type' => 'fruit',
'remain' => 3,
'used' => 6
]);
$diff->all();
// ['color' => 'orange', 'remain' => 6]
diffKeys()
diffKeys 方法会基于犍将一个集合和另一个集合或原生 PHP 数组进行比较。该方法会返回只存在于第一个集合的键值对：
$collection = collect([
'one' => 10,
'two' => 20,
'three' => 30,
'four' => 40,
'five' => 50,
]);
$diff = $collection->diffKeys([
'two' => 2,
'four' => 4,
'six' => 6,
'eight' => 8,
]);
$diff->all();
// ['one' => 10, 'three' => 30, 'five' => 50]
duplicates()
duplicates 方法从集合中检索并返回重复值：
$collection = collect(['a', 'b', 'a', 'c', 'b']);
$collection->duplicates();
// [2 => 'a', 4 => 'b']
如果集合包含数组或对象，你可以传递这些属性的键来检查是否包含重复值：
$employees = collect([
['email' => 'abigail@example.com', 'position' => 'Developer'],
['email' => 'james@example.com', 'position' => 'Designer'],
['email' => 'victoria@example.com', 'position' => 'Developer'],
])
$employees->duplicates('position');
// [2 => 'Developer']
duplicatesStrict()
duplicatesStrict方法和 duplicates 方法使用方式类似，只不过所有值的比较使用的都是「严格」模式。
each()
each 方法迭代集合中的数据项并传递每个数据项到给定回调：
$collection = $collection->each(function ($item, $key) {
//
});
如果你想要终止对数据项的迭代，可以从回调返回 false：
$collection = $collection->each(function ($item, $key) {
if (/* some condition */) {
return false;
}
});
eachSpread()
eachSpread 方法会迭代集合项，传递每个嵌套数据项值到给定集合：
$collection = collect([['John Doe', 35], ['Jane Doe', 33]]);
$collection->eachSpread(function ($name, $age) {
//
});
我们可以通过从回调中返回 false 来停止对集合项的迭代：
$collection->eachSpread(function ($name, $age) {
return false;
});
every()
every 方法可以用于验证集合的所有元素能够通过给定的真理测试：
collect([1, 2, 3, 4])->every(function ($value, $key) {
return $value > 2;
});
// false
如果集合为空，every 方法将返回 true：
$collection = collect([]);
$collection->every(function($value, $key) {
return $value > 2;
});
// true
except()
except 方法返回集合中除了指定键的所有集合项：
$collection = collect(['product_id' => 1, 'price' => 100, 'discount' => false]);
$filtered = $collection->except(['price', 'discount']);
$filtered->all();
// ['product_id' => 1]
与 except 相对的是 only 方法。
注：该方法的行为在使用 Eloquent 集合时会发生改变。
filter()
filter 方法通过给定回调过滤集合，只有通过给定真理测试的数据项才会保留下来：
$collection = collect([1, 2, 3, 4]);
$filtered = $collection->filter(function ($value, $key) {
return $value > 2;
});
$filtered->all();
// [3, 4]
如果没有提供回调，那么集合中所有等价于 false 的项都会被移除：
$collection = collect([1, 2, 3, null, false, '', 0, []]);
$collection->filter()->all();
// [1, 2, 3]
和 filter 相对的方法是 reject。
first()
first 方法返回通过真理测试集合的第一个元素：
collect([1, 2, 3, 4])->first(function ($value, $key) {
return $value > 2;
});
// 3
我们还可以调用不带参数的 first 方法来获取集合的第一个元素，如果集合是空的，返回 null：
collect([1, 2, 3, 4])->first();
// 1
firstWhere()
firstWhere 方法会返回集合中的第一个元素，包含键值对：
$collection = collect([
['name' => 'Regena', 'age' => 12],
['name' => 'Linda', 'age' => 14],
['name' => 'Diego', 'age' => 23],
['name' => 'Linda', 'age' => 84],
]);
$collection->firstWhere('name', 'Linda');
// ['name' => 'Linda', 'age' => 14]
还可以调用带操作符的 firstWhere 方法：
$collection->firstWhere('age', '>=', 18);
// ['name' => 'Diego', 'age' => 23]
和 where 方法一样，你可以传递一个参数到 firstWhere 方法。在这种场景中，firstWhere 方法将返回给定键值对应的第一个项目：
$collection->firstWhere('age');
// ['name' => 'Linda', 'age' => 14]
flatMap()
flatMap 方法会迭代集合并传递每个值到给定回调，该回调可以自由编辑数据项并将其返回，最后形成一个经过编辑的新集合。然后，这个数组在层级维度被扁平化：
$collection = collect([
['name' => 'Sally'],
['school' => 'Arkansas'],
['age' => 28]
]);
$flattened = $collection->flatMap(function ($values) {
return array_map('strtoupper', $values);
});
$flattened->all();
// ['name' => 'SALLY', 'school' => 'ARKANSAS', 'age' => '28'];
flatten()
flatten 方法将多维度的集合变成一维的：
$collection = collect(['name' => 'taylor', 'languages' => ['php', 'javascript']]);
$flattened = $collection->flatten();
$flattened->all();
// ['taylor', 'php', 'javascript'];
还可以选择性传入深度参数：
$collection = collect([
'Apple' => [
['name' => 'iPhone 6S', 'brand' => 'Apple'],
],
'Samsung' => [
['name' => 'Galaxy S7', 'brand' => 'Samsung']
],
]);
$products = $collection->flatten(1);
$products->values()->all();
/*
[
['name' => 'iPhone 6S', 'brand' => 'Apple'],
['name' => 'Galaxy S7', 'brand' => 'Samsung'],
]
*/
在本例中，调用不提供深度的 flatten 方法也会对嵌套数组进行扁平化处理，返回结果是 ['iPhone 6S', 'Apple', 'Galaxy S7', 'Samsung']。提供深度允许你严格设置被扁平化的数组层级。
flip()
flip 方法将集合的键值做交换：
$collection = collect(['name' => 'taylor', 'framework' => 'laravel']);
$flipped = $collection->flip();
$flipped->all();
// ['taylor' => 'name', 'laravel' => 'framework']
forget()
forget 方法通过键从集合中移除数据项：
$collection = collect(['name' => 'taylor', 'framework' => 'laravel']);
$collection->forget('name');
$collection->all();
// [framework' => 'laravel']
注：不同于大多数其他的集合方法，forget 不返回新的修改过的集合；它只修改所调用的集合。
forPage()
forPage 方法返回新的包含给定页数数据项的集合。该方法接收页码数作为第一个参数，每页显示数据项数作为第二个参数：
$collection = collect([1, 2, 3, 4, 5, 6, 7, 8, 9]);
$chunk = $collection->forPage(2, 3);
$chunk->all();
// [4, 5, 6]
get()
get 方法返回给定键的数据项，如果对应键不存在，返回null：
$collection = collect(['name' => 'taylor', 'framework' => 'laravel']);
$value = $collection->get('name');
// taylor
你可以选择传递默认值作为第二个参数：
$collection = collect(['name' => 'taylor', 'framework' => 'laravel']);
$value = $collection->get('foo', 'default-value');
// default-value
你甚至可以传递回调作为默认值，如果给定键不存在的话回调的结果将会返回：
$collection->get('email', function () {
return 'default-value';
});
// default-value
groupBy()
groupBy 方法通过给定键分组集合数据项：
$collection = collect([
['account_id' => 'account-x10', 'product' => 'Chair'],
['account_id' => 'account-x10', 'product' => 'Bookcase'],
['account_id' => 'account-x11', 'product' => 'Desk'],
]);
$grouped = $collection->groupBy('account_id');
$grouped->toArray();
/*
[
'account-x10' => [
['account_id' => 'account-x10', 'product' => 'Chair'],
['account_id' => 'account-x10', 'product' => 'Bookcase'],
],
'account-x11' => [
['account_id' => 'account-x11', 'product' => 'Desk'],
],
]
*/
除了传递字符串 key，还可以传递一个回调，回调应该返回分组后的值：
$grouped = $collection->groupBy(function ($item, $key) {
return substr($item['account_id'], -3);
});
$grouped->toArray();
/*
[
'x10' => [
['account_id' => 'account-x10', 'product' => 'Chair'],
['account_id' => 'account-x10', 'product' => 'Bookcase'],
],
'x11' => [
['account_id' => 'account-x11', 'product' => 'Desk'],
],
]
*/
多个分组条件可以以一个数组的方式传递，每个数组元素都会应用到多维数组中的对应层级：
$data = new Collection([
10 => ['user' => 1, 'skill' => 1, 'roles' => ['Role_1', 'Role_3']],
20 => ['user' => 2, 'skill' => 1, 'roles' => ['Role_1', 'Role_2']],
30 => ['user' => 3, 'skill' => 2, 'roles' => ['Role_1']],
40 => ['user' => 4, 'skill' => 2, 'roles' => ['Role_2']],
]);
$result = $data->groupBy([
'skill',
function ($item) {
return $item['roles'];
},
], $preserveKeys = true);
/*
[
1 => [
'Role_1' => [
10 => ['user' => 1, 'skill' => 1, 'roles' => ['Role_1', 'Role_3']],
20 => ['user' => 2, 'skill' => 1, 'roles' => ['Role_1', 'Role_2']],
],
'Role_2' => [
20 => ['user' => 2, 'skill' => 1, 'roles' => ['Role_1', 'Role_2']],
],
'Role_3' => [
10 => ['user' => 1, 'skill' => 1, 'roles' => ['Role_1', 'Role_3']],
],
],
2 => [
'Role_1' => [
30 => ['user' => 3, 'skill' => 2, 'roles' => ['Role_1']],
],
'Role_2' => [
40 => ['user' => 4, 'skill' => 2, 'roles' => ['Role_2']],
],
],
];
*/
has()
has 方法判断给定键是否在集合中存在：
$collection = collect(['account_id' => 1, 'product' => 'Desk', 'amount' => 5]);
$collection->has('product');
// true
$collection->has(['product', 'amount']);
// true
$collection->has(['amount', 'price']);
// false
implode()
implode 方法连接集合中的数据项。其参数取决于集合中数据项的类型。如果集合包含数组或对象，应该传递你想要连接的属性键，以及你想要放在值之间的 “粘合”字符串：
$collection = collect([
['account_id' => 1, 'product' => 'Desk'],
['account_id' => 2, 'product' => 'Chair'],
]);
$collection->implode('product', ', ');
// Desk, Chair
如果集合包含简单的字符串或数值，只需要传递“粘合”字符串作为唯一参数到该方法：
collect([1, 2, 3, 4, 5])->implode('-');
// '1-2-3-4-5'
intersect()
intersect 方法返回两个集合的交集，结果集合将保留原来集合的键：
$collection = collect(['Desk', 'Sofa', 'Chair']);
$intersect = $collection->intersect(['Desk', 'Chair', 'Bookcase']);
$intersect->all();
// [0 => 'Desk', 2 => 'Chair']
注：该方法的行为会在使用 Eloquent 集合时发生改变。
intersectByKeys()
intersectByKeys 方法会从原生集合中移除任意没有在给定数组或集合中出现的键：
$collection = collect([
'serial' => 'UX301', 'type' => 'screen', 'year' => 2009
]);
$intersect = $collection->intersectByKeys([
'reference' => 'UX404', 'type' => 'tab', 'year' => 2011
]);
$intersect->all();
// ['type' => 'screen', 'year' => 2009]
