イントロダクション
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
インスタンスを返します。
コレクション生成
上記の通りcollect
ヘルパは指定された配列を元に、新しいIlluminate\Support\Collection
インスタンスを返します。ですからコレクションの生成も同様にシンプルです。
$collection = collect([1, 2, 3]);
Tip!! Eloquentクエリの結果は、常に
Collection
インスタンスを返します。
コレクションの拡張
実行時にCollection
クラスメソッドを追加できるように、コレクションは「マクロ使用可能」です。例として、Collection
クラスへtoUpper
メソッドを追加してみましょう。
use Illuminate\Support\Str;
Collection::macro('toUpper', function () {
return $this->map(function ($value) {
return Str::upper($value);
});
});
$collection = collect(['first', 'second']);
$upper = $collection->toUpper();
// ['FIRST', 'SECOND']
通常、サービスプロバイダの中で、コレクションマクロを定義します。
利用可能なメソッド
このドキュメントの残りで、Collection
クラスで使用できる各メソッドを解説します。これらのメソッドは、全て裏の配列をスラスラと操作するためにチェーンで繋げられることを覚えておきましょう。さらにほとんどのメソッドは、新しいCollection
インスタンスを返しますので、必要であればコレクションのオリジナルコピーを利用できるように変更しません。
メソッド一覧
all()
all
メソッドはコレクションの裏の配列表現を返します。
collect([1, 2, 3])->all();
// [1, 2, 3]
average()
avg
メソッドのエイリアスです。
avg()
avg
メソッドは、指定したキーの平均値を返します。
$average = collect([['foo' => 10], ['foo' => 10], ['foo' => 20], ['foo' => 40]])->avg('foo');
// 20
$average = collect([1, 1, 2, 4])->avg();
// 2
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]
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 ($value, $key) {
return $value > 5;
});
// false
contains
メソッドは、アイテムを「緩く」比較します。つまり、ある整数の文字列とその整数値は等値として扱います。「厳密」な比較を行いたい場合は、containsStrict
メソッドを使ってください。
containsStrict()
このメソッドは、contains
メソッドと使用方法は同じです。しかし、「厳密」な値の比較を行います。
count()
count
メソッドはコレクションのアイテム数を返します。
$collection = collect([1, 2, 3, 4]);
$collection->count();
// 4
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
メソッドを代わりに使用してください。
diff()
diff
メソッドはコレクションと、他のコレクションか一次元「配列」を値にもとづき比較します。このメソッドは指定されたコレクションに存在しない、オリジナルのコレクションの値を返します。
$collection = collect([1, 2, 3, 4, 5]);
$diff = $collection->diff([2, 4, 6, 8]);
$diff->all();
// [1, 3, 5]
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
メソッドはコレクションと、他のコレクションか一次元「配列」をキーで比較します。このメソッドは指定したコレクションに存在しない、オリジナルコレクション中のキー/値ペアを返します。
$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]
dump()
dump
メソッドはコレクションアイテムをダンプします。
$collection = collect(['John Doe', 'Jane Doe']);
$collection->dump();
/*
Collection {
#items: array:2 [
0 => "John Doe"
1 => "Jane Doe"
]
}
*/
コレクションをダンプした後にスクリプトを停止したい場合は、代わりにdd
メソッドを使用してください。
each()
each
メソッドはコレクションのアイテムを繰り返しで処理し、コールバックに各アイテムを渡します。
$collection->each(function ($item, $key) {
//
});
アイテム全体への繰り返しを停止したい場合は、false
をコールバックから返してください。
$collection->each(function ($item, $key) {
if (/* 条件 */) {
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
except()
except
メソッドは、キーにより指定したアイテム以外の全コレクション要素を返します。
$collection = collect(['product_id' => 1, 'price' => 100, 'discount' => false]);
$filtered = $collection->except(['price', 'discount']);
$filtered->all();
// ['product_id' => 1]
except
の正反対の機能は、onlyメソッドです。
filter()
filter
メソッドは指定したコールバックでコレクションをフィルタリングします。テストでtrueを返したアイテムだけが残ります。
$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]
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']
Note: 他のコレクションメソッドとは異なり、
forget
は更新された新しいコレクションを返しません。呼び出しもとのコレクションを更新します。
forPage()
forPage
メソッドは指定されたページ番号を表すアイテムで構成された新しいコレクションを返します。このメソッドは最初の引数にページ番号、2つ目の引数としてページあたりのアイテム数を受け取ります。
$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
オプションとして第2引数にデフォルト値を指定することもできます。
$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']);
$collection->has('product');
// true
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']
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]
isEmpty()
isEmpty
メソッドはコレクションが空の場合にtrue
を返します。そうでなければfalse
を返します。
collect([])->isEmpty();
// true
isNotEmpty()
isNotEmpty
メソッドは、コレクションが空でない場合にtrue
を返します。空であればfalse
を返します。
collect([])->isNotEmpty();
// false
keyBy()
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 ($value, $key) {
return $value < 3;
});
// 2
またはlast
メソッドを引数無しで呼び出し、コレクションの最後の要素を取得することもできます。コレクションが空の場合、null
が返ります。
collect([1, 2, 3, 4])->last();
// 4
macro()
staticのmacro
メソッドで、実行時にCollection
クラスへメソッドを追加できます。詳細は、コレクションの拡張ドキュメントを参照してください。
make()
staticのmake
メソッドは、新しいコレクションインスタンスを生成します。コレクションの生成セクションを参照してください。
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]
Note: 他のコレクションと同様に
map
は新しいコレクションインスタンスを返します。呼び出し元のコレクションは変更しません。もしオリジナルコレクションを変更したい場合はtransform
メソッドを使います。
mapInto()
mapInto()
メソッドはコレクションを繰り返し処理します。指定したクラスの新しいインスタンスを生成し、コンストラクタへ値を渡します。
class Currency
{
/**
* Create a new currency instance.
*
* @param string $code
* @return void
*/
function __construct(string $code)
{
$this->code = $code;
}
}
$collection = collect(['USD', 'EUR', 'GBP']);
$currencies = $collection->mapInto(Currency::class);
$currencies->all();
// [Currency('USD'), Currency('EUR'), Currency('GBP')]
mapSpread()
mapSpread
メソッドは指定したコールバックへ、コレクションのネストしたアイテム値をそれぞれ渡し、繰り返し処理します。値を変更した新しいコレクションを形成するために、コールバックで好きなようにアイテムを変更し、値を返してください。
$collection = collect([0, 1, 2, 3, 4, 5, 6, 7, 8, 9]);
$chunks = $collection->chunk(2);
$sequence = $chunks->mapSpread(function ($odd, $even) {
return $odd + $even;
});
$sequence->all();
// [1, 5, 9, 13, 17]
mapToGroups()
mapToGroups
メソッドは、指定したコールバックにより、コレクションアイテムを分類します。コールバックはキー/値ペアを一つ含む連想配列を返す必要があります。
$collection = collect([
[
'name' => 'John Doe',
'department' => 'Sales',
],
[
'name' => 'Jane Doe',
'department' => 'Sales',
],
[
'name' => 'Johnny Doe',
'department' => 'Marketing',
]
]);
$grouped = $collection->mapToGroups(function ($item, $key) {
return [$item['department'] => $item['name']];
});
$grouped->toArray();
/*
[
'Sales' => ['John Doe', 'Jane Doe'],
'Marketing' => ['Johhny Doe'],
]
*/
$grouped->get('Sales')->all();
// ['John Doe', 'Jane Doe']
mapWithKeys()
mapWithKeys
メソッドはコレクション全体を反復処理し、指定したコールバックへ各値を渡します。コールバックからキー/値ペアを一つ含む連想配列を返してください。
$collection = collect([
[
'name' => 'John',
'department' => 'Sales',
'email' => 'john@example.com'
],
[
'name' => 'Jane',
'department' => 'Marketing',
'email' => 'jane@example.com'
]
]);
$keyed = $collection->mapWithKeys(function ($item) {
return [$item['email'] => $item['name']];
});
$keyed->all();
/*
[
'john@example.com' => 'John',
'jane@example.com' => 'Jane',
]
*/
max()
max
メソッドは、指定したキーの最大値を返します。
$max = collect([['foo' => 10], ['foo' => 20]])->max('foo');
// 20
$max = collect([1, 2, 3, 4, 5])->max();
// 5
median()
median
メソッドは、指定したキーの中央値を返します。
$median = collect([['foo' => 10], ['foo' => 10], ['foo' => 20], ['foo' => 40]])->median('foo');
// 15
$median = collect([1, 1, 2, 4])->median();
// 1.5
merge()
merge
メソッドは、指定した配列かコレクションをオリジナルコレクションへマージします。指定した配列の文字列キーが、オリジナルコレクションの文字列キーと一致する場合、オリジナルコレクションの値は指定アイテムの値でオーバーライトされます。
$collection = collect(['product_id' => 1, 'price' => 100]);
$merged = $collection->merge(['price' => 200, 'discount' => false]);
$merged->all();
// ['product_id' => 1, price' => 200, 'discount' => false]
指定したアイテムのキーが数値の場合、コレクションの最後に追加されます。(訳注:数値でない場合の間違いか)
$collection = collect(['Desk', 'Chair']);
$merged = $collection->merge(['Bookcase', 'Door']);
$merged->all();
// ['Desk', 'Chair', 'Bookcase', 'Door']
min()
min
メソッドは、指定したキーの最小値を返します。
$min = collect([['foo' => 10], ['foo' => 20]])->min('foo');
// 10
$min = collect([1, 2, 3, 4, 5])->min();
// 1
mode()
mode
メソッドは、指定したキーの最頻値を返します。
$mode = collect([['foo' => 10], ['foo' => 10], ['foo' => 20], ['foo' => 40]])->mode('foo');
// [10]
$mode = collect([1, 1, 2, 4])->mode();
// [1]
nth()
nth
メソッドは指定数値間隔で要素を含む、新しいコレクションを生成します。
$collection = collect(['a', 'b', 'c', 'd', 'e', 'f']);
$collection->nth(4);
// ['a', 'e']
オプションとして第2引数にオフセットを渡せます。
$collection->nth(4, 1);
// ['b', 'f']
only()
only
メソッドは、コレクション中の指定したアイテムのみを返します。
$collection = collect(['product_id' => 1, 'name' => 'Desk', 'price' => 100, 'discount' => false]);
$filtered = $collection->only(['product_id', 'name']);
$filtered->all();
// ['product_id' => 1, 'name' => 'Desk']
only
の正反対の機能は、 exceptメソッドです。
pad()
pad
メソッドは、配列が指定したサイズに達するまで、指定値で配列を埋めます。このメソッドはarray_pad
PHP関数のような動作をします。
先頭を埋めるためには、サイズに負数を指定します。配列サイズ以下のサイズ値を指定した場合は、埋め込みを行いません。
$collection = collect(['A', 'B', 'C']);
$filtered = $collection->pad(5, 0);
$filtered->all();
// ['A', 'B', 'C', 0, 0]
$filtered = $collection->pad(-5, 0);
$filtered->all();
// [0, 0, 'A', 'B', 'C']
partition()
partition
メソッドは指定したテストの合否に要素を分け、結果をlist
PHP関数で受け取ります。
$collection = collect([1, 2, 3, 4, 5, 6]);
list($underThree, $aboveThree) = $collection->partition(function ($i) {
return $i < 3;
});
$underThree->all();
// [1, 2]
$aboveThree->all();
// [3, 4, 5, 6]
pipe()
pipe
メソッドはコレクションを指定したコールバックに渡し、結果を返します。
$collection = collect([1, 2, 3]);
$piped = $collection->pipe(function ($collection) {
return $collection->sum();
});
// 6
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']
重複するキーが存在している場合は、最後に一致した要素が結果のコレクションへ挿入されます。
$collection = collect([
['brand' => 'Tesla', 'color' => 'red'],
['brand' => 'Pagani', 'color' => 'white'],
['brand' => 'Tesla', 'color' => 'black'],
['brand' => 'Pagani', 'color' => 'orange'],
]);
$plucked = $collection->pluck('color', 'brand');
$plucked->all();
// ['Tesla' => 'black', 'Pagani' => 'orange']
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]
また、第2引数に追加するアイテムのキーを指定できます。
$collection = collect(['one' => 1, 'two' => 2]);
$collection->prepend(0, 'zero');
$collection->all();
// ['zero' => 0, 'one' => 1, 'two' => 2]
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 - (ランダムに取得)
オプションとして、random
にいくつのアイテムをランダムに取得するかを整数値で渡せます。受け取りたい数のアイテム数を明確に指定した場合、その数のコレクションのアイテムがいつも返されます。
$random = $collection->random(3);
$random->all();
// [2, 4, 5] - (ランダムに取得)
要求されたアイテム数がコレクションに足りない場合、このメソッドはInvalidArgumentException
を投げます。
reduce()
reduce
メソッドは繰り返しの結果を次の繰り返しに渡しながら、コレクションを単一値へ減らします。
$collection = collect([1, 2, 3]);
$total = $collection->reduce(function ($carry, $item) {
return $carry + $item;
});
// 6
最初の繰り返しの$carry
の値はnull
です。しかし初期値を設定したい場合は、reduce
の第2引数に渡してください。
$collection->reduce(function ($carry, $item) {
return $carry + $item;
}, 4);
// 10
reject()
reject
メソッドは指定したコールバックを使用し、コレクションをフィルタリングします。コールバックはコレクションの結果からアイテムを取り除く場合にtrue
を返します。
$collection = collect([1, 2, 3, 4]);
$filtered = $collection->reject(function ($value, $key) {
return $value > 2;
});
$filtered->all();
// [1, 2]
reject
メソッドの逆の働きについては、filter
メソッドを読んでください。
reverse()
reverse
メソッドはオリジナルのキーを保ったまま、コレクションのアイテムの順番を逆にします。
$collection = collect(['a', 'b', 'c', 'd', 'e']);
$reversed = $collection->reverse();
$reversed->all();
/*
[
4 => 'e',
3 => 'd',
2 => 'c',
1 => 'b',
0 => 'a',
]
*/
search()
search
メソッドは指定した値でコレクションをサーチし、見つけたキーを返します。アイテムが見つからない場合はfalse
を返します。
$collection = collect([2, 4, 6, 8]);
$collection->search(4);
// 1
検索は「緩い」比較で行われます。つまり、整数値を持つ文字列は、同じ値の整数と等しいと判断されます。「厳格」な比較を行いたい場合はtrue
をメソッドの第2引数に渡します。
$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] - (ランダムに生成される)
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]
切り分ける数を制限したい場合は、メソッドの第2引数で指定してください。
$slice = $collection->slice(4, 2);
$slice->all();
// [5, 6]
sliceメソッドはデフォルトでキー値を保持したまま返します。オリジナルのキーを保持したくない場合は、values
メソッドを使えば、インデックスし直されます。
sort()
sort
メソッドはコレクションをソートします。ソート済みコレクションはオリジナル配列のキーを保持しますので、以下の例では、values
メソッドにより、連続した数字のインデックスにするためリセットしています。
$collection = collect([5, 3, 1, 2, 4]);
$sorted = $collection->sort();
$sorted->values()->all();
// [1, 2, 3, 4, 5]
より高度なソートを行いたい場合はsort
にコールバックを渡し、自分のアルゴリズムを実行できます。コレクションのsort
メソッドが裏で呼び出しているuasort
のPHPドキュメントを参照してください。
Tip!! ネストした配列やオブジェクトのコレクションのソートは、
sortBy
とsortByDesc
メソッドを参照してください。
sortBy()
sortBy
メソッドは指定したキーでコレクションをソートします。ソート済みコレクションはオリジナル配列のキーを保持しますので、以下の例では、values
メソッドにより、連続した数字のインデックスにするためリセットしています。
$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],
]
*/
コレクション値をどのようにソートするかを決めるため、コールバックを渡すこともできます。
$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
と同じで、コレクションを逆順にソートします。
sortKeys()
sortKeys
メソッドは、内部の連想配列のキーにより、コレクションをソートします。
$collection = collect([
'id' => 22345,
'first' => 'John',
'last' => 'Doe',
]);
$sorted = $collection->sortKeys();
$sorted->all();
/*
[
'first' => 'John',
'id' => 22345,
'last' => 'Doe',
]
*/
sortKeysDesc()
このメソッドは、sortKeys
メソッドと使い方は同じですが、逆順にコレクションをソートします。
splice()
splice
メソッドは指定したインデックスからアイテムをスライスし、削除し、返します。
$collection = collect([1, 2, 3, 4, 5]);
$chunk = $collection->splice(2);
$chunk->all();
// [3, 4, 5]
$collection->all();
// [1, 2]
結果の塊の大きさを限定するために、第2引数を指定できます。
$collection = collect([1, 2, 3, 4, 5]);
$chunk = $collection->splice(2, 1);
$chunk->all();
// [3]
$collection->all();
// [1, 2, 4, 5]
さらに、コレクションから削除したアイテムに置き換える、新しいアイテムを第3引数に渡すこともできます。
$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]
split()
split
メソッドは、コレクションを指定数のグループへ分割します。
$collection = collect([1, 2, 3, 4, 5]);
$groups = $collection->split(3);
$groups->toArray();
// [[1, 2], [3, 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]
tap()
tap
メソッドは、指定されたコールバックへコレクションを渡します。コレクション自身に影響を与えることなく、その時点のコレクション内容を利用するために使用します。
collect([2, 4, 3, 1, 5])
->sort()
->tap(function ($collection) {
Log::debug('Values after sorting', $collection->values()->toArray());
})
->shift();
// 1
times()
静的times
メソッドは指定回数コールバックを呼び出すことで、新しいコレクションを生成します。
$collection = Collection::times(10, function ($number) {
return $number * 9;
});
$collection->all();
// [9, 18, 27, 36, 45, 54, 63, 72, 81, 90]
このメソッドはファクトリと組み合わせ、Eloquentモデルを生成する場合に便利です。
$categories = Collection::times(3, function ($number) {
return factory(Category::class)->create(['name' => 'Category #'.$number]);
});
$categories->all();
/*
[
['id' => 1, 'name' => 'Category #1'],
['id' => 2, 'name' => 'Category #2'],
['id' => 3, 'name' => 'Category #3'],
]
*/
toArray()
toArray
メソッドはコレクションをPHPの「配列」へ変換します。コレクションの値がEloquentモデルの場合は、そのモデルが配列に変換されます。
$collection = collect(['name' => 'Desk', 'price' => 200]);
$collection->toArray();
/*
[
['name' => 'Desk', 'price' => 200],
]
*/
Note:
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]
Note: 他のコレクションメソッドとは異なり、
transform
はコレクション自身を更新します。代わりに新しいコレクションを生成したい場合は、map
メソッドを使用してください。
union()
union
メソッドは指定した配列をコレクションへ追加します。既にコレクションにあるキーが、オリジナル配列に含まれている場合は、オリジナルコレクションの値が優先されます。
$collection = collect([1 => ['a'], 2 => ['b']]);
$union = $collection->union([3 => ['c'], 1 => ['b']]);
$union->all();
// [1 => ['a'], 2 => ['b'], 3 => ['c']]
unique()
unique
メソッドはコレクションの重複を取り除いた全アイテムを返します。ソート済みのコレクションはオリジナルの配列キーを保っています。下の例ではvalues
メソッドで連続した数字のインデックスにするためリセットしています。
$collection = collect([1, 1, 2, 2, 3, 4, 2]);
$unique = $collection->unique();
$unique->values()->all();
// [1, 2, 3, 4]
ネストした配列やオブジェクトを取り扱いたい場合は、一意であることを決めるキーを指定する必要があります。
$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'],
]
*/
unique
メソッドは、アイテムの判定に「緩い」比較を使用します。つまり、同じ値の文字列と整数値は等しいと判定します。「厳密」な比較でフィルタリングしたい場合は、uniqueStrict
メソッドを使用してください。
uniqueStrict()
このメソッドは、unique
と同じ使用方法です。しかし、全値は「厳密」に比較されます。
unless()
unless
メソッドは最初の引数がtrue
と評価されなくなるまで、コールバックを実行します。
$collection = collect([1, 2, 3]);
$collection->unless(true, function ($collection) {
return $collection->push(4);
});
$collection->unless(false, function ($collection) {
return $collection->push(5);
});
$collection->all();
// [1, 2, 3, 5]
unless
の逆の動作は、when
メソッドです。
unwrap()
staticのunwrap
メソッドは適用可能な場合、指定値からコレクションの元になっているアイテムを返します。
Collection::unwrap(collect('John Doe'));
// ['John Doe']
Collection::unwrap(['John Doe']);
// ['John Doe']
Collection::unwrap('John Doe');
// 'John Doe'
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],
]
*/
when()
when
メソッドは、メソッドの第1引数がtrue
に評価される場合、コールバックを実行します。
$collection = collect([1, 2, 3]);
$collection->when(true, function ($collection) {
return $collection->push(4);
});
$collection->when(false, function ($collection) {
return $collection->push(5);
});
$collection->all();
// [1, 2, 3, 4]
when
の逆の動作は、unless
メソッドです。
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
メソッドはアイテム値の確認を「緩く」比較します。つまり、同じ値の文字列と整数値は、同値と判断します。「厳格」な比較でフィルタリングしたい場合は、whereStrict
メソッドを使ってください。
whereStrict()
このメソッドの使用法は、where
メソッドと同じです。しかし、値の比較はすべて「厳格」な比較で行われます。
whereIn()
whereIn
メソッドは指定された配列に含まれる値/キーにより、コレクションをフィルタリングします。
$collection = collect([
['product' => 'Desk', 'price' => 200],
['product' => 'Chair', 'price' => 100],
['product' => 'Bookcase', 'price' => 150],
['product' => 'Door', 'price' => 100],
]);
$filtered = $collection->whereIn('price', [150, 200]);
$filtered->all();
/*
[
['product' => 'Bookcase', 'price' => 150],
['product' => 'Desk', 'price' => 200],
]
*/
whereIn
メソッドはアイテム値のチェックを「緩く」比較します。つまり同じ値の文字列と整数値は同値と判定します。「厳密」な比較でフィルタリングしたい場合は、whereInStrict
メソッドを使ってください。
whereInStrict()
このメソッドの使い方は、whereIn
メソッドと同じです。違いは全値を「厳密」に比較することです。
whereInstanceOf()
whereInstanceOf
メソッドは、コレクションを指定したクラスタイプによりフィルタリングします。
$collection = collect([
new User,
new User,
new Post,
]);
return $collection->whereInstanceOf(User::class);
whereNotIn()
whereNotIn
メソッドは、指定した配列中のキー/値を含まないコレクションをフィルタリングします。
$collection = collect([
['product' => 'Desk', 'price' => 200],
['product' => 'Chair', 'price' => 100],
['product' => 'Bookcase', 'price' => 150],
['product' => 'Door', 'price' => 100],
]);
$filtered = $collection->whereNotIn('price', [150, 200]);
$filtered->all();
/*
[
['product' => 'Chair', 'price' => 100],
['product' => 'Door', 'price' => 100],
]
*/
whereNotIn
メソッドは、値を「緩く」比較します。つまり、同じ値の文字列と整数は、同値と判定されます。「厳密」にフィルタリングしたい場合は、whereNotInStrict
メソッドを使用します。
whereNotInStrict()
このメソッドは、whereNotIn
と使い方は同じですが、全値の比較が「厳密」に行われる点が異なります。
wrap()
staticのwrap
メソッドは適用可能であれば、指定値をコレクションでラップします。
$collection = Collection::wrap('John Doe');
$collection->all();
// ['John Doe']
$collection = Collection::wrap(['John Doe']);
$collection->all();
// ['John Doe']
$collection = Collection::wrap(collect('John Doe'));
$collection->all();
// ['John Doe']
zip()
zip
メソッドは指定した配列の値と、対応するインデックスのオリジナルコレクションの値をマージします。
$collection = collect(['Chair', 'Desk']);
$zipped = $collection->zip([100, 200]);
$zipped->all();
// [['Chair', 100], ['Desk', 200]]
Higher Order Message
コレクションで繁用するアクションを手短に実行できるよう、"higher order
messages"をサポートしました。average
、avg
、contains
、each
、every
、filter
、first
、flatMap
、groupBy
、keyBy
、map
、max
、min
、partition
、reject
、sortBy
、sortByDesc
、sum
、unique
コレクションメソッドでhigher
order messageが使用できます。
各higher order
messageへは、コレクションインスタンスの動的プロパティとしてアクセスできます。例として、コレクション中の各オブジェクトメソッドを呼び出す、each
higher order messageを使用してみましょう。
$users = User::where('votes', '>', 500)->get();
$users->each->markAsVip();
同様に、ユーザーのコレクションに対し、「投票(votes)」の合計数を求めるために、sum
higher order messageを使用できます。
$users = User::where('group', 'Development')->get();
return $users->sum->votes;