Illuminate\Support\Collection
類爲處理數組數據提供了平滑、方便的封裝。例如,查看下面的代碼,咱們使用幫助函數collect
建立一個新的集合實例,爲每個元素運行strtoupper
函數,而後移除全部空元素:javascript
$collection = collect(['taylor', 'abigail', null])->map(function ($name) { return strtoupper($name); })->reject(function ($name) { return empty($name); });
正如你所看到的,Collection
類容許你使用方法鏈對底層數組執行匹配和減小操做,一般,沒個Collection
方法都會返回一個新的Collection
實例。php
正如上面所提到的,幫助函數collect
爲給定數組返回一個新的Illuminate\Support\Collection
實例,因此,建立集合很簡單:css
$collection = collect([1, 2, 3]);
默認狀況下,Eloquent模型的集合老是返回Collection
實例,此外,不論是在何處,只要方法均可以自由使用Collection
類。html
本文檔接下來的部分咱們將會討論Collection
類上每個有效的方法,全部這些方法均可以以方法鏈的方式平滑的操做底層數組。此外,幾乎每一個方法返回一個新的Collection
實例,容許你在必要的時候保持原來的集合備份。java
all
方法簡單返回集合表示的底層數組:laravel
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]]
當處理柵欄系統如Bootstrap時該方法在視圖中尤爲有用,建設你有一個想要顯示在柵欄中的Eloquent模型集合:bootstrap
@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
方法將一個多維數組集合收縮成一個一維數組:數組
$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
方法判斷集合是否包含一個給定項:dom
$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
count
方法返回集合中全部項的數目:
$collection = collect([1, 2, 3, 4]); $collection->count(); // 4
diff
方法將集合和另外一個集合或原生PHP數組做比較:
$collection = collect([1, 2, 3, 4, 5]); $diff = $collection->diff([2, 4, 6, 8]); $diff->all(); // [1, 3, 5]
each
方法迭代集合中的數據項並傳遞每一個數據項到給定回調:
$collection = $collection->each(function ($item, $key) { // });
回調返回false
將會終止循環:
$collection = $collection->each(function ($item, $key) { if (/* some condition */) { return false; } });
filter
方法經過給定回調過濾集合,只有經過給定測試的數據項纔會保留下來:
$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
你還能夠調用不帶參數的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
方法經過鍵從集合中移除數據項:
$collection = collect(['name' => 'taylor', 'framework' => 'laravel']); $collection->forget('name'); $collection->all(); // [framework' => 'laravel']
注意:不一樣於大多數的集合方法,forget
不返回新的修改過的集合;它只修改所調用的集合。
forPage
方法返回新的包含給定頁數數據項的集合:
$collection = collect([1, 2, 3, 4, 5, 6, 7, 8, 9])->forPage(2, 3); $collection->all(); // [4, 5, 6]
該方法須要傳入頁數和每頁顯示數目參數。
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
方法經過給定鍵分組集合數據項:
$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'], ], ] */
has
方法判斷給定鍵是否在集合中存在:
$collection = collect(['account_id' => 1, 'product' => 'Desk']);
$collection->has('email');
// false
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
方法返回兩個集合的交集:
$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'],
]
*/
若是多個數據項有同一個鍵,只有最後一個會出如今新的集合中。
你能夠傳遞本身的回調,將會返回通過處理的鍵的值做爲新的鍵:
$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
還能夠調用無參的last
方法來獲取集合的最後一個元素。若是集合爲空。返回null:
collect([1, 2, 3, 4])->last();
// 4
map
方法遍歷集合並傳遞每一個值給給定回調。該回調能夠修改數據項並返回,從而生成一個新的通過修改的集合:
$collection = collect([1, 2, 3, 4, 5]);
$multiplied = $collection->map(function ($item, $key) {
return $item * 2;
});
$multiplied->all();
// [2, 4, 6, 8, 10]
注意:和大多數集合方法同樣,map
返回新的集合實例;它並不修改所調用的實例。若是你想要改變原來的集合,使用
方法。transform
merge
方法合併給定數組到集合。該數組中的任何字符串鍵匹配集合中的字符串鍵的將會重寫集合中的值:
$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]
若是給定數組的鍵是數字,數組的值將會附加到集合後面:
$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
方法移除並返回集合中最後面的數據項:
$collection = collect([1, 2, 3, 4, 5]);
$collection->pop();
// 5
$collection->all();
// [1, 2, 3, 4]
prepend
方法添加數據項到集合開頭:
$collection = collect([1, 2, 3, 4, 5]);
$collection->prepend(0);
$collection->all();
// [0, 1, 2, 3, 4, 5]
pull
方法經過鍵從集合中移除並返回數據項:
$collection = collect(['product_id' => 'prod-100', 'name' => 'Desk']);
$collection->pull('name');
// 'Desk'
$collection->all();
// ['product_id' => 'prod-100']
push
方法附加數據項到集合結尾:
$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
方法從集合中返回隨機數據項:
$collection = collect([1, 2, 3, 4, 5]);
$collection->random();
// 4 - (retrieved randomly)
你能夠傳遞一個整型數據到random
函數,若是該整型數值大於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;然而,你能夠經過傳遞第二個參數到reduce
來指定其初始值:
$collection->reduce(function ($carry, $item) {
return $carry + $item;
}, 4);
// 10
reject方法使用給定回調過濾集合,該回調應該爲全部它想要從結果集合中移除的數據項返回true:
$collection = collect([1, 2, 3, 4]);
$filtered = $collection->reject(function ($item) {
return $item > 2;
});
$filtered->all();
// [1, 2]
和reduce
方法相對的方法是filter方法。
reverse
方法將集合數據項的順序顛倒:
$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
做爲第二個參數到該方法:
$collection->search('4', true);
// false
此外,你還能夠傳遞本身的回調來搜索經過測試的第一個數據項:
$collection->search(function ($item, $key) {
return $item > 5;});
// 2
shift
方法從集合中移除並返回第一個數據項:
$collection = collect([1, 2, 3, 4, 5]);
$collection->shift();
// 1
$collection->all();
// [2, 3, 4, 5]
shuffle
方法隨機打亂集合中的數據項:
$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]
若是你想要限制返回切片的尺寸,將尺寸值做爲第二個參數傳遞到該方法:
$slice = $collection->slice(4, 2);
$slice->all();
// [5, 6]
返回的切片有新的、數字化索引的鍵,若是你想要保持原有的鍵,能夠傳遞第三個參數true到該方法。
sort
方法對集合進行排序:
$collection = collect([5, 3, 1, 2, 4]);
$sorted = $collection->sort();
$sorted->values()->all();
// [1, 2, 3, 4, 5]
排序後的集合保持原來的數組鍵,在本例中咱們使用values
方法重置鍵爲連續編號索引。
要爲嵌套集合和對象排序,查看sortBy
和sortByDesc
方法。
若是你須要更加高級的排序,你可使用本身的算法傳遞一個回調給sort
方法。參考PHP官方文檔關於 usort
的說明,sort方法底層正是調用了該方法。
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],
]
*/
排序後的集合保持原有數組索引,在本例中,使用values
方法重置鍵爲連續索引。
你還能夠傳遞本身的回調來判斷如何排序集合的值:
$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
用法相同,不一樣之處在於按照相反順序進行排序。
splice
方法在從給定位置開始移除並返回數據項切片:
$collection = collect([1, 2, 3, 4, 5]);
$chunk = $collection->splice(2);
$chunk->all();
// [3, 4, 5]
$collection->all();
// [1, 2]
你能夠傳遞參數來限制返回組塊的大小:
$collection = collect([1, 2, 3, 4, 5]);
$chunk = $collection->splice(2, 1);
$chunk->all();
// [3]
$collection->all();
// [1, 2, 4, 5]
此外,你能夠傳遞第三個參數來包含新的數據項來替代從集合中移除的數據項:
$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
方法返回集合中全部數據項的和:
collect([1, 2, 3, 4, 5])->sum();
// 15
若是集合包含嵌套數組或對象,應該傳遞一個鍵用於判斷對哪些值進行求和運算:
$collection = collect([
['name' => 'JavaScript: The Good Parts', 'pages' => 176],
['name' => 'JavaScript: The Definitive Guide', 'pages' => 1096],
]);
$collection->sum('pages');
// 1272
此外,你還能夠傳遞本身的回調來判斷對哪些值進行求和:
$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
方法使用指定數目的數據項返回一個新的集合:
$collection = collect([0, 1, 2, 3, 4, 5]);
$chunk = $collection->take(3);
$chunk->all();
// [0, 1, 2]
你還能夠傳遞負數從集合末尾開始獲取指定數目的數據項:
$collection = collect([0, 1, 2, 3, 4, 5]);
$chunk = $collection->take(-2);
$chunk->all();
// [4, 5]
toArray
方法將集合轉化爲一個原生的PHP數組。若是集合的值是Eloquent模型,該模型也會被轉化爲數組:
$collection = collect(['name' => 'Desk', 'price' => 200]);
$collection->toArray();
/*
[
['name' => 'Desk', 'price' => 200],
]
*/
注意:toArray
還將全部嵌套對象轉化爲數組。若是你想要獲取底層數組,使用all
方法。
toJson
方法將集合轉化爲JSON:
$collection = collect(['name' => 'Desk', 'price' => 200]);
$collection->toJson();
// '{"name":"Desk","price":200}'
transform
方法迭代集合並對集合中每一個數據項調用給定回調。集合中的數據項將會被替代成從回調中返回的值:
$collection = collect([1, 2, 3, 4, 5]);
$collection->transform(function ($item, $key) {
return $item * 2;
});
$collection->all();
// [2, 4, 6, 8, 10]
注意:不一樣於大多數其它集合方法,transform
修改集合自己,若是你想要建立一個新的集合,使用map方法。
unique
方法返回集合中全部的惟一數據項:
$collection = collect([1, 1, 2, 2, 3, 4, 2]);
$unique = $collection->unique();
$unique->values()->all();
// [1, 2, 3, 4]
返回的集合保持原來的數組鍵,在本例中咱們使用values方法重置這些鍵爲連續的數字索引。
處理嵌套數組或對象時,能夠指定用於判斷惟一的鍵:
$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'],
]
*/
你還能夠指定本身的回調用於判斷數據項惟一性:
$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
方法使用重置爲連續整型數字的鍵返回新的集合:
$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],
]
*/
檢查數據項值時where
方法使用嚴格條件約束。使用whereLoose方法過濾鬆散約束。
該方法和where
使用方法相同,不一樣之處在於whereLoose
在比較值的時候使用鬆散約束。
zip
方法在於集合的值相應的索引處合併給定數組的值:
$collection = collect(['Chair', 'Desk']);
$zipped = $collection->zip([100, 200]);
$zipped->all();
// [['Chair', 100], ['Desk', 200]]