본문으로 건너뛰기
버전: 13.x

컬렉션 (Collections)

소개 (Introduction)

Illuminate\Support\Collection 클래스는 데이터 배열 작업을 위한 유연하고 편리한 래퍼를 제공합니다. 예를 들어, 다음 코드를 확인하세요. collect 도우미를 사용하여 배열에서 새 컬렉션 인스턴스를 만들고 각 요소에 대해 strtoupper 함수를 실행한 다음 모든 빈 요소를 제거합니다.

$collection = collect(['Taylor', 'Abigail', null])->map(function (?string $name) {
return strtoupper($name);
})->reject(function (string $name) {
return empty($name);
});

보시다시피, Collection 클래스를 사용하면 메서드를 연결하여 기본 배열을 유창하게 매핑하고 축소할 수 있습니다. 일반적으로 컬렉션은 변경할 수 없습니다. 즉, 모든 Collection 메서드는 완전히 새로운 Collection 인스턴스를 반환합니다.

컬렉션 만들기

위에서 언급한 것처럼 collect 도우미는 지정된 배열에 대해 새 Illuminate\Support\Collection 인스턴스를 반환합니다. 따라서 컬렉션을 만드는 것은 다음과 같이 간단합니다.

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

makefromJson 메서드를 사용하여 컬렉션을 만들 수도 있습니다.

[!NOTE] Eloquent 쿼리의 결과는 항상 Collection 인스턴스로 반환됩니다.

컬렉션 확장

컬렉션은 "매크로 가능"하므로 런타임에 Collection 클래스에 추가 메서드를 추가할 수 있습니다. Illuminate\Support\Collection 클래스의 macro 메서드는 매크로가 호출될 때 실행될 클로저를 허용합니다. 매크로 클로저는 마치 컬렉션 클래스의 실제 메서드인 것처럼 $this를 통해 컬렉션의 다른 메서드에 액세스할 수 있습니다. 예를 들어 다음 코드는 Collection 클래스에 toUpper 메서드를 추가합니다.

use Illuminate\Support\Collection;
use Illuminate\Support\Str;

Collection::macro('toUpper', function () {
return $this->map(function (string $value) {
return Str::upper($value);
});
});

$collection = collect(['first', 'second']);

$upper = $collection->toUpper();

// ['FIRST', 'SECOND']

일반적으로 서비스 프로바이더boot 메서드에서 컬렉션 매크로를 선언해야 합니다.

매크로 인수

필요한 경우 추가 인수를 허용하는 매크로를 정의할 수 있습니다.

use Illuminate\Support\Collection;
use Illuminate\Support\Facades\Lang;

Collection::macro('toLocale', function (string $locale) {
return $this->map(function (string $value) use ($locale) {
return Lang::get($value, [], $locale);
});
});

$collection = collect(['first', 'second']);

$translated = $collection->toLocale('es');

// ['primero', 'segundo'];

사용 가능한 메서드 (Available Methods)

나머지 컬렉션 문서의 대부분에서는 Collection 클래스에서 사용할 수 있는 각 메서드에 대해 설명합니다. 이러한 모든 메서드는 기본 배열을 원활하게 조작하기 위해 연결될 수 있다는 점을 기억하세요. 게다가 거의 모든 메서드는 새로운 Collection 인스턴스를 반환하므로 필요할 때 컬렉션의 원본을 보존할 수 있습니다.

메서드 목록 (Method Listing)

after()

after 메서드는 주어진 항목 뒤에 있는 항목을 반환합니다. 주어진 항목을 찾을 수 없거나 마지막 항목인 경우 null가 반환됩니다.

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

$collection->after(3);

// 4

$collection->after(5);

// null

이 메서드는 "느슨한" 비교를 사용하여 지정된 항목을 검색합니다. 즉, 정수 값을 포함하는 문자열은 동일한 값의 정수와 동일한 것으로 간주됩니다. "엄격한" 비교를 사용하려면 메서드에 strict 인수를 제공하면 됩니다.

collect([2, 4, 6, 8])->after('4', strict: true);

// null

또는 주어진 진실성 테스트를 통과한 첫 번째 항목을 검색하기 위해 자체 클로저를 제공할 수도 있습니다.

collect([2, 4, 6, 8])->after(function (int $item, int $key) {
return $item > 5;
});

// 8

all()

all 메서드는 컬렉션이 나타내는 기본 배열을 반환합니다.

collect([1, 2, 3])->all();

// [1, 2, 3]

average()

avg 메서드의 별칭입니다.

avg()

avg 메서드는 지정된 키의 평균 값을 반환합니다.

$average = collect([
['foo' => 10],
['foo' => 10],
['foo' => 20],
['foo' => 40]
])->avg('foo');

// 20

$average = collect([1, 1, 2, 4])->avg();

// 2

before()

before 메서드는 after 메서드와 반대입니다. 주어진 항목 앞에 있는 항목을 반환합니다. 주어진 항목을 찾을 수 없거나 첫 번째 항목인 경우 null가 반환됩니다.

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

$collection->before(3);

// 2

$collection->before(1);

// null

collect([2, 4, 6, 8])->before('4', strict: true);

// null

collect([2, 4, 6, 8])->before(function (int $item, int $key) {
return $item > 5;
});

// 4

chunk()

chunk 메서드는 컬렉션을 지정된 크기의 여러 개의 작은 컬렉션으로 나눕니다.

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

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

$chunks->all();

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

이 메서드는 Bootstrap과 같은 그리드 시스템으로 작업할 때 에서 특히 유용합니다. 예를 들어 그리드에 표시하려는 Eloquent 모델 컬렉션이 있다고 가정해 보겠습니다.

@foreach ($products->chunk(3) as $chunk)
<div class="row">
@foreach ($chunk as $product)
<div class="col-xs-4">{{ $product->name }}</div>
@endforeach
</div>
@endforeach

chunkWhile()

chunkWhile 메서드는 지정된 콜백 평가에 따라 컬렉션을 여러 개의 작은 컬렉션으로 나눕니다. 클로저에 전달된 $chunk 변수는 이전 요소를 검사하는 데 사용될 수 있습니다:

$collection = collect(str_split('AABBCCCD'));

$chunks = $collection->chunkWhile(function (string $value, int $key, Collection $chunk) {
return $value === $chunk->last();
});

$chunks->all();

// [['A', 'A'], ['B', 'B'], ['C', 'C', 'C'], ['D']]

collapse()

collapse 메서드는 배열 또는 컬렉션 컬렉션을 단일 플랫 컬렉션으로 축소합니다.

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

$collapsed = $collection->collapse();

$collapsed->all();

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

collapseWithKeys()

collapseWithKeys 메서드는 배열 또는 컬렉션 모음을 단일 컬렉션으로 평면화하여 원래 키를 그대로 유지합니다. 컬렉션이 이미 플랫인 경우 빈 컬렉션을 반환합니다.

$collection = collect([
['first' => collect([1, 2, 3])],
['second' => [4, 5, 6]],
['third' => collect([7, 8, 9])]
]);

$collapsed = $collection->collapseWithKeys();

$collapsed->all();

// [
// 'first' => [1, 2, 3],
// 'second' => [4, 5, 6],
// 'third' => [7, 8, 9],
// ]

collect()

collect 메서드는 현재 컬렉션에 있는 항목이 포함된 새 Collection 인스턴스를 반환합니다.

$collectionA = collect([1, 2, 3]);

$collectionB = $collectionA->collect();

$collectionB->all();

// [1, 2, 3]

collect 메서드는 주로 지연 컬렉션을 표준 Collection 인스턴스로 변환하는 데 유용합니다.

$lazyCollection = LazyCollection::make(function () {
yield 1;
yield 2;
yield 3;
});

$collection = $lazyCollection->collect();

$collection::class;

// 'Illuminate\Support\Collection'

$collection->all();

// [1, 2, 3]

[!NOTE] collect 메서드는 Enumerable 인스턴스가 있고 지연되지 않은 컬렉션 인스턴스가 필요할 때 특히 유용합니다. collect()Enumerable 컨트랙트의 일부이므로 이를 사용하여 Collection 인스턴스를 안전하게 얻을 수 있습니다.

combine()

combine 메서드는 컬렉션의 값을 키로 다른 배열 또는 컬렉션의 값과 결합합니다.

$collection = collect(['name', 'age']);

$combined = $collection->combine(['George', 29]);

$combined->all();

// ['name' => 'George', 'age' => 29]

concat()

concat 메서드는 주어진 배열이나 컬렉션의 값을 다른 컬렉션의 끝에 추가합니다:

$collection = collect(['John Doe']);

$concatenated = $collection->concat(['Jane Doe'])->concat(['name' => 'Johnny Doe']);

$concatenated->all();

// ['John Doe', 'Jane Doe', 'Johnny Doe']

concat 메서드는 원래 컬렉션에 연결된 항목의 키를 수치적으로 다시 인덱싱합니다. 연관 컬렉션의 키를 유지하려면 merge 메서드를 참조하세요.

contains()

contains 메서드는 컬렉션에 특정 항목이 포함되어 있는지 여부를 확인합니다. 주어진 진실 테스트와 일치하는 요소가 컬렉션에 존재하는지 확인하기 위해 contains 메서드에 클로저를 전달할 수 있습니다.

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

$collection->contains(function (int $value, int $key) {
return $value > 5;
});

// false

또는 컬렉션에 지정된 항목 값이 포함되어 있는지 확인하기 위해 문자열을 contains 메서드에 전달할 수 있습니다.

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

$collection->contains('Desk');

// true

$collection->contains('New York');

// false

또한 키/값 쌍을 contains 메서드에 전달할 수도 있으며, 이는 주어진 쌍이 컬렉션에 존재하는지 확인합니다.

$collection = collect([
['product' => 'Desk', 'price' => 200],
['product' => 'Chair', 'price' => 100],
]);

$collection->contains('product', 'Bookcase');

// false

contains 메서드는 항목 값을 확인할 때 "느슨한" 비교를 사용합니다. 즉, 정수 값이 있는 문자열은 동일한 값의 정수와 동일한 것으로 간주됩니다. "엄격한" 비교를 사용하여 필터링하려면 containsStrict 메서드를 사용하세요.

contains의 반대에 대해서는 doesntContain 메서드를 참조하세요.

containsStrict()

이 메서드는 contains 메서드와 동일한 서명을 갖습니다. 그러나 모든 값은 "엄격한" 비교를 사용하여 비교됩니다.

[!NOTE] 이 메서드의 동작은 Eloquent 컬렉션을 사용할 때 수정됩니다.

count()

count 메서드는 컬렉션에 있는 총 항목 수를 반환합니다.

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

$collection->count();

// 4

countBy()

countBy 메서드는 컬렉션에서 값의 발생 횟수를 계산합니다. 기본적으로 이 메서드는 모든 요소의 발생 횟수를 계산하므로 컬렉션에 있는 요소의 특정 "유형"을 계산할 수 있습니다.

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

$counted = $collection->countBy();

$counted->all();

// [1 => 1, 2 => 3, 3 => 1]

사용자 지정 값으로 모든 항목을 계산하기 위해 countBy 메서드에 클로저를 전달할 수 있습니다.

$collection = collect(['[email protected]', '[email protected]', '[email protected]']);

$counted = $collection->countBy(function (string $email) {
return substr(strrchr($email, '@'), 1);
});

$counted->all();

// ['gmail.com' => 2, 'yahoo.com' => 1]

crossJoin()

crossJoin 메서드는 주어진 배열 또는 컬렉션 사이에서 컬렉션의 값을 교차 조인하여 가능한 모든 순열을 포함하는 데카르트 곱을 반환합니다.

$collection = collect([1, 2]);

$matrix = $collection->crossJoin(['a', 'b']);

$matrix->all();

/*
[
[1, 'a'],
[1, 'b'],
[2, 'a'],
[2, 'b'],
]
*/

$collection = collect([1, 2]);

$matrix = $collection->crossJoin(['a', 'b'], ['I', 'II']);

$matrix->all();

