Illuminate\Support\Collection
類為處理數(shù)組數(shù)據(jù)提供了平滑、方便的封裝。例如,查看下面的代碼,我們使用幫助函數(shù)collect
創(chuàng)建一個新的集合實例,為每一個元素運行strtoupper
函數(shù),然后移除所有空元素:
$collection = collect(['taylor', 'abigail', null])->map(function ($name) {
? ? return strtoupper($name);
})->reject(function ($name) {
? ? return empty($name);
});
正如你所看到的,Collection
類允許你使用方法鏈對底層數(shù)組執(zhí)行匹配和減少操作,通常,沒個Collection
方法都會返回一個新的Collection
實例。
正如上面所提到的,幫助函數(shù)collect
為給定數(shù)組返回一個新的Illuminate\Support\Collection
實例,所以,創(chuàng)建集合很簡單:
$collection = collect([1, 2, 3]);
默認情況下,Eloquent模型的集合總是返回Collection
實例,此外,不管是在何處,只要方法都可以自由使用Collection
類。
本文檔接下來的部分我們將會討論Collection
類上每一個有效的方法,所有這些方法都可以以方法鏈的方式平滑的操作底層數(shù)組。此外,幾乎每個方法返回一個新的Collection
實例,允許你在必要的時候保持原來的集合備份。
all
方法簡單返回集合表示的底層數(shù)組:
collect([1, 2, 3])->all();
// [1, 2, 3]
chunk
方法將一個集合分割成多個小尺寸的小集合:
$collection = collect([1, 2, 3, 4, 5, 6, 7]);
$chunks = $collection->chunk(4);
$chunks->toArray();
// [[1, 2, 3, 4], [5, 6, 7]]
當處理柵欄系統(tǒng)如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
方法將一個多維數(shù)組集合收縮成一個一維數(shù)組:
$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]
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
最后,你還可以傳遞一個回調(diào)到contains
方法來執(zhí)行自己的真實測試:
$collection = collect([1, 2, 3, 4, 5]);
$collection->contains(function ($key, $value) {
return $value > 5;
});
// false
count
方法返回集合中所有項的數(shù)目:
$collection = collect([1, 2, 3, 4]);
$collection->count();
// 4
diff
方法將集合和另一個集合或原生PHP數(shù)組作比較:
$collection = collect([1, 2, 3, 4, 5]);
$diff = $collection->diff([2, 4, 6, 8]);
$diff->all();
// [1, 3, 5]
each
方法迭代集合中的數(shù)據(jù)項并傳遞每個數(shù)據(jù)項到給定回調(diào):
$collection = $collection->each(function ($item, $key) {
//
});
回調(diào)返回false
將會終止循環(huán):
$collection = $collection->each(function ($item, $key) {
if (/* some condition */) {
return false;
}
});
filter
方法通過給定回調(diào)過濾集合,只有通過給定測試的數(shù)據(jù)項才會保留下來:
$collection = collect([1, 2, 3, 4]);
$filtered = $collection->filter(function ($item) {
return $item > 2;
});
$filtered->all();
// [3, 4]
和filter
相反的方法是reject
。
first
方法返回通過測試集合的第一個元素:
collect([1, 2, 3, 4])->first(function ($key, $value) {
return $value > 2;
});
// 3
你還可以調(diào)用不帶參數(shù)的first
方法來獲取集合的第一個元素,如果集合是空的,返回null:
collect([1, 2, 3, 4])->first();
// 1
flatten
方法將多維度的集合變成一維的:
$collection = collect(['name' => 'taylor', 'languages' => ['php', 'javascript']]);
$flattened = $collection->flatten();
$flattened->all();
// ['taylor', 'php', 'javascript'];
flip
方法將集合的鍵值做交換:
$collection = collect(['name' => 'taylor', 'framework' => 'laravel']);
$flipped = $collection->flip();
$flipped->all();
// ['taylor' => 'name', 'laravel' => 'framework']
forget
方法通過鍵從集合中移除數(shù)據(jù)項:
$collection = collect(['name' => 'taylor', 'framework' => 'laravel']);
$collection->forget('name');
$collection->all();
// [framework' => 'laravel']
注意:不同于大多數(shù)的集合方法,forget
不返回新的修改過的集合;它只修改所調(diào)用的集合。
forPage
方法返回新的包含給定頁數(shù)數(shù)據(jù)項的集合:
$collection = collect([1, 2, 3, 4, 5, 6, 7, 8, 9])->forPage(2, 3);
$collection->all();
// [4, 5, 6]
該方法需要傳入頁數(shù)和每頁顯示數(shù)目參數(shù)。
get
方法返回給定鍵的數(shù)據(jù)項,如果不存在,返回null:
$collection = collect(['name' => 'taylor', 'framework' => 'laravel']);
$value = $collection->get('name');
// taylor
你可以選擇傳遞默認值作為第二個參數(shù):
$collection = collect(['name' => 'taylor', 'framework' => 'laravel']);
$value = $collection->get('foo', 'default-value');
// default-value
你甚至可以傳遞回調(diào)作為默認值,如果給定鍵不存在的話回調(diào)的結果將會返回:
$collection->get('email', function () {
return 'default-value';});
// default-value
groupBy
方法通過給定鍵分組集合數(shù)據(jù)項:
$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,還可以傳遞一個回調(diào),回調(diào)應該返回分組后的值:
$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'],
],
]
*/
has
方法判斷給定鍵是否在集合中存在:
$collection = collect(['account_id' => 1, 'product' => 'Desk']);
$collection->has('email');
// false
implode
方法連接集合中的數(shù)據(jù)項。其參數(shù)取決于集合中數(shù)據(jù)項的類型。
如果集合包含數(shù)組或?qū)ο?,應該傳遞你想要連接的屬性鍵,以及你想要放在值之間的 “粘合”字符串:
$collection = collect([
['account_id' => 1, 'product' => 'Desk'],
['account_id' => 2, 'product' => 'Chair'],
]);
$collection->implode('product', ', ');
// Desk, Chair
如果集合包含簡單的字符串或數(shù)值,只需要傳遞“粘合”字符串作為唯一參數(shù)到該方法:
collect([1, 2, 3, 4, 5])->implode('-');
// '1-2-3-4-5'
intersect
方法返回兩個集合的交集:
$collection = collect(['Desk', 'Sofa', 'Chair']);
$intersect = $collection->intersect(['Desk', 'Chair', 'Bookcase']);
$intersect->all();
// [0 => 'Desk', 2 => 'Chair']
正如你所看到的,結果集合只保持原來集合的鍵。
如果集合為空的話isEmpty
方法返回true
;否則返回false
:
collect([])->isEmpty();
// true
將指定鍵的值作為集合的鍵:
$collection = collect([
['product_id' => 'prod-100', 'name' => 'desk'],
['product_id' => 'prod-200', 'name' => 'chair'],
]);
$keyed = $collection->keyBy('product_id');
$keyed->all();
/*
[
'prod-100' => ['product_id' => 'prod-100', 'name' => 'Desk'],
'prod-200' => ['product_id' => 'prod-200', 'name' => 'Chair'],
]
*/
如果多個數(shù)據(jù)項有同一個鍵,只有最后一個會出現(xiàn)在新的集合中。
你可以傳遞自己的回調(diào),將會返回經(jīng)過處理的鍵的值作為新的鍵:
$keyed = $collection->keyBy(function ($item) {
return strtoupper($item['product_id']);
});
$keyed->all();
/*
[
'PROD-100' => ['product_id' => 'prod-100', 'name' => 'Desk'],
'PROD-200' => ['product_id' => 'prod-200', 'name' => 'Chair'],
]
*/
keys
方法返回所有集合的鍵:
$collection = collect([
'prod-100' => ['product_id' => 'prod-100', 'name' => 'Desk'],
'prod-200' => ['product_id' => 'prod-200', 'name' => 'Chair'],
]);
$keys = $collection->keys();
$keys->all();
// ['prod-100', 'prod-200']
last
方法返回通過測試的集合的最后一個元素:
collect([1, 2, 3, 4])->last(function ($key, $value) {
return $value < 3;
});
// 2
還可以調(diào)用無參的last
方法來獲取集合的最后一個元素。如果集合為空。返回null:
collect([1, 2, 3, 4])->last();
// 4
map
方法遍歷集合并傳遞每個值給給定回調(diào)。該回調(diào)可以修改數(shù)據(jù)項并返回,從而生成一個新的經(jīng)過修改的集合:
$collection = collect([1, 2, 3, 4, 5]);
$multiplied = $collection->map(function ($item, $key) {
return $item * 2;
});
$multiplied->all();
// [2, 4, 6, 8, 10]
注意:和大多數(shù)集合方法一樣,map
返回新的集合實例;它并不修改所調(diào)用的實例。如果你想要改變原來的集合,使用[
transform](http://laravelacademy.org/post/178.html#ipt_kb_toc_178_49)
方法。
merge
方法合并給定數(shù)組到集合。該數(shù)組中的任何字符串鍵匹配集合中的字符串鍵的將會重寫集合中的值:
$collection = collect(['product_id' => 1, 'name' => 'Desk']);
$merged = $collection->merge(['price' => 100, 'discount' => false]);
$merged->all();
// ['product_id' => 1, 'name' => 'Desk', 'price' => 100, 'discount' => false]
如果給定數(shù)組的鍵是數(shù)字,數(shù)組的值將會附加到集合后面:
$collection = collect(['Desk', 'Chair']);
$merged = $collection->merge(['Bookcase', 'Door']);
$merged->all();
// ['Desk', 'Chair', 'Bookcase', 'Door']
pluck
方法為給定鍵獲取所有集合值:
$collection = collect([
['product_id' => 'prod-100', 'name' => 'Desk'],
['product_id' => 'prod-200', 'name' => 'Chair'],
]);
$plucked = $collection->pluck('name');
$plucked->all();
// ['Desk', 'Chair']
還可以指定你想要結果集合如何設置鍵:
$plucked = $collection->pluck('name', 'product_id');
$plucked->all();
// ['prod-100' => 'Desk', 'prod-200' => 'Chair']
pop
方法移除并返回集合中最后面的數(shù)據(jù)項:
$collection = collect([1, 2, 3, 4, 5]);
$collection->pop();
// 5
$collection->all();
// [1, 2, 3, 4]
prepend
方法添加數(shù)據(jù)項到集合開頭:
$collection = collect([1, 2, 3, 4, 5]);
$collection->prepend(0);
$collection->all();
// [0, 1, 2, 3, 4, 5]
pull
方法通過鍵從集合中移除并返回數(shù)據(jù)項:
$collection = collect(['product_id' => 'prod-100', 'name' => 'Desk']);
$collection->pull('name');
// 'Desk'
$collection->all();
// ['product_id' => 'prod-100']
push
方法附加數(shù)據(jù)項到集合結尾:
$collection = collect([1, 2, 3, 4]);
$collection->push(5);
$collection->all();
// [1, 2, 3, 4, 5]
put
方法在集合中設置給定鍵和值:
$collection = collect(['product_id' => 1, 'name' => 'Desk']);
$collection->put('price', 100);
$collection->all();
// ['product_id' => 1, 'name' => 'Desk', 'price' => 100]
random
?方法從集合中返回隨機數(shù)據(jù)項:
$collection = collect([1, 2, 3, 4, 5]);
$collection->random();
// 4 - (retrieved randomly)
你可以傳遞一個整型數(shù)據(jù)到random
函數(shù),如果該整型數(shù)值大于1,將會返回一個集合:
$random = $collection->random(3);
$random->all();
// [2, 4, 5] - (retrieved randomly)
reduce
?方法用于減少集合到單個值,傳遞每個迭代結果到隨后的迭代:
$collection = collect([1, 2, 3]);
$total = $collection->reduce(function ($carry, $item) {
return $carry + $item;
});
// 6
在第一次迭代時$carry
的值是null;然而,你可以通過傳遞第二個參數(shù)到reduce
來指定其初始值:
$collection->reduce(function ($carry, $item) {
return $carry + $item;
}, 4);
// 10
reject方法使用給定回調(diào)過濾集合,該回調(diào)應該為所有它想要從結果集合中移除的數(shù)據(jù)項返回true:
$collection = collect([1, 2, 3, 4]);
$filtered = $collection->reject(function ($item) {
return $item > 2;
});
$filtered->all();
// [1, 2]
和reduce
方法相對的方法是filter方法。
reverse
方法將集合數(shù)據(jù)項的順序顛倒:
$collection = collect([1, 2, 3, 4, 5]);
$reversed = $collection->reverse();
$reversed->all();
// [5, 4, 3, 2, 1]
search
方法為給定值查詢集合,如果找到的話返回對應的鍵,如果沒找到,則返回false
:
$collection = collect([2, 4, 6, 8]);
$collection->search(4);
// 1
上面的搜索使用的是松散比較,要使用嚴格比較,傳遞true
作為第二個參數(shù)到該方法:
$collection->search('4', true);
// false
此外,你還可以傳遞自己的回調(diào)來搜索通過測試的第一個數(shù)據(jù)項:
$collection->search(function ($item, $key) {
return $item > 5;});
// 2
shift
方法從集合中移除并返回第一個數(shù)據(jù)項:
$collection = collect([1, 2, 3, 4, 5]);
$collection->shift();
// 1
$collection->all();
// [2, 3, 4, 5]
shuffle
方法隨機打亂集合中的數(shù)據(jù)項:
$collection = collect([1, 2, 3, 4, 5]);
$shuffled = $collection->shuffle();
$shuffled->all();
// [3, 2, 5, 1, 4] // (generated randomly)
slice
方法從給定索開始返回集合的一個切片:
$collection = collect([1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);
$slice = $collection->slice(4);
$slice->all();
// [5, 6, 7, 8, 9, 10]
如果你想要限制返回切片的尺寸,將尺寸值作為第二個參數(shù)傳遞到該方法:
$slice = $collection->slice(4, 2);
$slice->all();
// [5, 6]
返回的切片有新的、數(shù)字化索引的鍵,如果你想要保持原有的鍵,可以傳遞第三個參數(shù)true到該方法。
sort
方法對集合進行排序:
$collection = collect([5, 3, 1, 2, 4]);
$sorted = $collection->sort();
$sorted->values()->all();
// [1, 2, 3, 4, 5]
排序后的集合保持原來的數(shù)組鍵,在本例中我們使用values
?方法重置鍵為連續(xù)編號索引。
要為嵌套集合和對象排序,查看[sortBy](http://laravelacademy.org/post/178.html#ipt_kb_toc_178_42)
和[sortByDesc](http://laravelacademy.org/post/178.html#ipt_kb_toc_178_43)
方法。
如果你需要更加高級的排序,你可以使用自己的算法傳遞一個回調(diào)給sort
方法。參考PHP官方文檔關于?[usort](http://php.net/manual/en/function.usort.php#refsect1-function.usort-parameters)
的說明,sort方法底層正是調(diào)用了該方法。
sortBy
方法通過給定鍵對集合進行排序:
$collection = collect([
['name' => 'Desk', 'price' => 200],
['name' => 'Chair', 'price' => 100],
['name' => 'Bookcase', 'price' => 150],
]);
$sorted = $collection->sortBy('price');
$sorted->values()->all();
/*
[
['name' => 'Chair', 'price' => 100],
['name' => 'Bookcase', 'price' => 150],
['name' => 'Desk', 'price' => 200],
]
*/
排序后的集合保持原有數(shù)組索引,在本例中,使用[values](http://laravelacademy.org/post/178.html#ipt_kb_toc_178_51)
方法重置鍵為連續(xù)索引。
你還可以傳遞自己的回調(diào)來判斷如何排序集合的值:
$collection = collect([
['name' => 'Desk', 'colors' => ['Black', 'Mahogany']],
['name' => 'Chair', 'colors' => ['Black']],
['name' => 'Bookcase', 'colors' => ['Red', 'Beige', 'Brown']],
]);
$sorted = $collection->sortBy(function ($product, $key) {
return count($product['colors']);
});
$sorted->values()->all();
/*
[
['name' => 'Chair', 'colors' => ['Black']],
['name' => 'Desk', 'colors' => ['Black', 'Mahogany']],
['name' => 'Bookcase', 'colors' => ['Red', 'Beige', 'Brown']],
]
*/
該方法和?[sortBy](http://laravelacademy.org/post/178.html#ipt_kb_toc_178_42)
用法相同,不同之處在于按照相反順序進行排序。
splice
方法在從給定位置開始移除并返回數(shù)據(jù)項切片:
$collection = collect([1, 2, 3, 4, 5]);
$chunk = $collection->splice(2);
$chunk->all();
// [3, 4, 5]
$collection->all();
// [1, 2]
你可以傳遞參數(shù)來限制返回組塊的大?。?/p>
$collection = collect([1, 2, 3, 4, 5]);
$chunk = $collection->splice(2, 1);
$chunk->all();
// [3]
$collection->all();
// [1, 2, 4, 5]
此外,你可以傳遞第三個參數(shù)來包含新的數(shù)據(jù)項來替代從集合中移除的數(shù)據(jù)項:
$collection = collect([1, 2, 3, 4, 5]);
$chunk = $collection->splice(2, 1, [10, 11]);
$chunk->all();
// [3]
$collection->all();
// [1, 2, 10, 11, 4, 5]
sum
方法返回集合中所有數(shù)據(jù)項的和:
collect([1, 2, 3, 4, 5])->sum();
// 15
如果集合包含嵌套數(shù)組或?qū)ο?,應該傳遞一個鍵用于判斷對哪些值進行求和運算:
$collection = collect([
['name' => 'JavaScript: The Good Parts', 'pages' => 176],
['name' => 'JavaScript: The Definitive Guide', 'pages' => 1096],
]);
$collection->sum('pages');
// 1272
此外,你還可以傳遞自己的回調(diào)來判斷對哪些值進行求和:
$collection = collect([
['name' => 'Chair', 'colors' => ['Black']],
['name' => 'Desk', 'colors' => ['Black', 'Mahogany']],
['name' => 'Bookcase', 'colors' => ['Red', 'Beige', 'Brown']],
]);
$collection->sum(function ($product) {
return count($product['colors']);
});
// 6
take
方法使用指定數(shù)目的數(shù)據(jù)項返回一個新的集合:
$collection = collect([0, 1, 2, 3, 4, 5]);
$chunk = $collection->take(3);
$chunk->all();
// [0, 1, 2]
你還可以傳遞負數(shù)從集合末尾開始獲取指定數(shù)目的數(shù)據(jù)項:
$collection = collect([0, 1, 2, 3, 4, 5]);
$chunk = $collection->take(-2);
$chunk->all();
// [4, 5]
toArray
方法將集合轉化為一個原生的PHP數(shù)組。如果集合的值是Eloquent模型,該模型也會被轉化為數(shù)組:
$collection = collect(['name' => 'Desk', 'price' => 200]);
$collection->toArray();
/*
[
['name' => 'Desk', 'price' => 200],
]
*/
注意:toArray
還將所有嵌套對象轉化為數(shù)組。如果你想要獲取底層數(shù)組,使用all
方法。
toJson
方法將集合轉化為JSON:
$collection = collect(['name' => 'Desk', 'price' => 200]);
$collection->toJson();
// '{"name":"Desk","price":200}'
transform
方法迭代集合并對集合中每個數(shù)據(jù)項調(diào)用給定回調(diào)。集合中的數(shù)據(jù)項將會被替代成從回調(diào)中返回的值:
$collection = collect([1, 2, 3, 4, 5]);
$collection->transform(function ($item, $key) {
return $item * 2;
});
$collection->all();
// [2, 4, 6, 8, 10]
注意:不同于大多數(shù)其它集合方法,transform
修改集合本身,如果你想要創(chuàng)建一個新的集合,使用map方法。
unique
方法返回集合中所有的唯一數(shù)據(jù)項:
$collection = collect([1, 1, 2, 2, 3, 4, 2]);
$unique = $collection->unique();
$unique->values()->all();
// [1, 2, 3, 4]
返回的集合保持原來的數(shù)組鍵,在本例中我們使用values方法重置這些鍵為連續(xù)的數(shù)字索引。
處理嵌套數(shù)組或?qū)ο髸r,可以指定用于判斷唯一的鍵:
$collection = collect([
['name' => 'iPhone 6', 'brand' => 'Apple', 'type' => 'phone'],
['name' => 'iPhone 5', 'brand' => 'Apple', 'type' => 'phone'],
['name' => 'Apple Watch', 'brand' => 'Apple', 'type' => 'watch'],
['name' => 'Galaxy S6', 'brand' => 'Samsung', 'type' => 'phone'],
['name' => 'Galaxy Gear', 'brand' => 'Samsung', 'type' => 'watch'],
]);
$unique = $collection->unique('brand');
$unique->values()->all();
/*
[
['name' => 'iPhone 6', 'brand' => 'Apple', 'type' => 'phone'],
['name' => 'Galaxy S6', 'brand' => 'Samsung', 'type' => 'phone'],
]
*/
你還可以指定自己的回調(diào)用于判斷數(shù)據(jù)項唯一性:
$unique = $collection->unique(function ($item) {
return $item['brand'].$item['type'];
});
$unique->values()->all();
/*
[
['name' => 'iPhone 6', 'brand' => 'Apple', 'type' => 'phone'],
['name' => 'Apple Watch', 'brand' => 'Apple', 'type' => 'watch'],
['name' => 'Galaxy S6', 'brand' => 'Samsung', 'type' => 'phone'],
['name' => 'Galaxy Gear', 'brand' => 'Samsung', 'type' => 'watch'],
]
*/
values
方法使用重置為連續(xù)整型數(shù)字的鍵返回新的集合:
$collection = collect([
10 => ['product' => 'Desk', 'price' => 200],
11 => ['product' => 'Desk', 'price' => 200]
]);
$values = $collection->values();
$values->all();
/*
[
0 => ['product' => 'Desk', 'price' => 200],
1 => ['product' => 'Desk', 'price' => 200],
]
*/
where
方法通過給定鍵值對過濾集合:
$collection = collect([
['product' => 'Desk', 'price' => 200],
['product' => 'Chair', 'price' => 100],
['product' => 'Bookcase', 'price' => 150],
['product' => 'Door', 'price' => 100],
]);
$filtered = $collection->where('price', 100);
$filtered->all();
/*
[
['product' => 'Chair', 'price' => 100],
['product' => 'Door', 'price' => 100],
]
*/
檢查數(shù)據(jù)項值時where
方法使用嚴格條件約束。使用whereLoose方法過濾松散約束。
該方法和where
使用方法相同,不同之處在于whereLoose
在比較值的時候使用松散約束。
zip
方法在于集合的值相應的索引處合并給定數(shù)組的值:
$collection = collect(['Chair', 'Desk']);
$zipped = $collection->zip([100, 200]);
$zipped->all();
// [['Chair', 100], ['Desk', 200]]
更多建議: