[ Laravel 5.7 文件 ] 進階系列 —— 集合

阿新 • • 發佈：2018-11-20

簡介

Illuminate\Support\Collection 類為處理陣列資料提供了流式、方便的封裝。例如，檢視下面的程式碼，我們使用輔助函式 collect 建立一個新的集合例項，為每一個元素執行 strtoupper 函式，然後移除所有空元素：

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

正如你所看到的，Collection 類允許你使用方法鏈對底層陣列執行匹配和移除操作，通常，每個 Collection 方法都會返回一個新的 Collection 例項。

建立集合

正如上面所提到的，輔助函式 collect 為給定陣列返回一個新的 Illuminate\Support\Collection 例項，所以，建立集合很簡單：

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

注：預設情況下，Eloquent 查詢的結果總是返回 Collection 例項。

擴充套件集合

集合是"macroable"的，這意味著我們可以在執行時動態新增方法到 Collection

類，例如，下面的程式碼添加了 toUpper 方法到 Collection 類：

use Illuminate\Support\Str;

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

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

$upper = $collection->toUpper();

// ['FIRST', 'SECOND']

通常，我們需要在服務提供者中宣告集合巨集。

集合方法

本文件接下來的部分將會介紹 Collection 類上每一個有效的方法，所有這些方法都可以以方法鏈的方式流式操作底層陣列。此外，幾乎每個方法返回一個新的 Collection 例項，從而允許你在必要的時候保持原來的集合備份。

方法列表

all()

all 方法簡單返回集合表示的底層陣列：

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

avg()

avg 方法返回所有集合項的平均值：

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

// 20

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

// 2

average()

avg 方法的別名。

chunk()

chunk 方法將一個集合分割成多個小尺寸的小集合：

$collection = collect([1, 2, 3, 4, 5, 6, 7]);
$chunks = $collection->chunk(4);
$chunks->toArray();
// [[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

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]

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

contains()

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 方法來執行自己的真實測試：

$collection = collect([1, 2, 3, 4, 5]);
$collection->contains(function ($key, $value) {
    return $value > 5;
});
// false

contains 方法在檢查值的時候使用「寬鬆」比較，這意味著一個包含整型值的字串和同樣的整型值是相等的（例如，'1' 和 1 相等）。要想進行嚴格比較，可以使用 containsStrict 方法。

containsStrict()

這個方法和 contains 方法簽名一樣，不同之處在於所有值都是「嚴格」比較。

count()

count 方法返回集合中所有項的總數：

$collection = collect([1, 2, 3, 4]);
$collection->count();
// 4

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

/*
    Collection {
        #items: array:2 [
            0 => "John Doe"
            1 => "Jane Doe"
        ]
    }
*/

如果你不想要終止指令碼執行，可以使用 dump 方法來替代。

dump()

dump 方法會列印集合項而不終止指令碼執行：

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

$collection->dump();

/*
    Collection {
        #items: array:2 [
            0 => "John Doe"
            1 => "Jane Doe"
        ]
    }
*/

如果你想要在列印集合之後終止指令碼執行，可以使用 dd 方法來替代。

diff()

diff 方法將集合和另一個集合或原生PHP陣列以基於值的方式作比較，這個方法會返回存在於原來集合而不存在於給定集合的值：

$collection = collect([1, 2, 3, 4, 5]);
$diff = $collection->diff([2, 4, 6, 8]);
$diff->all();
// [1, 3, 5]

diffAssoc()

diffAssoc 方法會基於鍵值將一個集合和另一個集合或原生 PHP 陣列進行比較。該方法返回只存在於第一個集合中的鍵值對：

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

diffKeys()

diffKeys 方法會基於犍將一個集合和另一個集合或原生 PHP 陣列進行比較。該方法會返回只存在於第一個集合的鍵值對：

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

each()

each 方法迭代集合中的資料項並傳遞每個資料項到給定回撥：

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

如果你想要終止對資料項的迭代，可以從回撥返回 false：

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

eachSpread()

eachSpread 方法會迭代集合項，傳遞每個巢狀資料項值到給定集合：

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

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

你可以通過從回撥中返回 false 來停止對集合項的迭代：

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

every()

every 方法可以用於驗證集合的所有元素能夠通過給定的真理測試：

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

// false

except()

except 方法返回集合中除了指定鍵的所有集合項：

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

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

$filtered->all();