/*
[
[1, 'a', 'I'],
[1, 'a', 'II'],
[1, 'b', 'I'],
[1, 'b', 'II'],
[2, 'a', 'I'],
[2, 'a', 'II'],
[2, 'b', 'I'],
[2, 'b', 'II'],
]
*/

dd()

dd 메서드는 컬렉션의 항목을 덤프하고 스크립트 실행을 종료합니다.

$collection = collect(['John Doe', 'Jane Doe']);

$collection->dd();

/*
array:2 [
0 => "John Doe"
1 => "Jane Doe"
]
*/

스크립트 실행을 중지하지 않으려면 대신 dump 메서드를 사용하세요.

diff()

diff 메서드는 해당 값을 기반으로 컬렉션을 다른 컬렉션 또는 일반 PHP array와 비교합니다. 이 메서드는 주어진 컬렉션에 존재하지 않는 원래 컬렉션의 값을 반환합니다:

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

$diff = $collection->diff([2, 4, 6, 8]);

$diff->all();

// [1, 3, 5]

[!NOTE] 이 메서드의 동작은 Eloquent 컬렉션을 사용할 때 수정됩니다.

diffAssoc()

diffAssoc 메서드는 키와 값을 기반으로 컬렉션을 다른 컬렉션이나 일반 PHP array와 비교합니다. 이 메서드는 주어진 컬렉션에 존재하지 않는 원래 컬렉션의 키/값 쌍을 반환합니다.

$collection = collect([
'color' => 'orange',
'type' => 'fruit',
'remain' => 6,
]);

$diff = $collection->diffAssoc([
'color' => 'yellow',
'type' => 'fruit',
'remain' => 3,
'used' => 6,
]);

$diff->all();

// ['color' => 'orange', 'remain' => 6]

diffAssocUsing()

diffAssoc와 달리 diffAssocUsing는 인덱스 비교를 위해 사용자 제공 콜백 함수를 허용합니다.

$collection = collect([
'color' => 'orange',
'type' => 'fruit',
'remain' => 6,
]);

$diff = $collection->diffAssocUsing([
'Color' => 'yellow',
'Type' => 'fruit',
'Remain' => 3,
], 'strnatcasecmp');

$diff->all();

// ['color' => 'orange', 'remain' => 6]

콜백은 0보다 작거나 같거나 큰 정수를 반환하는 비교 함수여야 합니다. 자세한 내용은 diffAssocUsing 메서드가 내부적으로 활용하는 PHP 함수인 array_diff_uassoc에 대한 PHP 설명서를 참조하세요.

diffKeys()

diffKeys 메서드는 해당 키를 기반으로 컬렉션을 다른 컬렉션 또는 일반 PHP array와 비교합니다. 이 메서드는 주어진 컬렉션에 존재하지 않는 원래 컬렉션의 키/값 쌍을 반환합니다.

$collection = collect([
'one' => 10,
'two' => 20,
'three' => 30,
'four' => 40,
'five' => 50,
]);

$diff = $collection->diffKeys([
'two' => 2,
'four' => 4,
'six' => 6,
'eight' => 8,
]);

$diff->all();

// ['one' => 10, 'three' => 30, 'five' => 50]

doesntContain()

doesntContain 메서드는 컬렉션에 지정된 항목이 포함되어 있지 않은지 여부를 확인합니다. 주어진 진실 테스트와 일치하는 요소가 컬렉션에 존재하지 않는지 확인하기 위해 doesntContain 메서드에 클로저를 전달할 수 있습니다.

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

$collection->doesntContain(function (int $value, int $key) {
return $value < 5;
});

// false

또는 컬렉션에 지정된 항목 값이 포함되어 있지 않은지 확인하기 위해 문자열을 doesntContain 메서드에 전달할 수 있습니다.

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

$collection->doesntContain('Table');

// true

$collection->doesntContain('Desk');

// false

또한 키/값 쌍을 doesntContain 메서드에 전달할 수도 있습니다. 그러면 주어진 쌍이 컬렉션에 존재하지 않는지 확인할 수 있습니다.

$collection = collect([
['product' => 'Desk', 'price' => 200],
['product' => 'Chair', 'price' => 100],
]);

$collection->doesntContain('product', 'Bookcase');

// true

doesntContain 메서드는 항목 값을 확인할 때 "느슨한" 비교를 사용합니다. 즉, 정수 값이 있는 문자열은 동일한 값의 정수와 동일한 것으로 간주됩니다.

doesntContainStrict()

이 메서드는 doesntContain 메서드와 동일한 시그니처를 갖습니다. 그러나 모든 값은 "엄격한" 비교를 사용하여 비교됩니다.

dot()

dot 메서드는 다차원 컬렉션을 "점" 표기법을 사용하여 깊이를 나타내는 단일 수준 컬렉션으로 평면화합니다.

$collection = collect(['products' => ['desk' => ['price' => 100]]]);

$flattened = $collection->dot();

$flattened->all();

// ['products.desk.price' => 100]

dump()

dump 메서드는 컬렉션의 항목을 덤프합니다.

$collection = collect(['John Doe', 'Jane Doe']);

$collection->dump();

/*
array:2 [
0 => "John Doe"
1 => "Jane Doe"
]
*/

컬렉션을 덤프한 후 스크립트 실행을 중지하려면 dd 메서드를 대신 사용하세요.

duplicates()

duplicates 메서드는 컬렉션에서 중복 값을 검색하고 반환합니다.

$collection = collect(['a', 'b', 'a', 'c', 'b']);

$collection->duplicates();

// [2 => 'a', 4 => 'b']

컬렉션에 배열이나 객체가 포함된 경우 중복 값을 확인하려는 속성의 키를 전달할 수 있습니다.

$employees = collect([
['email' => '[email protected]', 'position' => 'Developer'],
['email' => '[email protected]', 'position' => 'Designer'],
['email' => '[email protected]', 'position' => 'Developer'],
]);

$employees->duplicates('position');

// [2 => 'Developer']

duplicatesStrict()

이 메서드는 duplicates 메서드와 동일한 시그니처를 갖습니다. 그러나 모든 값은 "엄격한" 비교를 사용하여 비교됩니다.

each()

each 메서드는 컬렉션의 항목을 반복하고 각 항목을 클로저에 전달합니다.

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

$collection->each(function (int $item, int $key) {
// ...
});

항목 반복을 중지하려면 클로저에서 false를 반환하면 됩니다.

$collection->each(function (int $item, int $key) {
if (/* condition */) {
return false;
}
});

eachSpread()

eachSpread 메서드는 컬렉션의 항목을 반복하여 중첩된 각 항목 값을 지정된 콜백에 전달합니다.

$collection = collect([['John Doe', 35], ['Jane Doe', 33]]);

$collection->eachSpread(function (string $name, int $age) {
// ...
});

콜백에서 false를 반환하여 항목 반복을 중지할 수 있습니다.

$collection->eachSpread(function (string $name, int $age) {
return false;
});

ensure()

ensure 메서드는 컬렉션의 모든 요소가 지정된 유형 또는 유형 목록인지 확인하는 데 사용할 수 있습니다. 그렇지 않으면 UnexpectedValueException가 발생합니다.

return $collection->ensure(User::class);

return $collection->ensure([User::class, Customer::class]);

string, int, float, boolarray와 같은 기본 유형도 지정할 수 있습니다.

return $collection->ensure('int');

[!WARNING] ensure 메서드는 나중에 다른 유형의 요소가 컬렉션에 추가되지 않는다고 보장하지 않습니다.

every()

every 메서드는 컬렉션의 모든 요소가 주어진 진실 테스트를 통과하는지 확인하는 데 사용할 수 있습니다.

collect([1, 2, 3, 4])->every(function (int $value, int $key) {
return $value > 2;
});

// false

컬렉션이 비어 있으면 every 메서드는 true를 반환합니다.

$collection = collect([]);

$collection->every(function (int $value, int $key) {
return $value > 2;
});

// true

except()

except 메서드는 지정된 키가 있는 항목을 제외하고 컬렉션의 모든 항목을 반환합니다.

$collection = collect(['product_id' => 1, 'price' => 100, 'discount' => false]);

$filtered = $collection->except(['price', 'discount']);

$filtered->all();

// ['product_id' => 1]

except의 반대에 대해서는 only 메서드를 참조하세요.

[!NOTE] 이 메서드의 동작은 Eloquent 컬렉션을 사용할 때 수정됩니다.

filter()

filter 메서드는 주어진 콜백을 사용하여 컬렉션을 필터링하여 주어진 진실성 테스트를 통과한 항목만 유지합니다.

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

$filtered = $collection->filter(function (int $value, int $key) {
return $value > 2;
});

$filtered->all();

// [3, 4]

콜백이 제공되지 않으면 false에 해당하는 컬렉션의 모든 항목이 제거됩니다.

$collection = collect([1, 2, 3, null, false, '', 0, []]);

$collection->filter()->all();

// [1, 2, 3]

filter의 반대에 대해서는 reject 메서드를 참조하세요.

first()

first 메서드는 주어진 진실성 테스트를 통과한 컬렉션의 첫 번째 요소를 반환합니다.

collect([1, 2, 3, 4])->first(function (int $value, int $key) {
return $value > 2;
});

// 3

컬렉션의 첫 번째 요소를 가져오기 위해 인수 없이 first 메서드를 호출할 수도 있습니다. 컬렉션이 비어 있으면 null가 반환됩니다.

collect([1, 2, 3, 4])->first();

// 1

firstOrFail()

firstOrFail 메서드는 first 메서드와 동일합니다. 그러나 결과가 없으면 Illuminate\Support\ItemNotFoundException 예외가 발생합니다.

collect([1, 2, 3, 4])->firstOrFail(function (int $value, int $key) {
return $value > 5;
});

// Throws ItemNotFoundException...

컬렉션의 첫 번째 요소를 가져오기 위해 인수 없이 firstOrFail 메서드를 호출할 수도 있습니다. 컬렉션이 비어 있으면 Illuminate\Support\ItemNotFoundException 예외가 발생합니다.

collect([])->firstOrFail();

// Throws ItemNotFoundException...

firstWhere()

firstWhere 메서드는 주어진 키/값 쌍이 있는 컬렉션의 첫 번째 요소를 반환합니다.

$collection = collect([
['name' => 'Regena', 'age' => null],
['name' => 'Linda', 'age' => 14],
['name' => 'Diego', 'age' => 23],
['name' => 'Linda', 'age' => 84],
]);

$collection->firstWhere('name', 'Linda');

// ['name' => 'Linda', 'age' => 14]

비교 연산자를 사용하여 firstWhere 메서드를 호출할 수도 있습니다.

$collection->firstWhere('age', '>=', 18);

// ['name' => 'Diego', 'age' => 23]

where 메서드와 마찬가지로 firstWhere 메서드에 하나의 인수를 전달할 수 있습니다. 이 시나리오에서 firstWhere 메서드는 지정된 항목 키 값이 "truthy"인 첫 번째 항목을 반환합니다.

$collection->firstWhere('age');

// ['name' => 'Linda', 'age' => 14]

flatMap()

flatMap 메서드는 컬렉션을 반복하고 각 값을 지정된 클로저에 전달합니다. 클로저는 항목을 자유롭게 수정하고 반환할 수 있으므로 수정된 항목의 새로운 컬렉션을 형성합니다. 그런 다음 배열은 한 수준씩 평면화됩니다.

$collection = collect([
['name' => 'Sally'],
['school' => 'Arkansas'],
['age' => 28]
]);

$flattened = $collection->flatMap(function (array $values) {
return array_map('strtoupper', $values);
});

$flattened->all();

// ['name' => 'SALLY', 'school' => 'ARKANSAS', 'age' => '28'];

flatten()

flatten 메서드는 다차원 컬렉션을 단일 차원으로 평면화합니다.

$collection = collect([
'name' => 'Taylor',
'languages' => [
'PHP', 'JavaScript'
]
]);

$flattened = $collection->flatten();

$flattened->all();

// ['Taylor', 'PHP', 'JavaScript'];

필요한 경우 flatten 메서드에 "깊이" 인수를 전달할 수 있습니다.

