Laravel の Collection について

Laravel の使える機能の一つが Collection (コレクション) です。

PHP のプログラミングは「配列だらけ」と言われるとおり、配列操作がとても多いです。

Laravel の Collection はその 手間を軽減しますが、同時にコード量が減って見通しもよくなるためメリットが多い と感じます。
実際ほぼ Collection で OK な感じがしますね。

たとえば、どんな

「ユーザテーブルを SELECE して ID 一覧を取得したい」とします。

よくある PHP のコードは次のようになりますね。

$users = User::all();

$userIds = [];
foreach ($users as $user) {
    $userIds[] = $user->id;
}

Collection に置き換えるとこうなります。

$users = User::all();
$userIds = $users->pluck('id');

Laravel の Eloquent ORM では問い合わせ結果を Collection に詰めて返却します。

無名関数を組み合わせて

Collection は、メソッドの引数に無名関数を渡すことができます。

$sortedEntities = $entities->sort(function($first, $second) {
     return $first->price <=> $second->price
         ?: $second->id   <=> $first->id;
  });

無名関数を併用すると、さらに柔軟なコーディングができます。

ドキュメント

Laravel 5.5 Collections
https://laravel.com/docs/5.5/collections

メソッド紹介

コレクションはメソッドがとても豊富です。
ここでは私がよく使うものをピックアップいたします。

また、以下に示すサンプルは大部分を上記ドキュメントから引用いたします。

contains

contains メソッドは「指定したアイテムがコレクションに含まれているか」を判定します。

$collection = collect(['name' => 'Desk', 'price' => 100]);

$collection->contains('Desk');

// true

連想配列の value を調べていますね。 配列の形に注意が必要そうです。

where

where メソッドは「指定した key/value のペア」でコレクションをフィルタリングします。

$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],
    ]
*/

これは DB 操作と近い感覚ですね。

take / slice

take は先頭から n個 のコレクションを返します。

$collection = collect([0, 1, 2, 3, 4, 5]);

$chunk = $collection->take(3);

$chunk->all();

// [0, 1, 2]

n を負で指定した場合は後ろから n個 の要素を返します。


おなじようなメソッドに 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]

第二引数を与えた場合、指定値から n件 を返します。

$slice = $collection->slice(4, 2);

$slice->all();

// [5, 6]

chunk

chunk は「コレクションを固まりごと」に操作します。

$collection = collect([1, 2, 3, 4, 5, 6, 7]);

$chunks = $collection->chunk(4);

$chunks->toArray();

// [[1, 2, 3, 4], [5, 6, 7]]

メモリサイズを気にする場合など、小さなブロックごとに処理できるのでいい感じです。

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'],
    ]
*/

私は ID をキーとしたマップを作る場合に多用します。

keyBy は「 1 対 1 」の関係を表現するため、 同じキーが存在する場合に、上書きされてしまう 点に注意が必要です。 Key の重複がある場合は groupBy を使います。

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'],
        ],
    ]
*/

groupBy は「 1 対多」の関係を表現するため、keyBy とはデータ構造が異なり、子が深くなる点に注意が必要です。

pluck

pluck は「指定したキーの全コレクション値」を取得します。

$collection = collect([
    ['product_id' => 'prod-100', 'name' => 'Desk'],
    ['product_id' => 'prod-200', 'name' => 'Chair'],
]);

$plucked = $collection->pluck('name');

$plucked->all();

// ['Desk', 'Chair']

テーブルの SELECT 結果から ID の配列を取るような時に多用します。

Laravel ではないプロジェクトに導入する

Laravel ではないプロジェクトでも Collection は利用できます。

illuminate/support
https://github.com/illuminate/support

次のように Composer コマンドでパッケージをインストールしてくださいね。

composer require illuminate/support

おわりに

今回ご紹介した他にも、追加、削除、集計関数、差分、コールバック、一次元化 (構造変更)など、提供される機能は多岐にわたっています。

Collection をうまく使いこなせると、簡潔で見やすいソースを書くことができます。
快感です。

便利な Collection をぜひ触ってみてください。

PHPフレームワーク Laravel入門

掌田津耶乃
出版社:秀和システム  発売日:2017-09-16

Amazonで詳細を見る

この記事の著者 Webrow (うぇぶろう)
Web アプリ開発、 Web 顧問 エンジニア、WordPress サポートいたします。