// ['product_id' => 1]

與 except 相對的是 only 方法。

filter()

filter 方法通過給定回撥過濾集合，只有通過給定真理測試的資料項才會保留下來：

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

$filtered = $collection->filter(function ($value, $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 ($value, $key) {
    return $value > 2;
});
// 3

你還可以呼叫不帶引數的 first 方法來獲取集合的第一個元素，如果集合是空的，返回 null：

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

firstWhere()

firstWhere 方法會返回集合中的第一個元素，包含鍵值對：

$collection = collect([
    ['name' => 'Regena', 'age' => 12],
    ['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]

flatMap()

flatMap 方法會迭代集合並傳遞每個值到給定回撥，該回調可以自由編輯資料項並將其返回，最後形成一個經過編輯的新集合。然後，這個陣列在層級維度被扁平化：

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

$flattened = $collection->flatMap(function ($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'];

還可以選擇性傳入深度引數：

$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']);

$collection->forget('name');

$collection->all();

// [framework' => 'laravel']

注：不同於大多數其他的集合方法，forget 不返回新的修改過的集合；它只修改所呼叫的集合。

forPage()

forPage 方法返回新的包含給定頁數資料項的集合。該方法接收頁碼數作為第一個引數，每頁顯示資料項數作為第二個引數：

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

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

$chunk->all();

// [4, 5, 6]

get()

get 方法返回給定鍵的資料項，如果對應鍵不存在，返回null：

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

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

// taylor

你可以選擇傳遞預設值作為第二個引數：

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

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

// default-value

你甚至可以傳遞迴調作為預設值，如果給定鍵不存在的話回撥的結果將會返回：

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

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

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

多個分組條件可以以一個數組的方式傳遞，每個陣列元素都會應用到多維陣列中的對應層級：

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

$collection->has('email');

// false

implode()

implode 方法連線集合中的資料項。其引數取決於集合中資料項的型別。如果集合包含陣列或物件，應該傳遞你想要連線的屬性鍵，以及你想要放在值之間的 “粘合”字串：

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

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

// Desk, Chair

如果集合包含簡單的字串或數值，只需要傳遞“粘合”字串作為唯一引數到該方法：

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

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

intersect()

intersect 方法返回兩個集合的交集，結果集合將保留原來集合的鍵：

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

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

$intersect->all();

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

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

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 ($item) {
    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 ($value, $key) {
    return $value < 3;
});
// 2

還可以呼叫無參的 last 方法來獲取集合的最後一個元素。如果集合為空。返回 null：

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

macro()

靜態 macro 方法允許你在執行時新增方法到 Collection 類，更多細節可以檢視擴充套件集合部分文件。

make()

靜態 make 方法會建立一個新的集合例項，細節可檢視建立集合部分文件。

map()

map 方法遍歷集合並傳遞每個值給給定回撥。該回調可以修改資料項並返回，從而生成一個新的經過修改的集合：

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

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

$multiplied->all();

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

注：和大多數集合方法一樣，map 返回新的集合例項；它並不修改所呼叫的例項。如果你想要改變原來的集合，使用 transform 方法。

mapInto()

mapInto() 方法會迭代集合，通過傳遞值到構造器來為給定類建立新的例項：

class Currency
{
    /**
     * Create a new currency instance.
     *
     * @param  string  $code
     * @return void
     */
    function __construct(string $code)
    {
        $this->code = $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 ($odd, $even) {
    return $odd + $even;
});

$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 ($item, $key) {
    return [$item['department'] => $item['name']];
});

$grouped->toArray();

/*
    [
        'Sales' => ['John Doe', 'Jane Doe'],
        'Marketing' => ['Johhny 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 ($item) {
    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, 'name' => 'Desk']);

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

$merged->all();

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

如果給定陣列的鍵是數字，陣列的值將會附加到集合後面：

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

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

$merged->all();

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

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]

nth()

nth方法組合集合中第 n-th 個元素建立一個新的集合：

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

$collection->nth(4);

// ['a', 'e']

還可以傳遞一個 offset（偏移位置）作為第二個引數：

$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 方法相對的是 except 方法。

pad()

pad 方法將給定值填充陣列直到達到指定的最大長度。該方法和 PHP 函式 array_pad 類似。

如果你想要把資料填充到左側，需要指定一個負值長度，如果指定長度絕對值小於等於陣列長度那麼將不會做任何填充：

$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 函式 list 一起使用，從而將通過真理測試和沒通過的分割開來：

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

list($underThree, $aboveThree) = $collection->partition(function ($i) {
    return $i < 3;
});

$underThree->all();

// [1, 2]

$aboveThree->all();

// [3, 4, 5, 6]

pipe()

pipe 方法傳遞集合到給定回撥並返回結果：

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

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

// 6

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

如果存在重複鍵，最後一個匹配的元素將會插入集合：

$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 方法移除並返回集合中最後面的資料項：

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

$collection->pop();

// 5

$collection->all();

// [1, 2, 3, 4]

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]

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 函式來指定返回的資料數目，如果該整型數值大於1，將會返回一個集合：

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

$random->all();

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

如果集合中的元素個數小於請求的隨機數，該方法會丟擲 InvalidArgumentException。

reduce()

reduce 方法用於減少集合到單個值，傳遞每個迭代結果到子迭代：

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

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

// 6

在第一次迭代時 $carry 的值是null；不過，你可以通過傳遞第二個引數到 reduce 來指定其初始值：

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

// 10

reject()

reject 方法使用給定回撥過濾集合，該回調應該為所有它想要從結果集合中移除的資料項返回 true：

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

$filtered->all();
// [1, 2]

和 reject 方法相對的方法是 filter 方法。

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

search 方法為給定值查詢集合，如果找到的話返回對應的鍵，如果沒找到，則返回 false：

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

$collection->search(4);

// 1

上面的搜尋使用的是「寬鬆」比較，要使用「嚴格」比較，傳遞 true 作為第二個引數到該方法：

$collection->search('4', true);
// false

此外，你還可以傳遞自己的回撥來搜尋通過真理測試的第一個資料項：

$collection->search(function ($item, $key) {
    return $item > 5;
});
// 2

shift()

shift 方法從集合中移除並返回第一個資料項：

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

$collection->shift();

// 1

$collection->all();

// [2, 3, 4, 5]

shuffle()

shuffle 方法隨機打亂集合中的資料項：

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

$shuffled = $collection->shuffle();

$shuffled->all();
// [3, 2, 5, 1, 4] // (隨機生成)

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 方法對它們進行重新索引。

sort()

sort 方法對集合進行排序，排序後的集合保持原來的陣列鍵，在本例中我們使用 values 方法重置鍵為連續編號索引：

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

$sorted = $collection->sort();

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

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

如果你需要更加高階的排序，你可以使用自己的演算法傳遞一個回撥給 sort 方法。參考 PHP 官方文件關於 uasort 的說明，sort 方法底層正是呼叫了該方法。

注：要為巢狀集合和物件排序，檢視 sortBy 和 sortByDesc 方法。

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

你還可以傳遞自己的回撥來判斷如何排序集合的值：

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

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

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

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

sortByDesc()

該方法和 sortBy 用法相同，不同之處在於按照相反順序進行排序。

sortKeys

sortKeys 方法通過底層關聯陣列的鍵對集合進行排序：

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

$sorted = $collection->sortKeys();

$sorted->all();

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

sortKeysDesc

該方法和 sortKeys 方法方法簽名相同，但是排序順序與其相反。

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

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

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

tap()

tap 方法會傳遞集合到給定回撥，從而允許你在指定入口進入集合並對集合項進行處理而不影響集合本身：

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

// 1

times()

通過靜態 times() 方法可以通過呼叫指定次數的回撥建立一個新的集合：

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

$collection->all();

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

該方法在和工廠方法一起建立 Eloquent 模型時很有用：

$categories = Collection::times(3, function ($number) {
    return factory(Category::class)->create(['name' => 'Category #'.$number]);
});

$categories->all();

/*
    [
        ['id' => 1, 'name' => 'Category #1'],
        ['id' => 2, 'name' => 'Category #2'],
        ['id' => 3, 'name' => 'Category #3'],
    ]
*/

toArray()

toArray 方法將集合轉化為一個原生的 PHP 陣列。如果集合的值是 Eloquent 模型，該模型也會被轉化為陣列：

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

$collection->toArray();

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

注：toArray 還將所有巢狀物件轉化為陣列。如果你想要獲取底層陣列，使用 all 方法。

toJson()

toJson 方法將集合轉化為 JSON：

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

$collection->toJson();

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

transform()

transform 方法迭代集合並對集合中每個資料項呼叫給定回撥。集合中的資料項將會被替代成從回撥中返回的值：

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

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

$collection->all();

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

注意：不同於大多數其它集合方法，transform 修改集合本身，如果你想要建立一個新的集合，使用 map 方法。

union()

union 方法新增給定陣列到集合，如果給定陣列包含已經在原來集合中存在的犍，原生集合的值會被保留：

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

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

$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 = $collection->unique(function ($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 方法。

uniqueStrict()

該方法和 unique 方法簽名一樣，不同之處在於所有值都是「嚴格」比較。

unless()

unless 方法會執行給定回撥，除非傳遞到該方法的第一個引數等於 true：

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

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

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

$collection->all();

// [1, 2, 3, 5]

與 unless 相對的方法是 when。

unwrap()

靜態 unwrap 方法會從給定值中返回集合項：

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

// ['John Doe']

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

// ['John Doe']

Collection::unwrap('John Doe');

// 'John Doe'

values()

values 方法通過將集合鍵重置為連續整型數字的方式返回新的集合：

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

$values = $collection->values();

$values->all();

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

when()

when方法在傳入的第一個引數執行結果為 true 時執行給定回撥：

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

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

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

$collection->all();

// [1, 2, 3, 4]

與 when 方法相對的是 unless。

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 方法使用「嚴格」比較進行過濾。

whereStrict()

該方法和 where 用法簽名一樣，不同之處在於，所有值都使用「嚴格」比較。

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' => 'Bookcase', 'price' => 150],
    ['product' => 'Desk', 'price' => 200],
]
*/

whereIn 方法在檢查資料項值的時候使用「寬鬆」比較，要使用「嚴格」比較可以使用 whereInStrict 方法。

whereInStrict()

該方法和 whereIn 方法簽名相同，不同之處在於 whereInStrict 在比較值的時候使用「嚴格」比較。

whereInstanceOf

whereInstanceOf 方法通過給定類的型別過濾集合：

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

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

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 方法簽名一樣，不同之處在於所有值都使用「嚴格」比較。

wrap()

靜態 wrap 方法會將給定值封裝到集合中：

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

高階訊息傳遞

集合還支援“高階訊息傳遞”，也就是在集合上執行通用的功能，支援高階訊息傳遞的方法包括：average、avg、contains、each、every、filter、first、flatMap、groupBy、keyBy、map、max、min、partition、reject、sortBy、sortByDesc、sum 和 unique。

每個高階訊息傳遞都可以在集合例項上以動態屬性的方式訪問，例如，我們使用 each 高階訊息傳遞來在集合的每個物件上呼叫一個方法：

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

$users->each->markAsVip();

類似的，我們可以使用 sum 高階訊息傳遞來聚合使用者集合的投票總數：

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

return $users->sum->votes;

轉載處laravel學院

[ Laravel 5.7 文件 ] 進階系列 —— 集合

簡介

集合方法

方法列表

高階訊息傳遞

[ Laravel 5.7 文件 ] 進階系列 —— 集合

[ Laravel 5.6 文檔 ] 進階系列 —— 任務調度

【7】C++進階系列（類的繼承與派生）

laravel 5.7 安裝 jwt-auth，jwt-auth 文件翻譯

批處理系列(5) - 根據文件名自動創建目錄存放文件

Python進階系列連載（5）——生成器（上）

【5】C++進階系列（陣列和指標2）

HTML5 進階系列：indexedDB 數據庫

C#進階系列——WebApi 異常處理解決方案（轉）

2017-5-17 文件異常

C#進階系列——WebApi 接口測試工具：WebApiTestClient

C#進階系列——WebApi 路由機制剖析：你準備好了嗎？

C#進階系列——WebApi 跨域問題解決方案：CORS

Jenkins進階系列之——09配置Linux系統ssh免密碼登陸

5-21文件的操作

[轉]C#進階系列——WebApi 接口返回值不困惑：返回值類型詳解

《jmeter：菜鳥入門到進階系列》

Linq To Sql進階系列（六）用object的動態查詢與保存log篇

php高級進階系列文章--第二篇（PHP基礎知識復習）

CentOS7/64位環境安裝Mysql 5.7.19二進制包教程

[ Laravel 5.7 文件 ] 進階系列 —— 集合

簡介

集合方法

方法列表

高階訊息傳遞

相關推薦