$collection = collect([
'Apple' => [
[
'name' => 'iPhone 6S',
'brand' => 'Apple'
],
],
'Samsung' => [
[
'name' => 'Galaxy S7',
'brand' => 'Samsung'
],
],
]);

$products = $collection->flatten(1);

$products->values()->all();

/*
[
['name' => 'iPhone 6S', 'brand' => 'Apple'],
['name' => 'Galaxy S7', 'brand' => 'Samsung'],
]
*/

이 예에서 깊이를 제공하지 않고 flatten를 호출하면 중첩 배열도 평면화되어 ['iPhone 6S', 'Apple', 'Galaxy S7', 'Samsung']가 생성됩니다. 깊이를 제공하면 중첩 배열이 평면화될 수준 수를 지정할 수 있습니다.

flip()

flip 메서드는 컬렉션의 키를 해당 값으로 바꿉니다.

$collection = collect(['name' => 'Taylor', 'framework' => 'Laravel']);

$flipped = $collection->flip();

$flipped->all();

// ['Taylor' => 'name', 'Laravel' => 'framework']

forget()

forget 메서드는 해당 키를 사용하여 컬렉션에서 항목을 제거합니다.

$collection = collect(['name' => 'Taylor', 'framework' => 'Laravel']);

// Forget a single key...
$collection->forget('name');

// ['framework' => 'Laravel']

// Forget multiple keys...
$collection->forget(['name', 'framework']);

// []

[!WARNING] 대부분의 다른 컬렉션 메서드와 달리 forget는 수정된 새 컬렉션을 반환하지 않습니다. 호출된 컬렉션을 수정하고 반환합니다.

forPage()

forPage 메서드는 주어진 페이지 번호에 나타날 항목이 포함된 새 컬렉션을 반환합니다. 이 메서드는 페이지 번호를 첫 번째 인수로, 페이지당 표시할 항목 수를 두 번째 인수로 받아들입니다.

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

$chunk = $collection->forPage(2, 3);

$chunk->all();

// [4, 5, 6]

fromJson()

정적 fromJson 메서드는 json_decode PHP 함수를 사용하여 지정된 JSON 문자열을 디코딩하여 새 컬렉션 인스턴스를 생성합니다.

use Illuminate\Support\Collection;

$json = json_encode([
'name' => 'Taylor Otwell',
'role' => 'Developer',
'status' => 'Active',
]);

$collection = Collection::fromJson($json);

get()

get 메서드는 주어진 키에 있는 항목을 반환합니다. 키가 존재하지 않으면 null가 반환됩니다.

$collection = collect(['name' => 'Taylor', 'framework' => 'Laravel']);

$value = $collection->get('name');

// Taylor

선택적으로 기본값을 두 번째 인수로 전달할 수 있습니다.

$collection = collect(['name' => 'Taylor', 'framework' => 'Laravel']);

$value = $collection->get('age', 34);

// 34

메서드의 기본값으로 콜백을 전달할 수도 있습니다. 지정된 키가 존재하지 않으면 콜백 결과가 반환됩니다.

$collection->get('email', function () {
return '[email protected]';
});

// [email protected]

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->all();

/*
[
'account-x10' => [
['account_id' => 'account-x10', 'product' => 'Chair'],
['account_id' => 'account-x10', 'product' => 'Bookcase'],
],
'account-x11' => [
['account_id' => 'account-x11', 'product' => 'Desk'],
],
]
*/

문자열 key를 전달하는 대신 콜백을 전달할 수 있습니다. 콜백은 다음을 통해 그룹에 키를 지정하려는 값을 반환해야 합니다.

$grouped = $collection->groupBy(function (array $item, int $key) {
return substr($item['account_id'], -3);
});

$grouped->all();

/*
[
'x10' => [
['account_id' => 'account-x10', 'product' => 'Chair'],
['account_id' => 'account-x10', 'product' => 'Bookcase'],
],
'x11' => [
['account_id' => 'account-x11', 'product' => 'Desk'],
],
]
*/

여러 그룹화 기준을 배열로 전달할 수 있습니다. 각 배열 요소는 다차원 배열 내의 해당 수준에 적용됩니다.

$data = new Collection([
10 => ['user' => 1, 'skill' => 1, 'roles' => ['Role_1', 'Role_3']],
20 => ['user' => 2, 'skill' => 1, 'roles' => ['Role_1', 'Role_2']],
30 => ['user' => 3, 'skill' => 2, 'roles' => ['Role_1']],
40 => ['user' => 4, 'skill' => 2, 'roles' => ['Role_2']],
]);

$result = $data->groupBy(['skill', function (array $item) {
return $item['roles'];
}], preserveKeys: true);

/*
[
1 => [
'Role_1' => [
10 => ['user' => 1, 'skill' => 1, 'roles' => ['Role_1', 'Role_3']],
20 => ['user' => 2, 'skill' => 1, 'roles' => ['Role_1', 'Role_2']],
],
'Role_2' => [
20 => ['user' => 2, 'skill' => 1, 'roles' => ['Role_1', 'Role_2']],
],
'Role_3' => [
10 => ['user' => 1, 'skill' => 1, 'roles' => ['Role_1', 'Role_3']],
],
],
2 => [
'Role_1' => [
30 => ['user' => 3, 'skill' => 2, 'roles' => ['Role_1']],
],
'Role_2' => [
40 => ['user' => 4, 'skill' => 2, 'roles' => ['Role_2']],
],
],
];
*/

has()

has 메서드는 주어진 키가 컬렉션에 존재하는지 확인합니다.

$collection = collect(['account_id' => 1, 'product' => 'Desk', 'amount' => 5]);

$collection->has('product');

// true

$collection->has(['product', 'amount']);

// true

$collection->has(['amount', 'price']);

// false

hasAny()

hasAny 메서드는 주어진 키 중 컬렉션에 존재하는 키가 있는지 확인합니다.

$collection = collect(['account_id' => 1, 'product' => 'Desk', 'amount' => 5]);

$collection->hasAny(['product', 'price']);

// true

$collection->hasAny(['name', 'price']);

// false

hasMany()

hasMany 메서드는 컬렉션에 여러 항목이 포함되어 있는지 확인합니다.

collect([])->hasMany();

// false

collect(['1'])->hasMany();

// false

collect([1, 2, 3])->hasMany();

// true

collect([
['age' => 2],
['age' => 3],
])->hasMany(fn ($item) => $item['age'] === 2)

// false

hasSole()

hasSole 메서드는 컬렉션에 단일 항목이 포함되어 있는지 확인하고 선택적으로 주어진 기준과 일치합니다.

collect([])->hasSole();

// false

collect(['1'])->hasSole();

// true

collect([1, 2, 3])->hasSole(fn (int $item) => $item === 2);

// true

implode()

implode 메서드는 컬렉션의 항목을 결합합니다. 해당 인수는 컬렉션의 항목 유형에 따라 달라집니다. 컬렉션에 배열이나 개체가 포함된 경우 결합하려는 속성의 키와 값 사이에 배치하려는 "접착제" 문자열을 전달해야 합니다.

$collection = collect([
['account_id' => 1, 'product' => 'Desk'],
['account_id' => 2, 'product' => 'Chair'],
]);

$collection->implode('product', ', ');

// 'Desk, Chair'

컬렉션에 간단한 문자열이나 숫자 값이 포함된 경우 "glue"를 메서드의 유일한 인수로 전달해야 합니다.

collect([1, 2, 3, 4, 5])->implode('-');

// '1-2-3-4-5'

내포되는 값의 형식을 지정하려면 implode 메서드에 클로저를 전달할 수 있습니다.

$collection->implode(function (array $item, int $key) {
return strtoupper($item['product']);
}, ', ');

// 'DESK, CHAIR'

intersect()

intersect 메서드는 지정된 배열이나 컬렉션에 없는 원래 컬렉션의 모든 값을 제거합니다. 결과 컬렉션은 원래 컬렉션의 키를 유지합니다.

$collection = collect(['Desk', 'Sofa', 'Chair']);

$intersect = $collection->intersect(['Desk', 'Chair', 'Bookcase']);

$intersect->all();

// [0 => 'Desk', 2 => 'Chair']

[!NOTE] 이 메서드의 동작은 Eloquent 컬렉션을 사용할 때 수정됩니다.

intersectUsing()

intersectUsing 메서드는 값을 비교하는 사용자 지정 콜백을 사용하여 지정된 배열이나 컬렉션에 없는 원본 컬렉션의 모든 값을 제거합니다. 결과 컬렉션은 원래 컬렉션의 키를 유지합니다.

$collection = collect(['Desk', 'Sofa', 'Chair']);

$intersect = $collection->intersectUsing(['desk', 'chair', 'bookcase'], function (string $a, string $b) {
return strcasecmp($a, $b);
});

$intersect->all();

// [0 => 'Desk', 2 => 'Chair']

intersectAssoc()

intersectAssoc 메서드는 원본 컬렉션을 다른 컬렉션 또는 배열과 비교하여 지정된 모든 컬렉션에 존재하는 키/값 쌍을 반환합니다.

$collection = collect([
'color' => 'red',
'size' => 'M',
'material' => 'cotton'
]);

$intersect = $collection->intersectAssoc([
'color' => 'blue',
'size' => 'M',
'material' => 'polyester'
]);

$intersect->all();

// ['size' => 'M']

intersectAssocUsing()

intersectAssocUsing 메서드는 원래 컬렉션을 다른 컬렉션이나 배열과 비교하여 두 컬렉션에 모두 존재하는 키/값 쌍을 반환하고, 사용자 지정 비교 콜백을 사용하여 키와 값이 같은지 확인합니다.

$collection = collect([
'color' => 'red',
'Size' => 'M',
'material' => 'cotton',
]);

$intersect = $collection->intersectAssocUsing([
'color' => 'blue',
'size' => 'M',
'material' => 'polyester',
], function (string $a, string $b) {
return strcasecmp($a, $b);
});

$intersect->all();

// ['Size' => 'M']

intersectByKeys()

intersectByKeys 메서드는 지정된 배열이나 컬렉션에 없는 원본 컬렉션에서 모든 키와 해당 값을 제거합니다.

$collection = collect([
'serial' => 'UX301', 'type' => 'screen', 'year' => 2009,
]);

$intersect = $collection->intersectByKeys([
'reference' => 'UX404', 'type' => 'tab', 'year' => 2011,
]);

$intersect->all();

// ['type' => 'screen', 'year' => 2009]

isEmpty()

컬렉션이 비어 있으면 isEmpty 메서드는 true를 반환합니다. 그렇지 않으면 false가 반환됩니다.

collect([])->isEmpty();

// true

isNotEmpty()

컬렉션이 비어 있지 않으면 isNotEmpty 메서드는 true를 반환합니다. 그렇지 않으면 false가 반환됩니다.

collect([])->isNotEmpty();

// false

join()

join 메서드는 컬렉션의 값을 문자열과 결합합니다. 이 메서드의 두 번째 인수를 사용하면 최종 요소를 문자열에 추가하는 방식을 지정할 수도 있습니다.

collect(['a', 'b', 'c'])->join(', '); // 'a, b, c'
collect(['a', 'b', 'c'])->join(', ', ', and '); // 'a, b, and c'
collect(['a', 'b'])->join(', ', ' and '); // 'a and b'
collect(['a'])->join(', ', ' and '); // 'a'
collect([])->join(', ', ' and '); // ''

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

메서드에 콜백을 전달할 수도 있습니다. 콜백은 다음을 통해 컬렉션의 키 값을 반환해야 합니다.

$keyed = $collection->keyBy(function (array $item, int $key) {
return strtoupper($item['product_id']);
});

$keyed->all();

/*
[
'PROD-100' => ['product_id' => 'prod-100', 'name' => 'Desk'],
'PROD-200' => ['product_id' => 'prod-200', 'name' => 'Chair'],
]
*/

keys()

keys 메서드는 컬렉션의 모든 키를 반환합니다.

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

$keys = $collection->keys();

$keys->all();

// ['prod-100', 'prod-200']

