Eloquent: 컬렉션

소개
사용 가능한 메서드
사용자 정의 컬렉션

소개

하나 이상의 모델 결과를 반환하는 모든 Eloquent 메서드는 get 메서드를 통해 검색하거나 관계를 통해 액세스한 결과를 포함하여 Illuminate\Database\Eloquent\Collection 클래스의 인스턴스를 반환합니다. Eloquent 컬렉션 객체는 Laravel의 기본 컬렉션을 확장하므로, Eloquent 모델의 기본 배열을 유연하게 다루는 데 사용되는 수십 가지 메서드를 자연스럽게 상속받습니다. 이러한 유용한 메서드에 대해 알아보려면 Laravel 컬렉션 문서를 꼭 확인하세요!

또한 모든 컬렉션은 반복자 역할을 하므로 마치 단순한 PHP 배열처럼 컬렉션을 반복할 수 있습니다.

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

그러나 앞서 언급했듯이 컬렉션은 배열보다 훨씬 강력하며 직관적인 인터페이스를 사용하여 연결할 수 있는 다양한 map / reduce 연산을 제공합니다. 예를 들어, 비활성 모델을 모두 제거한 다음 남아 있는 각 사용자의 이름을 수집할 수 있습니다.

$names = User::all()->reject(function (User $user) {
    return $user->active === false;
})->map(function (User $user) {
    return $user->name;
});

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)`

append 메서드는 컬렉션의 모든 모델에 대해 속성이 추가되어야 함을 나타내는 데 사용할 수 있습니다. 이 메서드는 속성 배열 또는 단일 속성을 허용합니다.

$users->append('team');
 
$users->append(['team', 'is_admin']);

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

contains 메서드는 지정된 모델 인스턴스가 컬렉션에 포함되어 있는지 확인하는 데 사용할 수 있습니다. 이 메서드는 기본 키 또는 모델 인스턴스를 허용합니다.

$users->contains(1);
 
$users->contains(User::find(1));

`diff($items)`

diff 메서드는 지정된 컬렉션에 없는 모든 모델을 반환합니다.

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

`except($keys)`

except 메서드는 지정된 기본 키가 없는 모든 모델을 반환합니다.

$users = $users->except([1, 2, 3]);

`find($key)`

find 메서드는 지정된 키와 일치하는 기본 키를 가진 모델을 반환합니다. $key가 모델 인스턴스인 경우 find는 기본 키와 일치하는 모델을 반환하려고 시도합니다. $key가 키 배열인 경우 find는 지정된 배열에 기본 키가 있는 모든 모델을 반환합니다.

$users = User::all();
 
$user = $users->find(1);

`findOrFail($key)`

findOrFail 메서드는 지정된 키와 일치하는 기본 키를 가진 모델을 반환하거나, 컬렉션에서 일치하는 모델을 찾을 수 없는 경우 Illuminate\Database\Eloquent\ModelNotFoundException 예외를 발생시킵니다.

$users = User::all();
 
$user = $users->findOrFail(1);

`fresh($with = [])`

fresh 메서드는 데이터베이스에서 컬렉션의 각 모델의 새 인스턴스를 검색합니다. 또한 지정된 관계는 즉시 로드됩니다.

$users = $users->fresh();
 
$users = $users->fresh('comments');

`intersect($items)`

intersect 메서드는 지정된 컬렉션에도 있는 모든 모델을 반환합니다.

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

`load($relations)`

load 메서드는 컬렉션의 모든 모델에 대해 지정된 관계를 즉시 로드합니다.

$users->load(['comments', 'posts']);
 
$users->load('comments.author');
 
$users->load(['comments', 'posts' => fn ($query) => $query->where('active', 1)]);

`loadMissing($relations)`

loadMissing 메서드는 관계가 아직 로드되지 않은 경우 컬렉션의 모든 모델에 대해 지정된 관계를 즉시 로드합니다.

$users->loadMissing(['comments', 'posts']);
 
$users->loadMissing('comments.author');
 
$users->loadMissing(['comments', 'posts' => fn ($query) => $query->where('active', 1)]);

`modelKeys()`

modelKeys 메서드는 컬렉션의 모든 모델에 대한 기본 키를 반환합니다.

$users->modelKeys();
 
// [1, 2, 3, 4, 5]

`makeVisible($attributes)`

makeVisible 메서드는 컬렉션의 각 모델에서 일반적으로 "숨겨진" 속성을 표시합니다.

$users = $users->makeVisible(['address', 'phone_number']);

`makeHidden($attributes)`

makeHidden 메서드는 컬렉션의 각 모델에서 일반적으로 "표시되는" 속성을 숨깁니다.

$users = $users->makeHidden(['address', 'phone_number']);

`only($keys)`

only 메서드는 지정된 기본 키를 가진 모든 모델을 반환합니다.

$users = $users->only([1, 2, 3]);

`setVisible($attributes)`

setVisible 메서드는 컬렉션의 각 모델에서 표시되는 모든 속성을 일시적으로 재정의합니다.

$users = $users->setVisible(['id', 'name']);

`setHidden($attributes)`

setHidden 메서드는 컬렉션의 각 모델에서 숨겨진 모든 속성을 일시적으로 재정의합니다.

$users = $users->setHidden(['email', 'password', 'remember_token']);

`toQuery()`

toQuery 메서드는 컬렉션 모델의 기본 키에 대한 whereIn 제약 조건을 포함하는 Eloquent 쿼리 빌더 인스턴스를 반환합니다.

use App\Models\User;
 
$users = User::where('status', 'VIP')->get();
 
$users->toQuery()->update([
    'status' => 'Administrator',
]);

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

unique 메서드는 컬렉션의 모든 고유 모델을 반환합니다. 컬렉션의 다른 모델과 기본 키가 같은 모든 모델은 제거됩니다.

$users = $users->unique();

사용자 정의 컬렉션

지정된 모델과 상호 작용할 때 사용자 정의 Collection 객체를 사용하려면 모델에 CollectedBy 속성을 추가할 수 있습니다.

<?php
 
namespace App\Models;
 
use App\Support\UserCollection;
use Illuminate\Database\Eloquent\Attributes\CollectedBy;
use Illuminate\Database\Eloquent\Model;
 
#[CollectedBy(UserCollection::class)]
class User extends Model
{
    // ...
}

또는 모델에서 newCollection 메서드를 정의할 수 있습니다.

<?php
 
namespace App\Models;
 
use App\Support\UserCollection;
use Illuminate\Database\Eloquent\Collection;
use Illuminate\Database\Eloquent\Model;
 
class User extends Model
{
    /**
     * 새로운 Eloquent 컬렉션 인스턴스를 생성합니다.
     *
     * @param  array<int, \Illuminate\Database\Eloquent\Model>  $models
     * @return \Illuminate\Database\Eloquent\Collection<int, \Illuminate\Database\Eloquent\Model>
     */
    public function newCollection(array $models = []): Collection
    {
        return new UserCollection($models);
    }
}

newCollection 메서드를 정의하거나 모델에 CollectedBy 속성을 추가하면 Eloquent가 일반적으로 Illuminate\Database\Eloquent\Collection 인스턴스를 반환할 때마다 사용자 정의 컬렉션의 인스턴스를 받게 됩니다.

애플리케이션의 모든 모델에 대해 사용자 정의 컬렉션을 사용하려면 애플리케이션의 모든 모델에서 확장되는 기본 모델 클래스에 newCollection 메서드를 정의해야 합니다.