イントロダクション
get
メソッドであれリレーションによるものであれ、Eloquentが複数のレコードをリターンする場合Illuminate\Database\Eloquent\Collection
オブジェクトが返されます。EloquentコレクションオブジェクトはLaravelのベースコレクションを継承しているので、Eloquentモデルの裏にある配列をスムーズに操作するために継承した多くのメソッドがもちろん使用できます。
当然ながら全コレクションはイテレーターとしても動作し、シンプルなPHP配列のようにループで取り扱うことができます。
$users = App\User::where('active', 1)->get();
foreach ($users as $user) {
echo $user->name;
}
しかし、コレクションは配列よりもパワフルで直感的なインターフェイスを使ったメソッドチェーンにより、マッピングや要素の省略操作を行うことができます。例としてアクティブでないモデルを削除し、残ったユーザーのファーストネームを集めてみましょう。
$users = App\User::all();
$names = $users->reject(function ($user) {
return $user->active === false;
})
->map(function ($user) {
return $user->name;
});
Note: ほとんどのEloquentコレクションは新しいEloquentコレクションのインスタンスを返しますが、
pluck
、keys
、zip
、collapse
、flatten
、flip
メソッドはベースのコレクションインスタンスを返します。Eloquentモデルをまったく含まないコレクションを返すmap
操作のような場合、自動的にベースコレクションへキャストされます。
使用できるメソッド
ベースのコレクション
全EloquentコレクションはベースのLaravelコレクションオブジェクトを拡張しており、そのためにベースコレクションクラスが提供しているパワフルなメソッドを全部継承しています。
カスタムコレクション
自分で拡張したメソッドを含むカスタム「コレクション」オブジェクトを使いたい場合は、モデルのnewCollection
メソッドをオーバーライドしてください。
<?php
namespace App;
use App\CustomCollection;
use Illuminate\Database\Eloquent\Model;
class User extends Model
{
/**
* 新しいEloqunetコレクションインスタンスの生成
*
* @param array $models
* @return \Illuminate\Database\Eloquent\Collection
*/
public function newCollection(array $models = [])
{
return new CustomCollection($models);
}
}
newCollection
メソッドを定義すれば、Eloquentがそのモデルの「コレクション」インスタンスを返す場合にいつでもカスタムコレクションのインスタンスを受け取れます。アプリケーションの全モデルでカスタムコレクションを使いたい場合は、全モデルが拡張しているモデルのベースクラスでnewCollection
メソッドをオーバーライドしてください。