last()

last 메서드는 주어진 진실성 테스트를 통과한 컬렉션의 마지막 요소를 반환합니다.

collect([1, 2, 3, 4])->last(function (int $value, int $key) {
return $value < 3;
});

// 2

컬렉션의 마지막 요소를 가져오기 위해 인수 없이 last 메서드를 호출할 수도 있습니다. 컬렉션이 비어 있으면 null가 반환됩니다.

collect([1, 2, 3, 4])->last();

// 4

lazy()

lazy 메서드는 기본 항목 배열에서 새 LazyCollection 인스턴스를 반환합니다.

$lazyCollection = collect([1, 2, 3, 4])->lazy();

$lazyCollection::class;

// Illuminate\Support\LazyCollection

$lazyCollection->all();

// [1, 2, 3, 4]

이는 많은 항목이 포함된 거대한 Collection에서 변환을 수행해야 할 때 특히 유용합니다.

$count = $hugeCollection
->lazy()
->where('country', 'FR')
->where('balance', '>', '100')
->count();

컬렉션을 LazyCollection로 변환하면 엄청난 양의 추가 메모리를 할당할 필요가 없습니다. 원래 컬렉션은 여전히 ​​_its_ 값을 메모리에 유지하지만 후속 필터는 그렇지 않습니다. 따라서 컬렉션 결과를 필터링할 때 사실상 추가 메모리가 할당되지 않습니다.

macro()

정적 macro 메서드를 사용하면 런타임에 Collection 클래스에 메서드를 추가할 수 있습니다. 자세한 내용은 컬렉션 확장 문서를 참조하세요.

make()

정적 make 메서드는 새 컬렉션 인스턴스를 생성합니다. 컬렉션 생성 섹션을 참조하세요.

use Illuminate\Support\Collection;

$collection = Collection::make([1, 2, 3]);

map()

map 메서드는 컬렉션을 반복하고 각 값을 지정된 콜백에 전달합니다. 콜백은 항목을 자유롭게 수정하고 반환하여 수정된 항목의 새로운 컬렉션을 형성합니다.

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

$multiplied = $collection->map(function (int $item, int $key) {
return $item * 2;
});

$multiplied->all();

// [2, 4, 6, 8, 10]

[!WARNING] 대부분의 다른 컬렉션 메서드와 마찬가지로 map는 새 컬렉션 인스턴스를 반환합니다. 호출된 컬렉션을 수정하지 않습니다. 원본 컬렉션을 변환하려면 transform 메서드를 사용하세요.

mapInto()

mapInto() 메서드는 컬렉션을 반복하여 생성자에 값을 전달하여 지정된 클래스의 새 인스턴스를 만듭니다.

class Currency
{
/**
* Create a new currency instance.
*/
function __construct(
public string $code,
) {}
}

$collection = collect(['USD', 'EUR', 'GBP']);

$currencies = $collection->mapInto(Currency::class);

$currencies->all();

// [Currency('USD'), Currency('EUR'), Currency('GBP')]

mapSpread()

mapSpread 메서드는 컬렉션의 항목을 반복하여 중첩된 각 항목 값을 지정된 클로저에 전달합니다. 클로저는 항목을 자유롭게 수정하고 반환할 수 있으므로 수정된 항목의 새로운 컬렉션을 형성합니다.

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

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

$sequence = $chunks->mapSpread(function (int $even, int $odd) {
return $even + $odd;
});

$sequence->all();

// [1, 5, 9, 13, 17]

mapToGroups()

mapToGroups 메서드는 주어진 클로저에 따라 컬렉션의 항목을 그룹화합니다. 클로저는 단일 키/값 쌍을 포함하는 연관 배열을 반환해야 하며, 따라서 그룹화된 값의 새로운 컬렉션을 형성해야 합니다.

$collection = collect([
[
'name' => 'John Doe',
'department' => 'Sales',
],
[
'name' => 'Jane Doe',
'department' => 'Sales',
],
[
'name' => 'Johnny Doe',
'department' => 'Marketing',
]
]);

$grouped = $collection->mapToGroups(function (array $item, int $key) {
return [$item['department'] => $item['name']];
});

$grouped->all();

/*
[
'Sales' => ['John Doe', 'Jane Doe'],
'Marketing' => ['Johnny Doe'],
]
*/

$grouped->get('Sales')->all();

// ['John Doe', 'Jane Doe']

mapWithKeys()

mapWithKeys 메서드는 컬렉션을 반복하고 각 값을 지정된 콜백에 전달합니다. 콜백은 단일 키/값 쌍을 포함하는 연관 배열을 반환해야 합니다.

$collection = collect([
[
'name' => 'John',
'department' => 'Sales',
'email' => '[email protected]',
],
[
'name' => 'Jane',
'department' => 'Marketing',
'email' => '[email protected]',
]
]);

$keyed = $collection->mapWithKeys(function (array $item, int $key) {
return [$item['email'] => $item['name']];
});

$keyed->all();

/*
[
'[email protected]' => 'John',
'[email protected]' => 'Jane',
]
*/

max()

max 메서드는 주어진 키의 최대값을 반환합니다.

$max = collect([
['foo' => 10],
['foo' => 20]
])->max('foo');

// 20

$max = collect([1, 2, 3, 4, 5])->max();

// 5

median()

median 메서드는 지정된 키의 중앙값을 반환합니다.

$median = collect([
['foo' => 10],
['foo' => 10],
['foo' => 20],
['foo' => 40]
])->median('foo');

// 15

$median = collect([1, 1, 2, 4])->median();

// 1.5

merge()

merge 메서드는 주어진 배열이나 컬렉션을 원래 컬렉션과 병합합니다. 지정된 항목의 문자열 키가 원래 컬렉션의 문자열 키와 일치하면 지정된 항목의 값이 원래 컬렉션의 값을 덮어씁니다.

$collection = collect(['product_id' => 1, 'price' => 100]);

$merged = $collection->merge(['price' => 200, 'discount' => false]);

$merged->all();

// ['product_id' => 1, 'price' => 200, 'discount' => false]

주어진 항목의 키가 숫자인 경우 값은 컬렉션의 끝에 추가됩니다.

$collection = collect(['Desk', 'Chair']);

$merged = $collection->merge(['Bookcase', 'Door']);

$merged->all();

// ['Desk', 'Chair', 'Bookcase', 'Door']

mergeRecursive()

mergeRecursive 메서드는 지정된 배열 또는 컬렉션을 원래 컬렉션과 재귀적으로 병합합니다. 지정된 항목의 문자열 키가 원래 컬렉션의 문자열 키와 일치하면 이러한 키의 값이 배열로 병합되고 이는 재귀적으로 수행됩니다.

$collection = collect(['product_id' => 1, 'price' => 100]);

$merged = $collection->mergeRecursive([
'product_id' => 2,
'price' => 200,
'discount' => false
]);

$merged->all();

// ['product_id' => [1, 2], 'price' => [100, 200], 'discount' => false]

min()

min 메서드는 주어진 키의 최소값을 반환합니다.

$min = collect([
['foo' => 10],
['foo' => 20]
])->min('foo');

// 10

$min = collect([1, 2, 3, 4, 5])->min();

// 1

mode()

mode 메서드는 지정된 키의 모드 값을 반환합니다.

$mode = collect([
['foo' => 10],
['foo' => 10],
['foo' => 20],
['foo' => 40]
])->mode('foo');

// [10]

$mode = collect([1, 1, 2, 4])->mode();

// [1]

$mode = collect([1, 1, 2, 2])->mode();

// [1, 2]

multiply()

multiply 메서드는 컬렉션의 모든 항목에 대해 지정된 수의 복사본을 생성합니다.

$users = collect([
['name' => 'User #1', 'email' => '[email protected]'],
['name' => 'User #2', 'email' => '[email protected]'],
])->multiply(3);

/*
[
['name' => 'User #1', 'email' => '[email protected]'],
['name' => 'User #2', 'email' => '[email protected]'],
['name' => 'User #1', 'email' => '[email protected]'],
['name' => 'User #2', 'email' => '[email protected]'],
['name' => 'User #1', 'email' => '[email protected]'],
['name' => 'User #2', 'email' => '[email protected]'],
]
*/

nth()

nth 메서드는 모든 n번째 요소로 구성된 새 컬렉션을 만듭니다.

$collection = collect(['a', 'b', 'c', 'd', 'e', 'f']);

$collection->nth(4);

// ['a', 'e']

선택적으로 시작 오프셋을 두 번째 인수로 전달할 수도 있습니다.

$collection->nth(4, 1);

// ['b', 'f']

only()

only 메서드는 지정된 키를 사용하여 컬렉션의 항목을 반환합니다.

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

$filtered = $collection->only(['product_id', 'name']);

$filtered->all();

// ['product_id' => 1, 'name' => 'Desk']

only의 반대에 대해서는 제외 메서드를 참조하세요.

[!NOTE] 이 메서드의 동작은 Eloquent 컬렉션을 사용할 때 수정됩니다.

pad()

pad 메서드는 배열이 지정된 크기에 도달할 때까지 주어진 값으로 배열을 채웁니다. 이 메서드는 array_pad PHP 함수처럼 작동합니다.

왼쪽을 채우려면 음수 크기를 지정해야 합니다. 주어진 크기의 절대값이 배열 길이보다 작거나 같으면 패딩이 발생하지 않습니다.

$collection = collect(['A', 'B', 'C']);

$filtered = $collection->pad(5, 0);

$filtered->all();

// ['A', 'B', 'C', 0, 0]

$filtered = $collection->pad(-5, 0);

$filtered->all();

// [0, 0, 'A', 'B', 'C']

partition()

partition 메서드는 PHP 배열 구조 분해와 결합되어 주어진 진실 테스트를 통과하는 요소를 그렇지 않은 요소와 분리할 수 있습니다.

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

[$underThree, $equalOrAboveThree] = $collection->partition(function (int $i) {
return $i < 3;
});

$underThree->all();

// [1, 2]

$equalOrAboveThree->all();

// [3, 4, 5, 6]

[!NOTE] 이 메서드의 동작은 Eloquent 컬렉션과 상호 작용할 때 수정됩니다.

percentage()

percentage 메서드를 사용하면 컬렉션에서 특정 진실성 테스트를 통과한 항목의 비율을 빠르게 확인할 수 있습니다.

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

$percentage = $collection->percentage(fn (int $value) => $value === 1);

// 33.33

기본적으로 백분율은 소수점 이하 두 자리로 반올림됩니다. 그러나 메서드에 두 번째 인수를 제공하여 이 동작을 사용자 지정할 수 있습니다.

$percentage = $collection->percentage(fn (int $value) => $value === 1, precision: 3);

// 33.333

pipe()

pipe 메서드는 컬렉션을 주어진 클로저에 전달하고 실행된 클로저의 결과를 반환합니다:

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

$piped = $collection->pipe(function (Collection $collection) {
return $collection->sum();
});

// 6

pipeInto()

pipeInto 메서드는 지정된 클래스의 새 인스턴스를 생성하고 컬렉션을 생성자에 전달합니다.

class ResourceCollection
{
/**
* Create a new ResourceCollection instance.
*/
public function __construct(
public Collection $collection,
) {}
}

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

$resource = $collection->pipeInto(ResourceCollection::class);

$resource->collection->all();

// [1, 2, 3]

pipeThrough()

pipeThrough 메서드는 컬렉션을 주어진 클로저 배열에 전달하고 실행된 클로저의 결과를 반환합니다.

use Illuminate\Support\Collection;

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

$result = $collection->pipeThrough([
function (Collection $collection) {
return $collection->merge([4, 5]);
},
function (Collection $collection) {
return $collection->sum();
},
]);

// 15

pluck()

pluck 메서드는 지정된 키에 대한 모든 값을 검색합니다.

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

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

$plucked->all();

// ['Desk', 'Chair']

결과 컬렉션의 키 지정 방식을 지정할 수도 있습니다.

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

$plucked->all();

// ['prod-100' => 'Desk', 'prod-200' => 'Chair']

