Eloquent: Collections

시작하기

get 메소드를 통하거나 하나의 relationship-관계를 통해서 Eloquent로 부터 반환되는 모든 멀티 레코드 결과는 Illuminate\Database\Eloquent\Collection 객체의 인스턴스가 됩니다. Eloquent 컬렉션 객체는 라라벨의 base collection을 상속받기 때문에, 자연스럽게 ELoquent 모델에 대한 결과에서 다양하고 편리한 메소드들을 사용할 수 있습니다.

당연하게도, 모든 컬렉션은 Iterators(반복자)이기 때문에, 간단한 PHP 배열과 같이 반복문 안에서 사용할 수도 있습니다:

$users = App\User::where('active', 1)->get();

foreach ($users as $user) {
    echo $user->name;
}

하지만, 컬렉션은 배열보다 강력하며, 직관적인 인터페이스를 사용하여 메소드 체인이 가능한 map / reduce 메소드를 사용 할 수 있습니다. 예를 들어 사용자 중에서 비활성화된 사용자를 제외하고 남은 사용자들의 이름을 확인하려면 다음과 같이 하면 됩니다:

$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 메소드는 기본 컬렉션 인스턴스를 반환합니다. 또한 만약 map 실행이 Eloquent 모델을 포함하지 않는 컬렉션을 반환한다면, 자동으로 기본 컬렉션으로 캐스팅 될 것입니다.

사용가능한 메소드들

모든 Eloquent 컬렉션은 기본 Laravel collection 객체를 확장합니다. 따라서 기본 컬렉션 클래스에서 제공하는 모든 강력한 메서드를 상속받습니다.

또한 Illuminate\Database\Eloquent\Collection 클래스는 모델 컬렉션을 관리하는 데 도움이 되는 슈퍼셋을 제공합니다. 대부분의 메소드는 Illuminate\Database\Eloquent\Collection 인스턴스를 반환하지만 일부 메소드는 기본 Illuminate\Support\Collection 인스턴스를 반환합니다.

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

contains 메소드는 주어진 모델 인스턴스가 콜렉션에 포함되어 있는지를 결정하는데 사용될 수 있습니다. 이 메소드는 기본-primary 키 또는 모델 인스턴스를 허용합니다.

$users->contains(1);

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

diff($items)

diff 메소드는 주어진 콜렉션에 존재하지 않는 모든 모델을 리턴합니다.

use App\User;

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

except($keys)

except 메소드는 주어진 기본-primary 키를 가지고 있지 않은 모든 모델을 반환합니다.

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

find($key) {#collection-method .first-collection-method}

find 메소드는 주어진 기본-primary 키를 가진 모델을 찾습니다. $key가 모델 인스턴스라면, find는 기본-primary 키와 일치하는 모델을 반환하려고 시도 할 것입니다. $key가 키 배열이면,find$ keys와 일치하는 모든 모델을whereIn ()을 사용하여 돌려줍니다.

$users = User::all();

$user = $users->find(1);

fresh($with = [])

fresh 메소드는 데이터베이스에서 콜렉션의 각 모델의 새로운 인스턴스를 가져옵니다. 또한 지정된 모든 관계가 eager 로드됩니다.

$users = $users->fresh();

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

intersect($items)

intersect 메소드는 주어진 콜렉션에 존재하는 모든 모델을 반환합니다.

use App\User;

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

load($relations)

load 메소드는 컬렉션의 모든 모델에 대해 주어진 관계를 로드합니다.

$users->load('comments', 'posts');

$users->load('comments.author');

loadMissing($relations)

loadMissing 메소드는 관계가 아직 로드되지 않은 경우 콜렉션의 모든 모델에 대해 주어진 관계를 로드합니다.

$users->loadMissing('comments', 'posts');

$users->loadMissing('comments.author');

modelKeys()

modelKeys 메소드는 콜렉션 내의 모든 모델에 대한 기본-primary 키를 반환합니다.

$users->modelKeys();

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

makeVisible($attributes)

makeVisible 메소드는 콜렉션의 각 모델에서 전형적으로 "숨겨진-hidden" 속성을 가시적으로 만듭니다.

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

makeHidden($attributes)

makeHidden 메소드는 콜렉션의 각 모델에 일반적으로 "가시적-visible"인 속성을 숨깁니다.

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

only($keys)

only 메소드는 주어진 기본-primary 키를 가진 모든 모델을 반환합니다.

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

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

unique 메소드는 콜렉션 내의 모든 유일한 모델들을 반환합니다. 컬렉션의 다른 모델과 동일한 기본-primary 키가 있는 동일한 유형의 모델은 제거됩니다.

$users = $users->unique();

커스텀-사용자 정의 컬렉션

만약 여러분이 고유한 Collection 객체를 사용하고자 한다면, 모델 클래스에서 newCollection 메소드를 오버라이드(재지정) 하면 됩니다:

<?php

namespace App;

use App\CustomCollection;
use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * Create a new Eloquent Collection instance.
     *
     * @param  array  $models
     * @return \Illuminate\Database\Eloquent\Collection
     */
    public function newCollection(array $models = [])
    {
        return new CustomCollection($models);
    }
}

newCollection 메소드를 정의하고 나면, Eloquent가 모델에서 Collection 인스턴스를 반환할 때 언제나 여러분이 지정한 사용자 정의 컬렉션을 반환할 것입니다. 애플리케이션의 모든 모델에서 사용자 정의 컬렉션을 사용하기를 원한다면, 모든 모델 클래스들이 상속받는 기본 Model 클래스에서 newCollection 메소드를 오버라이드 해야만합니다.

라라벨 카카오톡 오픈채팅