はじめに

複数のモデル結果を返すすべてのEloquentメソッドは、Illuminate\Database\Eloquent\Collectionクラスのインスタンスを返します。これは、getメソッドを介して取得された結果や、リレーションシップを介してアクセスされた結果を含みます。EloquentコレクションオブジェクトはLaravelの基本コレクションを拡張しているため、Eloquentモデルの基礎となる配列を流暢に操作するために使用される数十のメソッドを自然に継承します。これらの便利なメソッドについて学ぶために、Laravelコレクションのドキュメントを確認してください！

すべてのコレクションはイテレータとしても機能し、単純なPHP配列のようにループすることができます： 

  1. use App\Models\User;
  3. $users = User::where('active', 1)->get();
  5. foreach ($users as $user) {
  6.    echo $user->name;
  7. }

しかし、前述のように、コレクションは配列よりもはるかに強力で、直感的なインターフェースを使用してチェーン可能なさまざまなマップ/リデュース操作を公開します。たとえば、すべての非アクティブモデルを削除し、残りの各ユーザーのファーストネームを収集することができます： 

  1. $names = User::all()->reject(function (User $user) {
  2.    return $user->active === false;
  3. })->map(function (User $user) {
  4.    return $user->name;
  5. });

Eloquentコレクションの変換

ほとんどのEloquentコレクションメソッドは新しいEloquentコレクションのインスタンスを返しますが、collapse、flatten、flip、keys、pluck、およびzipメソッドは基本コレクションのインスタンスを返します。同様に、map操作がEloquentモデルを含まないコレクションを返す場合、それは基本コレクションインスタンスに変換されます。

利用可能なメソッド

すべてのEloquentコレクションは基本のLaravelコレクションオブジェクトを拡張しているため、基本コレクションクラスによって提供されるすべての強力なメソッドを継承します。

さらに、Illuminate\Database\Eloquent\Collectionクラスはモデルコレクションの管理を支援するためのメソッドのスーパーセットを提供します。ほとんどのメソッドはIlluminate\Database\Eloquent\Collectionインスタンスを返しますが、modelKeysのような一部のメソッドはIlluminate\Support\Collectionインスタンスを返します。

append contains diff except find findOrFail fresh intersect load loadMissing modelKeys makeVisible makeHidden only setVisible setHidden toQuery unique

append($attributes)

  3. ``````php
  4. $users->append('team');
  6. $users->append(['team', 'is_admin']);
  7. `

contains($key, $operator = null, $value = null)

  3. ``````php
  4. $users->contains(1);
  6. $users->contains(User::find(1));
  7. `

diff($items)

  3. ``````php
  4. use App\Models\User;
  6. $users = $users->diff(User::whereIn('id', [1, 2, 3])->get());
  7. `

except($keys)

  3. ``````php
  4. $users = $users->except([1, 2, 3]);
  5. `

find($key)

  3. ``````php
  4. $users = User::all();
  6. $user = $users->find(1);
  7. `

findOrFail($key)

  3. ``````php
  4. $users = User::all();
  6. $user = $users->findOrFail(1);
  7. `

fresh($with = [])

  3. ``````php
  4. $users = $users->fresh();
  6. $users = $users->fresh('comments');
  7. `

intersect($items)

  3. ``````php
  4. use App\Models\User;
  6. $users = $users->intersect(User::whereIn('id', [1, 2, 3])->get());
  7. `

load($relations)

  3. ``````php
  4. $users->load(['comments', 'posts']);
  6. $users->load('comments.author');
  8. $users->load(['comments', 'posts' => fn ($query) => $query->where('active', 1)]);
  9. `

loadMissing($relations)

  3. ``````php
  4. $users->loadMissing(['comments', 'posts']);
  6. $users->loadMissing('comments.author');
  8. $users->loadMissing(['comments', 'posts' => fn ($query) => $query->where('active', 1)]);
  9. `

modelKeys()

  3. ``````php
  4. $users->modelKeys();
  6. // [1, 2, 3, 4, 5]
  7. `

makeVisible($attributes)

  3. ``````php
  4. $users = $users->makeVisible(['address', 'phone_number']);
  5. `

makeHidden($attributes)

  3. ``````php
  4. $users = $users->makeHidden(['address', 'phone_number']);
  5. `

only($keys)

  3. ``````php
  4. $users = $users->only([1, 2, 3]);
  5. `

setVisible($attributes)

  3. ``````php
  4. $users = $users->setVisible(['id', 'name']);
  5. `

setHidden($attributes)

  3. ``````php
  4. $users = $users->setHidden(['email', 'password', 'remember_token']);
  5. `

toQuery()

  3. ``````php
  4. use App\Models\User;
  6. $users = User::where('status', 'VIP')->get();
  8. $users->toQuery()->update([
  9.    'status' => 'Administrator',
  10. ]);
  11. `

unique($key = null, $strict = false)

  3. ``````php
  4. $users = $users->unique();
  5. `

カスタムコレクション

特定のモデルと対話する際にカスタムCollectionオブジェクトを使用したい場合は、モデルにnewCollectionメソッドを定義できます： 

  1. <?php
  3. namespace App\Models;
  5. use App\Support\UserCollection;
  6. use Illuminate\Database\Eloquent\Collection;
  7. use Illuminate\Database\Eloquent\Model;
  9. class User extends Model
  10. {
  11.    /**
  12.      * Create a new Eloquent Collection instance.
  13.    *
  14.      * @param  array<int, \Illuminate\Database\Eloquent\Model>  $models
  15.      * @return \Illuminate\Database\Eloquent\Collection<int, \Illuminate\Database\Eloquent\Model>
  16.    */
  17.    public function newCollection(array $models = []): Collection
  18.    {
  19.    return new UserCollection($models);
  20.    }
  21. }

newCollectionメソッドを定義すると、Eloquentが通常Illuminate\Database\Eloquent\Collectionインスタンスを返す場合に、カスタムコレクションのインスタンスを受け取ります。アプリケーション内のすべてのモデルにカスタムコレクションを使用したい場合は、アプリケーションのすべてのモデルによって拡張される基本モデルクラスにnewCollectionメソッドを定義する必要があります。