pluck 메서드는 "점" 표기법을 사용하여 중첩된 값 검색도 지원합니다.

$collection = collect([
[
'name' => 'Laracon',
'speakers' => [
'first_day' => ['Rosa', 'Judith'],
],
],
[
'name' => 'VueConf',
'speakers' => [
'first_day' => ['Abigail', 'Joey'],
],
],
]);

$plucked = $collection->pluck('speakers.first_day');

$plucked->all();

// [['Rosa', 'Judith'], ['Abigail', 'Joey']]

중복된 키가 존재하는 경우 마지막으로 일치하는 요소가 추출된 컬렉션에 삽입됩니다.

$collection = collect([
['brand' => 'Tesla', 'color' => 'red'],
['brand' => 'Pagani', 'color' => 'white'],
['brand' => 'Tesla', 'color' => 'black'],
['brand' => 'Pagani', 'color' => 'orange'],
]);

$plucked = $collection->pluck('color', 'brand');

$plucked->all();

// ['Tesla' => 'black', 'Pagani' => 'orange']

pop()

pop 메서드는 컬렉션에서 마지막 항목을 제거하고 반환합니다. 컬렉션이 비어 있으면 null가 반환됩니다.

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

$collection->pop();

// 5

$collection->all();

// [1, 2, 3, 4]

컬렉션의 끝에서 여러 항목을 제거하고 반환하려면 pop 메서드에 정수를 전달할 수 있습니다.

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

$collection->pop(3);

// collect([5, 4, 3])

$collection->all();

// [1, 2]

prepend()

prepend 메서드는 컬렉션의 시작 부분에 항목을 추가합니다.

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

$collection->prepend(0);

$collection->all();

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

앞에 추가된 항목의 키를 지정하기 위해 두 번째 인수를 전달할 수도 있습니다:

$collection = collect(['one' => 1, 'two' => 2]);

$collection->prepend(0, 'zero');

$collection->all();

// ['zero' => 0, 'one' => 1, 'two' => 2]

pull()

pull 메서드는 해당 키를 사용하여 컬렉션에서 항목을 제거하고 반환합니다.

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

$collection->pull('name');

// 'Desk'

$collection->all();

// ['product_id' => 'prod-100']

push()

push 메서드는 컬렉션의 끝에 항목을 추가합니다.

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

$collection->push(5);

$collection->all();

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

컬렉션 끝에 추가할 여러 항목을 제공할 수도 있습니다.

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

$collection->push(5, 6, 7);

$collection->all();

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

put()

put 메서드는 컬렉션에 지정된 키와 값을 설정합니다.

$collection = collect(['product_id' => 1, 'name' => 'Desk']);

$collection->put('price', 100);

$collection->all();

// ['product_id' => 1, 'name' => 'Desk', 'price' => 100]

random()

random 메서드는 컬렉션에서 임의의 항목을 반환합니다.

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

$collection->random();

// 4 - (retrieved randomly)

random에 정수를 전달하여 무작위로 검색하려는 항목 수를 지정할 수 있습니다. 수신하려는 항목 수를 명시적으로 전달할 때 항목 컬렉션이 항상 반환됩니다.

$random = $collection->random(3);

$random->all();

// [2, 4, 5] - (retrieved randomly)

컬렉션 인스턴스에 요청된 것보다 적은 항목이 있는 경우 random 메서드는 InvalidArgumentException를 발생시킵니다.

random 메서드는 현재 컬렉션 인스턴스를 수신하는 클로저도 허용합니다.

use Illuminate\Support\Collection;

$random = $collection->random(fn (Collection $items) => min(10, count($items)));

$random->all();

// [1, 2, 3, 4, 5] - (retrieved randomly)

range()

range 메서드는 지정된 범위 사이의 정수를 포함하는 컬렉션을 반환합니다.

$collection = collect()->range(3, 6);

$collection->all();

// [3, 4, 5, 6]

reduce()

reduce 메서드는 컬렉션을 단일 값으로 줄여 각 반복의 결과를 후속 반복에 전달합니다.

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

$total = $collection->reduce(function (?int $carry, int $item) {
return $carry + $item;
});

// 6

첫 번째 반복에서 $carry의 값은 null입니다. 그러나 reduce에 두 번째 인수를 전달하여 초기 값을 지정할 수 있습니다.

$collection->reduce(function (int $carry, int $item) {
return $carry + $item;
}, 4);

// 10

reduce 메서드는 또한 배열 키를 지정된 콜백에 전달합니다.

$collection = collect([
'usd' => 1400,
'gbp' => 1200,
'eur' => 1000,
]);

$ratio = [
'usd' => 1,
'gbp' => 1.37,
'eur' => 1.22,
];

$collection->reduce(function (int $carry, int $value, string $key) use ($ratio) {
return $carry + ($value * $ratio[$key]);
}, 0);

// 4264

reduceSpread()

reduceSpread 메서드는 컬렉션을 값 배열로 줄여 각 반복의 결과를 후속 반복에 전달합니다. 이 메서드는 reduce 메서드와 유사합니다. 그러나 여러 초기값을 허용할 수 있습니다.

[$creditsRemaining, $batch] = Image::where('status', 'unprocessed')
->get()
->reduceSpread(function (int $creditsRemaining, Collection $batch, Image $image) {
if ($creditsRemaining >= $image->creditsRequired()) {
$batch->push($image);

$creditsRemaining -= $image->creditsRequired();
}

return [$creditsRemaining, $batch];
}, $creditsAvailable, collect());

reject()

reject 메서드는 주어진 클로저를 사용하여 컬렉션을 필터링합니다. 결과 컬렉션에서 항목을 제거해야 하는 경우 클로저는 true를 반환해야 합니다.

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

$filtered = $collection->reject(function (int $value, int $key) {
return $value > 2;
});

$filtered->all();

// [1, 2]

reject 메서드의 반대에 대해서는 filter 메서드를 참조하세요.

replace()

replace 메서드는 merge와 유사하게 동작합니다. 그러나 문자열 키가 있는 일치 항목을 덮어쓰는 것 외에도 replace 메서드는 일치하는 숫자 키가 있는 컬렉션의 항목도 덮어씁니다.

$collection = collect(['Taylor', 'Abigail', 'James']);

$replaced = $collection->replace([1 => 'Victoria', 3 => 'Finn']);

$replaced->all();

// ['Taylor', 'Victoria', 'James', 'Finn']

replaceRecursive()

replaceRecursive 메서드는 replace와 유사하게 동작하지만 배열로 반복되고 내부 값에 동일한 대체 프로세스를 적용합니다.

$collection = collect([
'Taylor',
'Abigail',
[
'James',
'Victoria',
'Finn'
]
]);

$replaced = $collection->replaceRecursive([
'Charlie',
2 => [1 => 'King']
]);

$replaced->all();

// ['Charlie', 'Abigail', ['James', 'King', 'Finn']]

reverse()

reverse 메서드는 원래 키를 유지하면서 컬렉션 항목의 순서를 반대로 바꿉니다.

$collection = collect(['a', 'b', 'c', 'd', 'e']);

$reversed = $collection->reverse();

$reversed->all();

/*
[
4 => 'e',
3 => 'd',
2 => 'c',
1 => 'b',
0 => 'a',
]
*/

search 메서드는 컬렉션에서 지정된 값을 검색하고 해당 값이 있으면 해당 키를 반환합니다. 항목을 찾을 수 없으면 false가 반환됩니다.

$collection = collect([2, 4, 6, 8]);

$collection->search(4);

// 1

검색은 "느슨한" 비교를 사용하여 수행됩니다. 즉, 정수 값이 있는 문자열은 동일한 값의 정수와 동일한 것으로 간주됩니다. "엄격한" 비교를 사용하려면 true를 메서드의 두 번째 인수로 전달합니다.

collect([2, 4, 6, 8])->search('4', strict: true);

// false

또는 주어진 진실성 테스트를 통과한 첫 번째 항목을 검색하기 위해 자체 클로저를 제공할 수도 있습니다.

collect([2, 4, 6, 8])->search(function (int $item, int $key) {
return $item > 5;
});

// 2

select()

select 메서드는 SQL SELECT 문과 유사하게 컬렉션에서 지정된 키를 선택합니다.

$users = collect([
['name' => 'Taylor Otwell', 'role' => 'Developer', 'status' => 'active'],
['name' => 'Victoria Faith', 'role' => 'Researcher', 'status' => 'active'],
]);

$users->select(['name', 'role']);

/*
[
['name' => 'Taylor Otwell', 'role' => 'Developer'],
['name' => 'Victoria Faith', 'role' => 'Researcher'],
],
*/

shift()

shift 메서드는 컬렉션에서 첫 번째 항목을 제거하고 반환합니다.

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

$collection->shift();

// 1

$collection->all();

// [2, 3, 4, 5]

컬렉션 시작 부분에서 여러 항목을 제거하고 반환하려면 shift 메서드에 정수를 전달할 수 있습니다.

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

$collection->shift(3);

// collect([1, 2, 3])

$collection->all();

// [4, 5]

shuffle()

shuffle 메서드는 컬렉션의 항목을 무작위로 섞습니다.

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

$shuffled = $collection->shuffle();

$shuffled->all();

// [3, 2, 5, 1, 4] - (generated randomly)

skip()

skip 메서드는 컬렉션 시작 부분에서 지정된 수의 요소가 제거된 새 컬렉션을 반환합니다.

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

$collection = $collection->skip(4);

$collection->all();

// [5, 6, 7, 8, 9, 10]

skipUntil()

skipUntil 메서드는 지정된 콜백이 false를 반환하는 동안 컬렉션의 항목을 건너뜁니다. 콜백이 true를 반환하면 컬렉션의 나머지 모든 항목이 새 컬렉션으로 반환됩니다.

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

$subset = $collection->skipUntil(function (int $item) {
return $item >= 3;
});

$subset->all();

// [3, 4]

skipUntil 메서드에 간단한 값을 전달하여 주어진 값을 찾을 때까지 모든 항목을 건너뛸 수도 있습니다.

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

$subset = $collection->skipUntil(3);

$subset->all();

// [3, 4]

[!WARNING] 지정된 값을 찾을 수 없거나 콜백이 true를 반환하지 않는 경우 skipUntil 메서드는 빈 컬렉션을 반환합니다.

skipWhile()

skipWhile 메서드는 지정된 콜백이 true를 반환하는 동안 컬렉션의 항목을 건너뜁니다. 콜백이 false를 반환하면 컬렉션의 나머지 모든 항목이 새 컬렉션으로 반환됩니다.

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

$subset = $collection->skipWhile(function (int $item) {
return $item <= 3;
});

$subset->all();

// [4]

[!WARNING] 콜백이 false를 반환하지 않으면 skipWhile 메서드는 빈 컬렉션을 반환합니다.

slice()

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]

반환된 조각의 크기를 제한하려면 원하는 크기를 메서드의 두 번째 인수로 전달합니다.

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

$slice->all();

// [5, 6]

반환된 슬라이스는 기본적으로 키를 유지합니다. 원래 키를 유지하지 않으려면 values 메서드를 사용하여 다시 색인을 생성할 수 있습니다.

sliding()

sliding 메서드는 컬렉션에 있는 항목의 "슬라이딩 창" 뷰을 나타내는 새로운 청크 컬렉션을 반환합니다.

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

$chunks = $collection->sliding(2);

$chunks->toArray();

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

이는 eachSpread 메서드와 함께 사용하면 특히 유용합니다.

$transactions->sliding(2)->eachSpread(function (Collection $previous, Collection $current) {
$current->total = $previous->total + $current->amount;
});

선택적으로 두 번째 "step" 값을 전달할 수도 있습니다. 이 값은 모든 청크의 첫 번째 항목 사이의 거리를 결정합니다.

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

$chunks = $collection->sliding(3, step: 2);

$chunks->toArray();

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

sole()

sole 메서드는 주어진 진실성 테스트를 통과한 컬렉션의 첫 번째 요소를 반환합니다. 단, 진실성 테스트가 정확히 하나의 요소와 일치하는 경우에만 해당됩니다.

