Laravel: Koleksiyonlar (Collections)

Mahmut Bayrı

10 sene önce

Giriş

Illuminate\Support\Collection sınıfı diziler çalışırken oldukça kullanışlıdır. Aşağıdaki koda bir göz atın. Diziden yeni bir koleksiyon oluşturmak için collect yardımcısını kullanıp, her element için strtoupper fonksiyonunu çalıştıracak ve boş elementleri kaldıracağız.

$collection = collect(['taylor', 'abigail', null])->map(function ($name) {
    return strtoupper($name);
})
->reject(function ($name) {
    return empty($name);
});

$collection = collect(['taylor', 'abigail', null])->map(function ($name) {

return strtoupper($name);

})

->reject(function ($name) {

return empty($name);

});

Gördüğünüz gibi Collection sınıfı, metdolarını arka arkaya çalıştırmanızı sağlar. Genelde her Collection metodu tümüyle yeni bir Collection örneği döner.

Koleksiyonları Oluşturma

Yukarıda belirttildiği gibi collect yardımcısı verilen dizi için yeni bir Illuminate\Support\Collection örneği döner. Koleksiyon oluşturulması basitçe şöyledir:

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

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

Varsayılan olarak, Eloquent modellerinin koleksiyonları her zaman Collection örneğidir.

Kullanılabilir Metodlar

Bu dökümanın devamında Collection sınıfındaki her bir metodu açıklayacağız. Temel diziyi akıcı bir şekilde manipüle etmek için tüm metodlar arka aryaya kullanılabilir. Dahası, hemen hemen bütün metodlar yeni bir Collection örneği dönerler. Bu orjinal koleksiyonun orjinal kopyasını saklamanızı sağlar.

Kullanım örneği görmeniz için bu tablodaki herhangi bir metodu seçebilirsiniz.

Metod Listesi

`all()`

all metodu tüm diziyi döner.

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

// [1, 2, 3]

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

// [1, 2, 3]

`chunk()`

chunk metodu koleksiyonu çoklu parçalara böler.

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

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

$chunks->toArray();

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

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

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

$chunks->toArray();

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

Bu metod özellikle Bootstrap gibi ızgara sistemlerde çalışırken görünümlerde kullanışlıdır. Bir Eloquent model koleksiyonunuz olduğunu ve ızgarada göstermek istediğinizi düşünün.

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

@foreach ($products->chunk(3) as $chunk)

@foreach ($chunk as $product)

<div class="col-xs-4">{{ $product->name }}</div>

@endforeach

</div>

@endforeach

`collapse()`

collapse metodu koleksion dizilerini tek bir düz koleksiyon haline getirir.

$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]

$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]

`contains()`

contains metodu verilen elemanın dizi içinde olup olmadığını belirler.

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

$collection->contains('Desk');

// true

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

// false

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

$collection->contains('Desk');

// true

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

// false

Metodu key/value çiftini de geçirebilirsiniz.

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

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

// false

$collection = collect([

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

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

]);

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

// false

Son olarak, kendi doğrulama tersiniz için metoda geri çağırım da geçirebilirsiniz.

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

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

// false

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

$collection->contains(function ($key, $value) {

return $value > 5;

});

// false

`count()`

count metodu koleksiyondaki toplam elemanların sayısını yöner.

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

$collection->count();

// 4

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

$collection->count();

// 4

`diff()`

diff metodu kolleksiyonla başka bir koleksiyon veya düz PHP dizisini karşılaştırır.

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

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

$diff->all();

// [1, 3, 5]

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

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

$diff->all();

// [1, 3, 5]

`each()`

each metodu verilen geri çağrımı koleksiyondaki öğeleri tekrarlar.

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

$collection = $collection->each(function ($item, $key) {

});

`every()`

every metodu, her n’inci öğeden oluşan yeni bir koleksiyon oluşturur.

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

$collection->every(4);

// ['a', 'e']

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

$collection->every(4);

// ['a', 'e']

İkinci argüman olarak isteğe bağlı uzatma geçirebilirsiniz.

$collection->every(4, 1);

// ['b', 'f']

$collection->every(4, 1);

// ['b', 'f']

`filter()`

filter metodu, verilen geribildirimle filtrelenen elemenalardan yalnızca teste uyan elemanları filtreler.

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

$filtered = $collection->filter(function ($item) {
    return $item > 2;
});

$filtered->all();

// [3, 4]

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

$filtered = $collection->filter(function ($item) {

return $item > 2;

});

$filtered->all();

// [3, 4]

filter metodunun tersi için reject metoduna bakabilirsiniz.

`first()`

first metodu, koleksiyondaki teste uyan ilk elemanı döndürür.

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

// 3

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

return $value > 2;

});

// 3

Ayrıca first metodunu koleksiyonunun ilk elemanınını almak için argümansız da çağırabilirsiniz. Koleksiyon boş ise null döndürülür:

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

// 1

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

// 1

`flatten()`

flatten metodu, çok boyutlu koleksiyonu tek boyuyluya çevirir.

$collection = collect(['name' => 'taylor', 'languages' => ['php', 'javascript']]);

$flattened = $collection->flatten();

$flattened->all();

// ['taylor', 'php', 'javascript'];

$collection = collect(['name' => 'taylor', 'languages' => ['php', 'javascript']]);

$flattened = $collection->flatten();

$flattened->all();

// ['taylor', 'php', 'javascript'];

`flip()`

flip metodu, koleksiyonun anahtarları ile karşılık gelen değerlerini yerdeğiştirir.

$collection = collect(['name' => 'taylor', 'framework' => 'laravel']);

