laravel collection
1、簡介
Illuminate\Support\Collection
類為處理陣列資料提供了平滑、方便的封裝。例如,檢視下面的程式碼,我們使用幫助函式collect
建立一個新的集合例項,為每一個元素執行strtoupper
函式,然後移除所有空元素:
$collection = collect(['taylor', 'abigail', null])->map(function ($name) { return strtoupper($name); })->reject(function ($name) { return empty($name); });
正如你所看到的,Collection
類允許你使用方法鏈對底層陣列執行匹配和減少操作,通常,沒個Collection
方法都會返回一個新的Collection
例項。
2、建立集合
正如上面所提到的,幫助函式collect
為給定陣列返回一個新的Illuminate\Support\Collection
例項,所以,建立集合很簡單:
$collection = collect([1, 2, 3]);
預設情況下,Eloquent模型的集合總是返回Collection
例項,此外,不管是在何處,只要方法都可以自由使用Collection
類。
3、集合方法列表
本文件接下來的部分我們將會討論Collection
Collection
例項,允許你在必要的時候保持原來的集合備份。
all()
all
方法簡單返回集合表示的底層陣列:
collect([1, 2, 3])->all(); // [1, 2, 3]
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]
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
count()
count
方法返回集合中所有項的數目:
$collection = collect([1, 2, 3, 4]); $collection->count(); // 4
diff()
diff
方法將集合和另一個集合或原生PHP陣列作比較:
$collection = collect([1, 2, 3, 4, 5]); $diff = $collection->diff([2, 4, 6, 8]); $diff->all(); // [1, 3, 5]
each()
each
方法迭代集合中的資料項並傳遞每個資料項到給定回撥:
$collection = $collection->each(function ($item, $key) { // });
回撥返回false
將會終止迴圈:
$collection = $collection->each(function ($item, $key) { if (/* some condition */) { return false; } });
filter()
filter
方法通過給定回撥過濾集合,只有通過給定測試的資料項才會保留下來:
$collection = collect([1, 2, 3, 4]); $filtered = $collection->filter(function ($item) { return $item > 2; }); $filtered->all(); // [3, 4]
和filter
相反的方法是reject
。
first()
first
方法返回通過測試集合的第一個元素:
collect([1, 2, 3, 4])->first(function ($key, $value) { return $value > 2; }); // 3
你還可以呼叫不帶引數的first
方法來獲取集合的第一個元素,如果集合是空的,返回null:
collect([1, 2, 3, 4])->first(); // 1
flatten()
flatten
方法將多維度的集合變成一維的:
$collection = collect(['name' => 'taylor', 'languages' => ['php', 'javascript']]); $flattened = $collection->flatten(); $flattened->all(); // ['taylor', 'php', 'javascript'];
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])->forPage(2, 3); $collection->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'], ], ] */
has()
has
方法判斷給定鍵是否在集合中存在:
-
$collection = collect(['account_id' => 1, 'product' => 'Desk']);
-
$collection->has('email');
-
// 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']
正如你所看到的,結果集合只保持原來集合的鍵。
isEmpty()
如果集合為空的話isEmpty
方法返回true
;否則返回false
:
-
collect([])->isEmpty();
-
// true
keyBy()
將指定鍵的值作為集合的鍵:
-
$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()
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()
last
方法返回通過測試的集合的最後一個元素:
-
collect([1, 2, 3, 4])->last(function ($key, $value) {
-
return $value < 3;
-
});
-
// 2
還可以呼叫無參的last
方法來獲取集合的最後一個元素。如果集合為空。返回null:
-
collect([1, 2, 3, 4])->last();
-
// 4
map()
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()
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()
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()
pop
方法移除並返回集合中最後面的資料項:
-
$collection = collect([1, 2, 3, 4, 5]);
-
$collection->pop();
-
// 5
-
$collection->all();
-
// [1, 2, 3, 4]
prepend()
prepend
方法新增資料項到集合開頭:
-
$collection = collect([1, 2, 3, 4, 5]);
-
$collection->prepend(0);
-
$collection->all();
-
// [0, 1, 2, 3, 4, 5]
pull()
pull
方法通過鍵從集合中移除並返回資料項:
-
$collection = collect(['product_id' => 'prod-100', 'name' => 'Desk']);
-
$collection->pull('name');
-
// 'Desk'
-
$collection->all();
-
// ['product_id' => 'prod-100']
push()
push
方法附加資料項到集合結尾:
-
$collection = collect([1, 2, 3, 4]);
-
$collection->push(5);
-
$collection->all();
-
// [1, 2, 3, 4, 5]
put()
put
方法在集合中設定給定鍵和值:
-
$collection = collect(['product_id' => 1, 'name' => 'Desk']);
-
$collection->put('price', 100);
-
$collection->all();
-
// ['product_id' => 1, 'name' => 'Desk', 'price' => 100]
random()
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()
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()
reject方法使用給定回撥過濾集合,該回調應該為所有它想要從結果集合中移除的資料項返回true:
-
$collection = collect([1, 2, 3, 4]);
-
$filtered = $collection->reject(function ($item) {
-
return $item > 2;
-
});
-
$filtered->all();
-
// [1, 2]
和reduce
方法相對的方法是filter方法。
reverse()
reverse
方法將集合資料項的順序顛倒:
-
$collection = collect([1, 2, 3, 4, 5]);
-
$reversed = $collection->reverse();
-
$reversed->all();
-
// [5, 4, 3, 2, 1]
search()
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()
shift
方法從集合中移除並返回第一個資料項:
-
$collection = collect([1, 2, 3, 4, 5]);
-
$collection->shift();
-
// 1
-
$collection->all();
-
// [2, 3, 4, 5]
shuffle()
shuffle
方法隨機打亂集合中的資料項:
-
$collection = collect([1, 2, 3, 4, 5]);
-
$shuffled = $collection->shuffle();
-
$shuffled->all();
-
// [3, 2, 5, 1, 4] // (generated randomly)
slice()
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()
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()
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']],
-
]
-
*/
sortByDesc()
該方法和 sortBy
用法相同,不同之處在於按照相反順序進行排序。
splice()
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()
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()
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()
toArray
方法將集合轉化為一個原生的PHP陣列。如果集合的值是Eloquent模型,該模型也會被轉化為陣列:
-
$collection = collect(['name' => 'Desk', 'price' => 200]);
-
$collection->toArray();
-
/*
-
[
-
['name' => 'Desk', 'price' => 200],
-
]
-
*/
注意:toArray
還將所有巢狀物件轉化為陣列。如果你想要獲取底層陣列,使用all
方法。
toJson()
toJson
方法將集合轉化為JSON:
-
$collection = collect(['name' => 'Desk', 'price' => 200]);
-
$collection->toJson();
-
// '{"name":"Desk","price":200}'
transform()
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()
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()
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()
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方法過濾鬆散約束。
whereLoose()
該方法和where
使用方法相同,不同之處在於whereLoose
在比較值的時候使用鬆散約束。
zip()
zip
方法在於集合的值相應的索引處合併給定陣列的值:
-
$collection = collect(['Chair', 'Desk']);
-
$zipped = $collection->zip([100, 200]);
-
$zipped->all();
-
// [['Chair', 100], ['Desk', 200]