collect([1, 2, 3, 4])->sole(function (int $value, int $key) {
return $value === 2;
});

// 2

또한 키/값 쌍을 sole 메서드에 전달할 수도 있습니다. 이 메서드는 주어진 쌍과 일치하는 컬렉션의 첫 번째 요소를 반환하지만 정확히 하나의 요소가 일치하는 경우에만 가능합니다.

$collection = collect([
['product' => 'Desk', 'price' => 200],
['product' => 'Chair', 'price' => 100],
]);

$collection->sole('product', 'Chair');

// ['product' => 'Chair', 'price' => 100]

또는 요소가 하나만 있는 경우 컬렉션의 첫 번째 요소를 가져오기 위해 인수 없이 sole 메서드를 호출할 수도 있습니다.

$collection = collect([
['product' => 'Desk', 'price' => 200],
]);

$collection->sole();

// ['product' => 'Desk', 'price' => 200]

컬렉션에 sole 메서드에서 반환해야 하는 요소가 없으면 \Illuminate\Collections\ItemNotFoundException 예외가 발생합니다. 반환해야 하는 요소가 두 개 이상인 경우 \Illuminate\Collections\MultipleItemsFoundException가 발생합니다.

some()

contains 메서드의 별칭입니다.

sort()

sort 메서드는 컬렉션을 정렬합니다. 정렬된 컬렉션은 원래 배열 키를 유지하므로 다음 예에서는 values 메서드를 사용하여 키를 연속 번호가 지정된 인덱스로 재설정합니다.

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

$sorted = $collection->sort();

$sorted->values()->all();

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

정렬 요구 사항이 더 고급인 경우 자체 알고리즘을 사용하여 sort에 콜백을 전달할 수 있습니다. 컬렉션의 sort 메서드 호출이 내부적으로 활용하는 uasort에 대한 PHP 문서를 참조하세요.

[!NOTE] 중첩된 배열 또는 객체 컬렉션을 정렬해야 하는 경우 sortBysortByDesc 메서드를 참조하세요.

sortBy()

sortBy 메서드는 주어진 키를 기준으로 컬렉션을 정렬합니다. 정렬된 컬렉션은 원래 배열 키를 유지하므로 다음 예에서는 values 메서드를 사용하여 키를 연속 번호가 지정된 인덱스로 재설정합니다.

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

$sorted = $collection->sortBy('price');

$sorted->values()->all();

/*
[
['name' => 'Chair', 'price' => 100],
['name' => 'Bookcase', 'price' => 150],
['name' => 'Desk', 'price' => 200],
]
*/

sortBy 메서드는 정렬 플래그를 두 번째 인수로 허용합니다.

$collection = collect([
['title' => 'Item 1'],
['title' => 'Item 12'],
['title' => 'Item 3'],
]);

$sorted = $collection->sortBy('title', SORT_NATURAL);

$sorted->values()->all();

/*
[
['title' => 'Item 1'],
['title' => 'Item 3'],
['title' => 'Item 12'],
]
*/

또는 컬렉션의 값을 정렬하는 방식을 결정하기 위해 자체 클로저를 전달할 수도 있습니다.

$collection = collect([
['name' => 'Desk', 'colors' => ['Black', 'Mahogany']],
['name' => 'Chair', 'colors' => ['Black']],
['name' => 'Bookcase', 'colors' => ['Red', 'Beige', 'Brown']],
]);

$sorted = $collection->sortBy(function (array $product, int $key) {
return count($product['colors']);
});

$sorted->values()->all();

/*
[
['name' => 'Chair', 'colors' => ['Black']],
['name' => 'Desk', 'colors' => ['Black', 'Mahogany']],
['name' => 'Bookcase', 'colors' => ['Red', 'Beige', 'Brown']],
]
*/

여러 속성을 기준으로 컬렉션을 정렬하려면 정렬 작업 배열을 sortBy 메서드에 전달할 수 있습니다. 각 정렬 작업은 정렬하려는 속성과 원하는 정렬 방향으로 구성된 배열이어야 합니다.

$collection = collect([
['name' => 'Taylor Otwell', 'age' => 34],
['name' => 'Abigail Otwell', 'age' => 30],
['name' => 'Taylor Otwell', 'age' => 36],
['name' => 'Abigail Otwell', 'age' => 32],
]);

$sorted = $collection->sortBy([
['name', 'asc'],
['age', 'desc'],
]);

$sorted->values()->all();

/*
[
['name' => 'Abigail Otwell', 'age' => 32],
['name' => 'Abigail Otwell', 'age' => 30],
['name' => 'Taylor Otwell', 'age' => 36],
['name' => 'Taylor Otwell', 'age' => 34],
]
*/

여러 속성으로 컬렉션을 정렬할 때 각 정렬 작업을 정의하는 클로저를 제공할 수도 있습니다.

$collection = collect([
['name' => 'Taylor Otwell', 'age' => 34],
['name' => 'Abigail Otwell', 'age' => 30],
['name' => 'Taylor Otwell', 'age' => 36],
['name' => 'Abigail Otwell', 'age' => 32],
]);

$sorted = $collection->sortBy([
fn (array $a, array $b) => $a['name'] <=> $b['name'],
fn (array $a, array $b) => $b['age'] <=> $a['age'],
]);

$sorted->values()->all();

/*
[
['name' => 'Abigail Otwell', 'age' => 32],
['name' => 'Abigail Otwell', 'age' => 30],
['name' => 'Taylor Otwell', 'age' => 36],
['name' => 'Taylor Otwell', 'age' => 34],
]
*/

sortByDesc()

이 메서드는 sortBy 메서드와 동일한 시그니처를 갖지만 컬렉션을 반대 순서로 정렬합니다.

sortDesc()

이 메서드는 sort 메서드와 반대 순서로 컬렉션을 정렬합니다.

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

$sorted = $collection->sortDesc();

$sorted->values()->all();

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

sort와 달리 sortDesc에 클로저를 전달할 수 없습니다. 대신 sort 메서드를 사용하고 비교를 거꾸로 해야 합니다.

sortKeys()

sortKeys 메서드는 기본 연관 배열의 키를 기준으로 컬렉션을 정렬합니다.

$collection = collect([
'id' => 22345,
'first' => 'John',
'last' => 'Doe',
]);

$sorted = $collection->sortKeys();

$sorted->all();

/*
[
'first' => 'John',
'id' => 22345,
'last' => 'Doe',
]
*/

sortKeysDesc()

이 메서드는 sortKeys 메서드와 동일한 서명을 갖지만 컬렉션을 반대 순서로 정렬합니다.

sortKeysUsing()

sortKeysUsing 메서드는 콜백을 사용하여 기본 연관 배열의 키를 기준으로 컬렉션을 정렬합니다.

$collection = collect([
'ID' => 22345,
'first' => 'John',
'last' => 'Doe',
]);

$sorted = $collection->sortKeysUsing('strnatcasecmp');

$sorted->all();

/*
[
'first' => 'John',
'ID' => 22345,
'last' => 'Doe',
]
*/

콜백은 0보다 작거나 같거나 큰 정수를 반환하는 비교 함수여야 합니다. 자세한 내용은 sortKeysUsing 메서드가 내부적으로 활용하는 PHP 함수인 uksort의 PHP 문서를 참조하세요.

splice()

splice 메서드는 지정된 인덱스에서 시작하는 항목 조각을 제거하고 반환합니다.

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

$chunk = $collection->splice(2);

$chunk->all();

// [3, 4, 5]

$collection->all();

// [1, 2]

결과 컬렉션의 크기를 제한하기 위해 두 번째 인수를 전달할 수 있습니다:

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

$chunk = $collection->splice(2, 1);

$chunk->all();

// [3]

$collection->all();

// [1, 2, 4, 5]

또한 컬렉션에서 제거된 항목을 대체하기 위해 새 항목이 포함된 세 번째 인수를 전달할 수도 있습니다.

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

$chunk = $collection->splice(2, 1, [10, 11]);

$chunk->all();

// [3]

$collection->all();

// [1, 2, 10, 11, 4, 5]

split()

split 메서드는 컬렉션을 지정된 수의 그룹으로 나눕니다.

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

$groups = $collection->split(3);

$groups->all();

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

splitIn()

splitIn 메서드는 컬렉션을 지정된 수의 그룹으로 나누어 비종단 그룹을 완전히 채우고 나머지를 최종 그룹에 할당합니다.

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

$groups = $collection->splitIn(3);

$groups->all();

// [[1, 2, 3, 4], [5, 6, 7, 8], [9, 10]]

sum()

sum 메서드는 컬렉션에 있는 모든 항목의 합계를 반환합니다.

collect([1, 2, 3, 4, 5])->sum();

// 15

컬렉션에 중첩된 배열이나 개체가 포함된 경우 합산할 값을 결정하는 데 사용되는 키를 전달해야 합니다.

$collection = collect([
['name' => 'JavaScript: The Good Parts', 'pages' => 176],
['name' => 'JavaScript: The Definitive Guide', 'pages' => 1096],
]);

$collection->sum('pages');

// 1272

게다가, 합산할 컬렉션의 값을 결정하기 위해 자신만의 클로저를 전달할 수도 있습니다:

$collection = collect([
['name' => 'Chair', 'colors' => ['Black']],
['name' => 'Desk', 'colors' => ['Black', 'Mahogany']],
['name' => 'Bookcase', 'colors' => ['Red', 'Beige', 'Brown']],
]);

$collection->sum(function (array $product) {
return count($product['colors']);
});

// 6

take()

take 메서드는 지정된 수의 항목이 포함된 새 컬렉션을 반환합니다.

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

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

$chunk->all();

// [0, 1, 2]

컬렉션 끝에서 지정된 수의 항목을 가져오려면 음의 정수를 전달할 수도 있습니다.

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

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

$chunk->all();

// [4, 5]

takeUntil()

takeUntil 메서드는 지정된 콜백이 true를 반환할 때까지 컬렉션의 항목을 반환합니다.

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

$subset = $collection->takeUntil(function (int $item) {
return $item >= 3;
});

$subset->all();

// [1, 2]

또한 주어진 값을 찾을 때까지 항목을 가져오기 위해 takeUntil 메서드에 간단한 값을 전달할 수도 있습니다.

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

$subset = $collection->takeUntil(3);

$subset->all();

// [1, 2]

[!WARNING] 지정된 값을 찾을 수 없거나 콜백이 true를 반환하지 않는 경우 takeUntil 메서드는 컬렉션의 모든 항목을 반환합니다.

takeWhile()

takeWhile 메서드는 지정된 콜백이 false를 반환할 때까지 컬렉션의 항목을 반환합니다.

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

$subset = $collection->takeWhile(function (int $item) {
return $item < 3;
});

$subset->all();

// [1, 2]

[!WARNING] 콜백이 false를 반환하지 않으면 takeWhile 메서드는 컬렉션의 모든 항목을 반환합니다.

tap()

tap 메서드는 컬렉션을 지정된 콜백에 전달하여 특정 지점에서 컬렉션을 "탭"하고 컬렉션 자체에 영향을 주지 않으면서 항목에 대해 작업을 수행할 수 있도록 합니다. 그런 다음 컬렉션은 tap 메서드에 의해 반환됩니다.

collect([2, 4, 3, 1, 5])
->sort()
->tap(function (Collection $collection) {
Log::debug('Values after sorting', $collection->values()->all());
})
->shift();

// 1

times()

정적 times 메서드는 지정된 클로저를 지정된 횟수만큼 호출하여 새 컬렉션을 생성합니다.

$collection = Collection::times(10, function (int $number) {
return $number * 9;
});

$collection->all();

// [9, 18, 27, 36, 45, 54, 63, 72, 81, 90]

toArray()

toArray 메서드는 컬렉션을 일반 PHP array로 변환합니다. 컬렉션의 값이 Eloquent 모델인 경우 모델도 배열로 변환됩니다.

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

$collection->toArray();

/*
[
['name' => 'Desk', 'price' => 200],
]
*/