$flipped = $collection->flip();

$flipped->all();

// ['taylor' => 'name', 'laravel' => 'framework']

$collection = collect(['name' => 'taylor', 'framework' => 'laravel']);

$flipped = $collection->flip();

$flipped->all();

// ['taylor' => 'name', 'laravel' => 'framework']

`forget()`

forget metodu, anahtarı verilen elementi koleksiyondan kaldırır.

$collection = collect(['name' => 'taylor', 'framework' => 'laravel']);

$collection->forget('name');

$collection->all();

// [framework' => 'laravel']

$collection = collect(['name' => 'taylor', 'framework' => 'laravel']);

$collection->forget('name');

$collection->all();

// [framework' => 'laravel']

Diğer bir çok koleksiyon metodlarından farklı olarak, forget değiştirilen yeni bir koleksiyon dönmez; çağrıldığı koleksiyonu değiştirir.

`forPage()`

forPage sayfa numarası verilen elemanları gösterecek yeni bir koleksiyon döndürür.

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

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

$chunk->all();

// [4, 5, 6]

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

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

$chunk->all();

// [4, 5, 6]

Bu metod sırasıyla sayfa numarası ve sayfada gösterilecek eleman sayısı verilir.

`get()`

get metodu verilen anahtardaki elemanı döner. Anahtar yok ise null döndürülür.

$collection = collect(['name' => 'taylor', 'framework' => 'laravel']);

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

// taylor

$collection = collect(['name' => 'taylor', 'framework' => 'laravel']);

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

// taylor

Opsiyonel olarak varsayılan değeri ikinci argüman olarak verebilirsiniz.

$collection = collect(['name' => 'taylor', 'framework' => 'laravel']);

$value = $collection->get('foo', 'default-value');

// default-value

$collection = collect(['name' => 'taylor', 'framework' => 'laravel']);

$value = $collection->get('foo', 'default-value');

// default-value

Varsayılan değer olarak geribildirim de verebilirsiniz. Verilen anahtar yoksa geribildirim sonucu döndürülecek.

$collection->get('email', function () {
    return 'default-value';
});

// default-value

$collection->get('email', function () {

return 'default-value';

});

// default-value

`groupBy()`

groupBy metodu, anahtarı verilen koleksiyon elemanlarını gruplar.

$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->toArray();

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

$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->toArray();

[

'account-x10' => [

['account_id' => 'account-x10', 'product' => 'Chair'],

['account_id' => 'account-x10', 'product' => 'Bookcase'],

'account-x11' => [

['account_id' => 'account-x11', 'product' => 'Desk'],

]

Anahtar olarak string geçirmeye ek olarak, geri bildirim de geçirebilirsiniz.

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

$grouped->toArray();

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

$grouped = $collection->groupBy(function ($item, $key) {

return substr($item['account_id'], -3);

});

$grouped->toArray();

[

'x10' => [

['account_id' => 'account-x10', 'product' => 'Chair'],

['account_id' => 'account-x10', 'product' => 'Bookcase'],

'x11' => [

['account_id' => 'account-x11', 'product' => 'Desk'],

]

`has()`

has metodu, verilen anahtarın koleksiyonda olup olmadığını kontrol eder.

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

$collection->has('email');

// false

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

$collection->has('email');

// false

`implode()`

implode metodu, koleksiyonun elemanlarını birleştirir.

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

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

// Desk, Chair

$collection = collect([

['account_id' => 1, 'product' => 'Desk'],

['account_id' => 2, 'product' => 'Chair'],

]);

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

// Desk, Chair

`intersect()`

intersect metodu, verilen dizi veya koleksiyonda olmayan değerleri kaldırır.

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

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

$intersect->all();

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

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

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

$intersect->all();

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

Gördüğünüz gibi, sonuç koleksiyonu koleksiyonunun orjinal anahtarlarını saklayacaktır.

`isEmpty()`

isEmpty metodu, koleksiyon boş ise true, aksi halde false döndürür.

collect([])->isEmpty();

// true

collect([])->isEmpty();

// true

`keyBy()`

Verilen anahtarla koleksiyonu tekrar düzenler.

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

$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'],

]

Eğer birçok eleman aynı anaytara sahipse, yalnızca sonuncu olan yeni koleksiyonda yer alacaktır.

Kendi geri bildirimizi de geçireblirsiniz.

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

$keyed->all();

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

$keyed = $collection->keyBy(function ($item) {

return strtoupper($item['product_id']);

});

$keyed->all();

[

'PROD-100' => ['product_id' => 'prod-100', 'name' => 'Desk'],

'PROD-200' => ['product_id' => 'prod-200', 'name' => 'Chair'],

]

`last()`

last metodu, koleksyondaki teste uyan son elemanı döndürür

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

// 2

collect([1, 2, 3, 4])->last(function ($key, $value) {

return $value < 3;

});

// 2

Ayrıca last metodunu koleksiyonunun son elemanınını almak için argümansız da çağırabilirsiniz. Koleksiyon boş ise null döndürülür:

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

// 4

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

// 4

`map()`

map metodu, koleksiyon içinde ilerleyerek her değeri verilen geribildirime aktarır.

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

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

$multiplied->all();

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

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

$multiplied = $collection->map(function ($item, $key) {

return $item * 2;

});

$multiplied->all();

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

Not: Çoğu koleksiyon metodu gibi map metodu da koleksiyonunun yeni bir örneğini döndürür, çağrılan koleksiyonu değiştirmez. Orjinal koleksiyonu değiştirmek istiyorsanız transform metodunu kullanabilirsiniz.