[!WARNING] toArray는 또한 Arrayable의 인스턴스인 컬렉션의 모든 중첩 개체를 배열로 변환합니다. 컬렉션의 기본이 되는 원시 배열을 얻으려면 대신 all 메서드를 사용하세요.

toJson()

toJson 메서드는 컬렉션을 JSON 직렬화된 문자열로 변환합니다.

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

$collection->toJson();

// '{"name":"Desk", "price":200}'

toPrettyJson()

toPrettyJson 메서드는 JSON_PRETTY_PRINT 옵션을 사용하여 컬렉션을 형식이 지정된 JSON 문자열로 변환합니다.

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

$collection->toPrettyJson();

transform()

transform 메서드는 컬렉션을 반복하고 컬렉션의 각 항목에 대해 지정된 콜백을 호출합니다. 컬렉션의 항목은 콜백에서 반환된 값으로 대체됩니다.

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

$collection->transform(function (int $item, int $key) {
return $item * 2;
});

$collection->all();

// [2, 4, 6, 8, 10]

[!WARNING] 대부분의 다른 컬렉션 메서드와 달리 transform는 컬렉션 자체를 수정합니다. 대신 새 컬렉션을 생성하려면 map 메서드를 사용하세요.

undot()

undot 메서드는 "점" 표기법을 사용하는 1차원 컬렉션을 다차원 컬렉션으로 확장합니다.

$person = collect([
'name.first_name' => 'Marie',
'name.last_name' => 'Valentine',
'address.line_1' => '2992 Eagle Drive',
'address.line_2' => '',
'address.suburb' => 'Detroit',
'address.state' => 'MI',
'address.postcode' => '48219'
]);

$person = $person->undot();

$person->toArray();

/*
[
"name" => [
"first_name" => "Marie",
"last_name" => "Valentine",
],
"address" => [
"line_1" => "2992 Eagle Drive",
"line_2" => "",
"suburb" => "Detroit",
"state" => "MI",
"postcode" => "48219",
],
]
*/

union()

union 메서드는 주어진 배열을 컬렉션에 추가합니다. 주어진 배열에 원래 컬렉션에 이미 있는 키가 포함되어 있으면 원래 컬렉션의 값이 선호됩니다.

$collection = collect([1 => ['a'], 2 => ['b']]);

$union = $collection->union([3 => ['c'], 1 => ['d']]);

$union->all();

// [1 => ['a'], 2 => ['b'], 3 => ['c']]

unique()

unique 메서드는 컬렉션의 모든 고유 항목을 반환합니다. 반환된 컬렉션은 원래 배열 키를 유지하므로 다음 예에서는 values 메서드를 사용하여 키를 연속 번호가 지정된 인덱스로 재설정합니다.

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

$unique = $collection->unique();

$unique->values()->all();

// [1, 2, 3, 4]

중첩된 배열이나 객체를 처리할 때 고유성을 결정하는 데 사용되는 키를 지정할 수 있습니다.

$collection = collect([
['name' => 'iPhone 6', 'brand' => 'Apple', 'type' => 'phone'],
['name' => 'iPhone 5', 'brand' => 'Apple', 'type' => 'phone'],
['name' => 'Apple Watch', 'brand' => 'Apple', 'type' => 'watch'],
['name' => 'Galaxy S6', 'brand' => 'Samsung', 'type' => 'phone'],
['name' => 'Galaxy Gear', 'brand' => 'Samsung', 'type' => 'watch'],
]);

$unique = $collection->unique('brand');

$unique->values()->all();

/*
[
['name' => 'iPhone 6', 'brand' => 'Apple', 'type' => 'phone'],
['name' => 'Galaxy S6', 'brand' => 'Samsung', 'type' => 'phone'],
]
*/

마지막으로, 항목의 고유성을 결정해야 하는 값을 지정하기 위해 unique 메서드에 자체 클로저를 전달할 수도 있습니다.

$unique = $collection->unique(function (array $item) {
return $item['brand'].$item['type'];
});

$unique->values()->all();

/*
[
['name' => 'iPhone 6', 'brand' => 'Apple', 'type' => 'phone'],
['name' => 'Apple Watch', 'brand' => 'Apple', 'type' => 'watch'],
['name' => 'Galaxy S6', 'brand' => 'Samsung', 'type' => 'phone'],
['name' => 'Galaxy Gear', 'brand' => 'Samsung', 'type' => 'watch'],
]
*/

unique 메서드는 항목 값을 확인할 때 "느슨한" 비교를 사용합니다. 즉, 정수 값이 있는 문자열은 동일한 값의 정수와 동일한 것으로 간주됩니다. "엄격한" 비교를 사용하여 필터링하려면 uniqueStrict 메서드를 사용하세요.

[!NOTE] 이 메서드의 동작은 Eloquent 컬렉션을 사용할 때 수정됩니다.

uniqueStrict()

이 메서드는 unique 메서드와 동일한 시그니처를 갖습니다. 그러나 모든 값은 "엄격한" 비교를 사용하여 비교됩니다.

unless()

unless 메서드는 메서드에 제공된 첫 번째 인수가 true로 평가되지 않는 한 지정된 콜백을 실행합니다. unless 메서드에 제공된 컬렉션 인스턴스와 첫 번째 인수는 클로저에 제공됩니다.

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

$collection->unless(true, function (Collection $collection, bool $value) {
return $collection->push(4);
});

$collection->unless(false, function (Collection $collection, bool $value) {
return $collection->push(5);
});

$collection->all();

// [1, 2, 3, 5]

두 번째 콜백은 unless 메서드에 전달될 수 있습니다. 두 번째 콜백은 unless 메서드에 제공된 첫 번째 인수가 true로 평가될 때 실행됩니다.

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

$collection->unless(true, function (Collection $collection, bool $value) {
return $collection->push(4);
}, function (Collection $collection, bool $value) {
return $collection->push(5);
});

$collection->all();

// [1, 2, 3, 5]

unless의 반대에 대해서는 when 메서드를 참조하세요.

unlessEmpty()

whenNotEmpty 메서드의 별칭입니다.

unlessNotEmpty()

whenEmpty 메서드의 별칭입니다.

unwrap()

정적 unwrap 메서드는 해당되는 경우 주어진 값에서 컬렉션의 기본 항목을 반환합니다.

Collection::unwrap(collect('John Doe'));

// ['John Doe']

Collection::unwrap(['John Doe']);

// ['John Doe']

Collection::unwrap('John Doe');

// 'John Doe'

value()

value 메서드는 컬렉션의 첫 번째 요소에서 지정된 값을 검색합니다.

$collection = collect([
['product' => 'Desk', 'price' => 200],
['product' => 'Speaker', 'price' => 400],
]);

$value = $collection->value('price');

// 200

values()

values 메서드는 키가 연속된 정수로 재설정된 새 컬렉션을 반환합니다.

$collection = collect([
10 => ['product' => 'Desk', 'price' => 200],
11 => ['product' => 'Speaker', 'price' => 400],
]);

$values = $collection->values();

$values->all();

/*
[
0 => ['product' => 'Desk', 'price' => 200],
1 => ['product' => 'Speaker', 'price' => 400],
]
*/

when()

when 메서드는 메서드에 제공된 첫 번째 인수가 true로 평가될 때 지정된 콜백을 실행합니다. when 메서드에 제공된 컬렉션 인스턴스와 첫 번째 인수는 클로저에 제공됩니다.

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

$collection->when(true, function (Collection $collection, bool $value) {
return $collection->push(4);
});

$collection->when(false, function (Collection $collection, bool $value) {
return $collection->push(5);
});

$collection->all();

// [1, 2, 3, 4]

두 번째 콜백은 when 메서드에 전달될 수 있습니다. 두 번째 콜백은 when 메서드에 제공된 첫 번째 인수가 false로 평가될 때 실행됩니다.

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

$collection->when(false, function (Collection $collection, bool $value) {
return $collection->push(4);
}, function (Collection $collection, bool $value) {
return $collection->push(5);
});

$collection->all();

// [1, 2, 3, 5]

when의 반대에 대해서는 unless 메서드를 참조하세요.

whenEmpty()

whenEmpty 메서드는 컬렉션이 비어 있을 때 지정된 콜백을 실행합니다.

$collection = collect(['Michael', 'Tom']);

$collection->whenEmpty(function (Collection $collection) {
return $collection->push('Adam');
});

$collection->all();

// ['Michael', 'Tom']

$collection = collect();

$collection->whenEmpty(function (Collection $collection) {
return $collection->push('Adam');
});

$collection->all();

// ['Adam']

컬렉션이 비어 있지 않을 때 실행될 whenEmpty 메서드에 두 번째 클로저가 전달될 수 있습니다.

$collection = collect(['Michael', 'Tom']);

$collection->whenEmpty(function (Collection $collection) {
return $collection->push('Adam');
}, function (Collection $collection) {
return $collection->push('Taylor');
});

$collection->all();

// ['Michael', 'Tom', 'Taylor']

whenEmpty의 반대에 대해서는 whenNotEmpty 메서드를 참조하세요.

whenNotEmpty()

whenNotEmpty 메서드는 컬렉션이 비어 있지 않을 때 지정된 콜백을 실행합니다.

$collection = collect(['Michael', 'Tom']);

$collection->whenNotEmpty(function (Collection $collection) {
return $collection->push('Adam');
});

$collection->all();

// ['Michael', 'Tom', 'Adam']

$collection = collect();

$collection->whenNotEmpty(function (Collection $collection) {
return $collection->push('Adam');
});

$collection->all();

// []

두 번째 클로저는 컬렉션이 비어 있을 때 실행될 whenNotEmpty 메서드에 전달될 수 있습니다.

$collection = collect();

$collection->whenNotEmpty(function (Collection $collection) {
return $collection->push('Adam');
}, function (Collection $collection) {
return $collection->push('Taylor');
});

$collection->all();

// ['Taylor']

whenNotEmpty의 반대에 대해서는 whenEmpty 메서드를 참조하세요.

where()

where 메서드는 주어진 키/값 쌍으로 컬렉션을 필터링합니다.

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

where 메서드는 항목 값을 확인할 때 "느슨한" 비교를 사용합니다. 즉, 정수 값이 있는 문자열은 동일한 값의 정수와 동일한 것으로 간주됩니다. "엄격한" 비교를 사용하여 필터링하려면 whereStrict 메서드를 사용하고, null 값을 필터링하려면 whereNullwhereNotNull 메서드를 사용하세요.

선택적으로 비교 연산자를 두 번째 매개변수로 전달할 수도 있습니다. 지원되는 연산자는 ===, !==, !=, ==, =, <>, >, <, >=<=입니다.

$collection = collect([
['name' => 'Jim', 'platform' => 'Mac'],
['name' => 'Sally', 'platform' => 'Mac'],
['name' => 'Sue', 'platform' => 'Linux'],
]);

$filtered = $collection->where('platform', '!=', 'Linux');

$filtered->all();

/*
[
['name' => 'Jim', 'platform' => 'Mac'],
['name' => 'Sally', 'platform' => 'Mac'],
]
*/

whereStrict()

이 메서드는 where 메서드와 동일한 서명을 갖습니다. 그러나 모든 값은 "엄격한" 비교를 사용하여 비교됩니다.

whereBetween()

whereBetween 메서드는 지정된 항목 값이 지정된 범위 내에 있는지 확인하여 컬렉션을 필터링합니다.

$collection = collect([
['product' => 'Desk', 'price' => 200],
['product' => 'Chair', 'price' => 80],
['product' => 'Bookcase', 'price' => 150],
['product' => 'Pencil', 'price' => 30],
['product' => 'Door', 'price' => 100],
]);

$filtered = $collection->whereBetween('price', [100, 200]);

$filtered->all();

/*
[
['product' => 'Desk', 'price' => 200],
['product' => 'Bookcase', 'price' => 150],
['product' => 'Door', 'price' => 100],
]
*/

whereIn()

whereIn 메서드는 지정된 배열 내에 포함된 지정된 항목 값이 없는 컬렉션에서 요소를 제거합니다.

$collection = collect([
['product' => 'Desk', 'price' => 200],
['product' => 'Chair', 'price' => 100],
['product' => 'Bookcase', 'price' => 150],
['product' => 'Door', 'price' => 100],
]);

$filtered = $collection->whereIn('price', [150, 200]);

$filtered->all();

/*
[
['product' => 'Desk', 'price' => 200],
['product' => 'Bookcase', 'price' => 150],
]
*/

whereIn 메서드는 항목 값을 확인할 때 "느슨한" 비교를 사용합니다. 즉, 정수 값이 있는 문자열은 동일한 값의 정수와 동일한 것으로 간주됩니다. "엄격한" 비교를 사용하여 필터링하려면 whereInStrict 메서드를 사용하세요.

whereInStrict()

이 메서드는 whereIn 메서드와 동일한 서명을 갖습니다. 그러나 모든 값은 "엄격한" 비교를 사용하여 비교됩니다.

whereInstanceOf()

whereInstanceOf 메서드는 주어진 클래스 유형으로 컬렉션을 필터링합니다.

use App\Models\User;
use App\Models\Post;

$collection = collect([
new User,
new User,
new Post,
]);

$filtered = $collection->whereInstanceOf(User::class);

$filtered->all();

// [App\Models\User, App\Models\User]

whereNotBetween()

whereNotBetween 메서드는 지정된 항목 값이 지정된 범위를 벗어나는지 확인하여 컬렉션을 필터링합니다.

$collection = collect([
['product' => 'Desk', 'price' => 200],
['product' => 'Chair', 'price' => 80],
['product' => 'Bookcase', 'price' => 150],
['product' => 'Pencil', 'price' => 30],
['product' => 'Door', 'price' => 100],
]);

$filtered = $collection->whereNotBetween('price', [100, 200]);

$filtered->all();

/*
[
['product' => 'Chair', 'price' => 80],
['product' => 'Pencil', 'price' => 30],
]
*/

whereNotIn()

whereNotIn 메서드는 지정된 배열 내에 포함된 지정된 항목 값이 있는 컬렉션에서 요소를 제거합니다.

$collection = collect([
['product' => 'Desk', 'price' => 200],
['product' => 'Chair', 'price' => 100],
['product' => 'Bookcase', 'price' => 150],
['product' => 'Door', 'price' => 100],
]);

$filtered = $collection->whereNotIn('price', [150, 200]);

$filtered->all();

/*
[
['product' => 'Chair', 'price' => 100],
['product' => 'Door', 'price' => 100],
]
*/

whereNotIn 메서드는 항목 값을 확인할 때 "느슨한" 비교를 사용합니다. 즉, 정수 값이 있는 문자열은 동일한 값의 정수와 동일한 것으로 간주됩니다. "엄격한" 비교를 사용하여 필터링하려면 whereNotInStrict 메서드를 사용하세요.

whereNotInStrict()

이 메서드는 whereNotIn 메서드와 동일한 서명을 갖습니다. 그러나 모든 값은 "엄격한" 비교를 사용하여 비교됩니다.

whereNotNull()

whereNotNull 메서드는 주어진 키가 null가 아닌 컬렉션에서 항목을 반환합니다.

$collection = collect([
['name' => 'Desk'],
['name' => null],
['name' => 'Bookcase'],
['name' => 0],
['name' => ''],
]);

$filtered = $collection->whereNotNull('name');

$filtered->all();

/*
[
['name' => 'Desk'],
['name' => 'Bookcase'],
['name' => 0],
['name' => ''],
]
*/

whereNull()

whereNull 메서드는 지정된 키가 null인 컬렉션에서 항목을 반환합니다.

$collection = collect([
['name' => 'Desk'],
['name' => null],
['name' => 'Bookcase'],
['name' => 0],
['name' => ''],
]);

$filtered = $collection->whereNull('name');

$filtered->all();

/*
[
['name' => null],
]
*/

wrap()

정적 wrap 메서드는 해당되는 경우 컬렉션에 지정된 값을 래핑합니다.

use Illuminate\Support\Collection;

$collection = Collection::wrap('John Doe');

$collection->all();

// ['John Doe']

$collection = Collection::wrap(['John Doe']);

$collection->all();

// ['John Doe']

$collection = Collection::wrap(collect('John Doe'));

$collection->all();

// ['John Doe']

zip()

zip 메서드는 주어진 배열의 값을 해당 인덱스에 있는 원본 컬렉션의 값과 함께 병합합니다.

$collection = collect(['Chair', 'Desk']);

$zipped = $collection->zip([100, 200]);

$zipped->all();

// [['Chair', 100], ['Desk', 200]]

고차원 메시지 (Higher Order Messages)

컬렉션은 컬렉션에 대한 일반적인 작업을 수행하기 위한 바로 가기인 "고차 메시지"에 대한 지원도 제공합니다. 고차 메시지를 제공하는 컬렉션 메서드는 다음과 같습니다: 평균, 평균, 포함, 각각, 모두, 필터, 첫 번째, 플랫맵, 그룹별, 키바이, , 최대, 최소, 파티션, 거부, skipUntil, skipWhile, 일부, sortBy, sortByDesc, sum, takeUntil, takeWhile고유.

각 고차 메시지는 컬렉션 인스턴스의 동적 속성으로 액세스할 수 있습니다. 예를 들어 each 고차 메시지를 사용하여 컬렉션 내의 각 개체에 대한 메서드를 호출해 보겠습니다.

use App\Models\User;

$users = User::where('votes', '>', 500)->get();

$users->each->markAsVip();

마찬가지로 sum 고차 메시지를 사용하여 사용자 모음에 대한 총 "투표" 수를 수집할 수 있습니다.

$users = User::where('group', 'Development')->get();

return $users->sum->votes;

Lazy 컬렉션 (Lazy Collections)

소개

[!WARNING] Laravel의 Lazy 컬렉션에 대해 자세히 알아보기 전에 시간을 내어 PHP 생성기에 익숙해지세요.

이미 강력한 Collection 클래스를 보완하기 위해 LazyCollection 클래스는 PHP의 생성기를 활용하여 메모리 사용량을 낮게 유지하면서 매우 큰 데이터 세트로 작업할 수 있도록 해줍니다.

예를 들어, 애플리케이션이 로그를 구문 분석하기 위해 Laravel의 컬렉션 메서드를 활용하면서 멀티 기가바이트 로그 파일을 처리해야 한다고 가정해 보세요. 전체 파일을 한 번에 메모리로 읽는 대신, 지정된 시간에 파일의 작은 부분만 메모리에 유지하기 위해 지연 컬렉션을 사용할 수 있습니다.

use App\Models\LogEntry;
use Illuminate\Support\LazyCollection;

LazyCollection::make(function () {
$handle = fopen('log.txt', 'r');

while (($line = fgets($handle)) !== false) {
yield $line;
}

fclose($handle);
})->chunk(4)->map(function (array $lines) {
return LogEntry::fromLines($lines);
})->each(function (LogEntry $logEntry) {
// Process the log entry...
});

또는 10,000 Eloquent 모델을 반복해야 한다고 상상해 보세요. 기존 Laravel 컬렉션을 사용하는 경우 10,000개의 Eloquent 모델이 모두 동시에 메모리에 로드되어야 합니다.

use App\Models\User;

$users = User::all()->filter(function (User $user) {
return $user->id > 500;
});

그러나 쿼리 빌더의 cursor 메서드는 LazyCollection 인스턴스를 반환합니다. 이를 통해 데이터베이스에 대해 단일 쿼리만 실행할 수 있을 뿐만 아니라 한 번에 하나의 Eloquent 모델만 메모리에 로드된 상태로 유지할 수 있습니다. 이 예에서 filter 콜백은 실제로 각 사용자를 개별적으로 반복할 때까지 실행되지 않으므로 메모리 사용량이 크게 줄어듭니다.

use App\Models\User;

$users = User::cursor()->filter(function (User $user) {
return $user->id > 500;
});

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

Lazy 컬렉션 생성

지연 컬렉션 인스턴스를 생성하려면 PHP 생성기 함수를 컬렉션의 make 메서드에 전달해야 합니다.

use Illuminate\Support\LazyCollection;

LazyCollection::make(function () {
$handle = fopen('log.txt', 'r');

while (($line = fgets($handle)) !== false) {
yield $line;
}

fclose($handle);
});

Enumerable 컨트랙트

Collection 클래스에서 사용할 수 있는 거의 모든 메서드는 LazyCollection 클래스에서도 사용할 수 있습니다. 이 두 클래스는 모두 다음 메서드를 정의하는 Illuminate\Support\Enumerable 컨트랙트를 구현합니다.

[!WARNING] 컬렉션을 변경하는 메서드(예: shift, pop, prepend 등)는 LazyCollection 클래스에서 사용할 수 없습니다.

Lazy 컬렉션 메서드

Enumerable 컨트랙트에 정의된 메서드 외에도 LazyCollection 클래스에는 다음 메서드가 포함되어 있습니다.

takeUntilTimeout()

takeUntilTimeout 메서드는 지정된 시간까지 값을 열거하는 새로운 지연 컬렉션을 반환합니다. 그 이후에는 컬렉션의 열거가 중지됩니다.

$lazyCollection = LazyCollection::times(INF)
->takeUntilTimeout(now()->plus(minutes: 1));

$lazyCollection->each(function (int $number) {
dump($number);

sleep(1);
});

// 1
// 2
// ...
// 58
// 59

이 메서드의 사용법을 설명하기 위해 커서를 사용하여 데이터베이스에서 송장을 제출하는 애플리케이션을 상상해 보십시오. 15분마다 실행되고 최대 14분 동안만 송장을 처리하는 예약된 작업을 정의할 수 있습니다.

use App\Models\Invoice;
use Illuminate\Support\Carbon;

Invoice::pending()->cursor()
->takeUntilTimeout(
Carbon::createFromTimestamp(LARAVEL_START)->add(14, 'minutes')
)
->each(fn (Invoice $invoice) => $invoice->submit());

tapEach()

each 메서드는 컬렉션의 각 항목에 대해 지정된 콜백을 즉시 호출하는 반면, tapEach 메서드는 항목이 목록에서 하나씩 제거될 때 지정된 콜백만 호출합니다.

// Nothing has been dumped so far...
$lazyCollection = LazyCollection::times(INF)->tapEach(function (int $value) {
dump($value);
});

// Three items are dumped...
$array = $lazyCollection->take(3)->all();

// 1
// 2
// 3

throttle()

throttle 메서드는 지정된 시간(초) 후에 각 값이 반환되도록 지연 컬렉션을 조절합니다. 이 메서드는 들어오는 요청의 속도를 제한하는 외부 API와 상호 작용할 수 있는 상황에 특히 유용합니다.

use App\Models\User;

User::where('vip', true)
->cursor()
->throttle(seconds: 1)
->each(function (User $user) {
// Call external API...
});

remember()

remember 메서드는 이미 열거된 모든 값을 기억하고 후속 컬렉션 열거에서 해당 값을 다시 검색하지 않는 새로운 지연 컬렉션을 반환합니다.

// No query has been executed yet...
$users = User::cursor()->remember();

// The query is executed...
// The first 5 users are hydrated from the database...
$users->take(5)->all();

// First 5 users come from the collection's cache...
// The rest are hydrated from the database...
$users->take(20)->all();

withHeartbeat()

withHeartbeat 메서드를 사용하면 지연 컬렉션이 열거되는 동안 정기적인 시간 간격으로 콜백을 실행할 수 있습니다. 이는 잠금 확장 또는 진행률 업데이트 전송과 같이 정기적인 유지 관리 작업이 필요한 장기 실행 작업에 특히 유용합니다.

use Carbon\CarbonInterval;
use Illuminate\Support\Facades\Cache;

$lock = Cache::lock('generate-reports', seconds: 60 * 5);

if ($lock->get()) {
try {
Report::where('status', 'pending')
->lazy()
->withHeartbeat(
CarbonInterval::minutes(4),
fn () => $lock->extend(CarbonInterval::minutes(5))
)
->each(fn ($report) => $report->process());
} finally {
$lock->release();
}
}