十五個常用的 Laravel 集合（Collection）

Laravel Eloquent 通常會傳回一個集合作為結果，集合包含許多有用的、功能強大的方法。你可以很方便的對集合進行過濾、修改等操作。本次教學就一起來看看集合的常用方法及功能。
集合並不僅限於 eloquent ，也可以單獨使用。但 Eloquent 的結果就是一個集合。你可以使用助手函數 collect 將陣列轉換為集合。以下所列的集合的方法適用於 eloquent 結果的同時也適用於集合本身。

比方說，你有一個帖子模型。你找到所有 php 類別的貼文。

$posts = App\Post::where('category', 'php')->get();

上面的指令傳回一個集合。集合是一個laravel類，它在內部使用數組函數並為它們添加許多功能。

你可以簡單的使用 collect 方法建立一個集合，如下：

$collection = collect([
    [
        'user_id' => '1',
        'title' => 'Helpers in Laravel',
        'content' => 'Create custom helpers in Laravel',
        'category' => 'php'
    ],
    [
        'user_id' => '2',
        'title' => 'Testing in Laravel',
        'content' => 'Testing File Uploads in Laravel',
        'category' => 'php'
    ],
    [
        'user_id' => '3',
        'title' => 'Telegram Bot',
        'content' => 'Crypto Telegram Bot in Laravel',
        'category' => 'php'
    ],
]);

上面的陣列其實是 Post 模型的值。在本教程中，我們將使用此數組進行簡化。請記住，一切都將以同樣的方式基於 eloquent。

當我們在 eloquent 集合上使用輔助方法時，不會再查詢資料庫。我們首先要從資料庫中取得所有結果，然後我們使用集合方法來過濾和修改它們，而無需查詢資料庫。

filter()

filter，最有用的 laravel 集合方法之一，讓您可以使用回調過濾集合。它只傳遞那些回傳true的項。所有其他項目都被刪除。 filter 傳回一個新實例而不更改原始實例。它接受 value 和 key 作為回呼中的兩個參數。

$filter = $collection->filter(function($value, $key) {
    if ($value['user_id'] == 2) {
        return true;
    }
});

$filter->all();

all 方法傳回底層陣列。上面的程式碼傳回以下回應。

[
    1 => [
        "user_id" => 2,
        "title" => "Testing in Laravel",
        "content" => "Testing File Uploads in Laravel",
        "category" => "php"
    ]
]

search()

search 方法可以用給定的值來尋找集合。如果這個值在集合中，會回傳對應的鍵。如果沒有資料項符合對應的值，會傳回 false。

$names = collect(['Alex', 'John', 'Jason', 'Martyn', 'Hanlin']);

$names->search('Jason');

// 2

search 方法預設使用鬆散比較。你可以在它的第二個參數傳 true 使用嚴格比較。

你也可以將自己的回呼函數傳到 search 方法中。將會傳回通過回呼真值測試的第一個項目的鍵。

$names = collect(['Alex', 'John', 'Jason', 'Martyn', 'Hanlin']);

$names->search(function($value, $key) {
    return strlen($value) == 6;
});

// 3

chunk()

chunk 方法將集合分割為多個給定大小的較小集合。將集合顯示到網格中非常有用。

$prices = collect([18, 23, 65, 36, 97, 43, 81]);

$prices = $prices->chunk(3);

$prices->toArray();

以上程式碼產生效果。

[
    0 => [
        0 => 18,
        1 => 23,
        2 => 65
    ],
    1 => [
        3 => 36,
        4 => 97,
        5 => 43
    ],
    2 => [
        6 => 81
    ]
]

dump()

dump 列印集合的方法。它可用於在任何位置的調試和查找集合內的內容。

$collection->whereIn('user_id', [1, 2])
    ->dump()
    ->where('user_id', 1);

dump 上述程式碼結果。

map()

map 方法用於遍歷整個集合。它接受回調作為參數。 value 和 key 傳遞給回呼。回調可以修改值並傳回它們。最後，傳回修改項的新集合實例。

$changed = $collection->map(function ($value, $key) {
    $value['user_id'] += 1;
    return $value;
});

return $changed->all();

基本上，它將 user_id 增加1。

上面程式碼的回應如下所示。

[
    [
        "user_id" => 2,
        "title" => "Helpers in Laravel",
        "content" => "Create custom helpers in Laravel",
        "category" => "php"
    ],
    [
        "user_id" => 3,
        "title" => "Testing in Laravel",
        "content" => "Testing File Uploads in Laravel",
        "category" => "php"
    ],
    [
        "user_id" => 4,
        "title" => "Telegram Bot",
        "content" => "Crypto Telegram Bot in Laravel",
        "category" => "php"
    ]
];

zip()

Zip 方法會將給定陣列的值與集合的值合併在一起。相同索引的值會加在一起，這意味著，數組的第一個值會與集合的第一個值合併。在這裡，我會使用我們在上面剛剛建立的集合。這對 Eloquent 集合同樣有效。

$zipped = $collection->zip([1, 2, 3]);

$zipped->all();

JSON 回應會像這樣。

所以，基本上就是這樣。如果陣列的長度小於集合的長度，Laravel 會為剩餘的 Collection 類型的元素結尾加上 null。類似地，如果陣列的長度比集合的長度大，Laravel 會為 Collection 類型的元素加上 null，然後再接著陣列的值。

whereNotIn()

您可以使用 whereNotIn 方法簡單地按照給定數組中未包含的鍵值過濾集合。它基本上與 whereIn 相反。此外，此方法在匹配值時使用寬鬆比較 ==。

讓我們過濾 $collection，其中 user_id 既不是 1 也不是 2的。

$collection->whereNotIn('user_id', [1, 2]);

上面的語句將只會傳回 $collection 中的最後一項。第一個參數是鍵，第二個參數是值數組。如果是 eloquent 的話，第一個參數將是列的名稱，第二個參數將是一個值數組。

max()

max 方法傳回給定鍵的最大值。你可以透過呼叫max來找到最大的 user_id。它通常用於價格或任何其他數字之類的比較，但為了演示，我們使用 user_id。它也可以用於字串，在這種情況下，Z> a。

$collection->max('user_id');

上面的语句将返回最大的 user_id，在我们的例子中是 3。

pluck()

pluck 方法返回指定键的所有值。 它对于提取一列的值很有用。

$title = $collection->pluck('title');
$title->all();

结果看起来像这样。

[
  "Helpers in Laravel",
  "Testing in Laravel",
  "Telegram Bot"
]

使用 eloquent 时，可以将列名作为参数传递以提取值。 pluck 也接受第二个参数，对于 eloquent 的集合，它可以是另一个列名。 它将导致由第二个参数的值作为键的集合。

$title = $collection->pluck('user_id', 'title');
$title->all();

结果如下：

[
    "Helpers in Laravel" => 1,
    "Testing in Laravel" => 2,
    "Telegram Bot" => 3
]

each()

each 是一种迭代整个集合的简单方法。 它接受一个带有两个参数的回调：它正在迭代的项和键。 Key 是基于 0 的索引。

$collection->each(function ($item, $key) {
    info($item['user_id']);
});

上面代码，只是记录每个项的 user_id。

在迭代 eloquent 集合时，您可以将所有列值作为项属性进行访问。 以下是我们如何迭代所有帖子。

$posts = App\Post::all();

$posts->each(function ($item, $key) {
    // Do something
});

如果回调中返回 false，它将停止迭代项目。

$collection->each(function ($item, $key) {
    // Tasks
    if ($key == 1) {
        return false;
    }
});

tap()

tap() 方法允许你随时加入集合。 它接受回调并传递并将集合传递给它。 您可以对项目执行任何操作，而无需更改集合本身。 因此，您可以在任何时候使用tap来加入集合，而不会改变集合。

$collection->whereNotIn('user_id', 3)
    ->tap(function ($collection) {
        $collection = $collection->where('user_id', 1);
        info($collection->values());
    })
    ->all();

在上面使用的 tap 方法中，我们修改了集合，然后记录了值。 您可以对 tap 中的集合做任何您想做的事情。 上面命令的响应是：

[
    [
        "user_id" => "1",
        "title" => "Helpers in Laravel",
        "content" => "Create custom helpers in Laravel",
        "category" => "php"
    ],
    [
        "user_id" => "2",
        "title" => "Testing in Laravel",
        "content" => "Testing File Uploads in Laravel",
        "category" => "php"
    ]
]

你可以看到 tap 不会修改集合实例。

pipe()

pipe 方法非常类似于 tap 方法，因为它们都在集合管道中使用。 pipe 方法将集合传递给回调并返回结果。

$collection->pipe(function($collection) {
    return $collection->min('user_id');
});

上述命令的响应是 1。 如果从 pipe回调中返回集合实例，也可以链接其他方法。

contains()

contains 方法只检查集合是否包含给定值。 只传递一个参数时才会出现这种情况。

$contains = collect(['country' => 'USA', 'state' => 'NY']);

$contains->contains('USA');
// true

$contains->contains('UK');
// false

如果将 键 / 值 对传递给 contains 方法，它将检查给定的键值对是否存在。

$collection->contains('user_id', '1');
// true

$collection->contains('title', 'Not Found Title');
// false

您还可以将回调作为参数传递给回调方法。 将对集合中的每个项目运行回调，如果其中任何一个项目通过了真值测试，它将返回 true 否则返回 false。

$collection->contains(function ($value, $key) {
    return strlen($value['title']) <p>回调函数接受当前迭代项和键的两个参数值。 这里我们只是检查标题的长度是否小于13。在 <code>Telegram Bot</code> 中它是12，所以它返回 <code>true</code>。</p><h2 id="forget">forget()</h2><p><code>forget</code> 只是从集合中删除该项。 您只需传递一个键，它就会从集合中删除该项目。</p><pre class="brush:php;toolbar:false">$forget = collect(['country' => 'usa', 'state' => 'ny']);

$forget->forget('country')->all();

上面代码响应如下：

[
    "state" => "ny"
]

forget 不适用于多维数组。

avg()

avg 方法返回平均值。 你只需传递一个键作为参数，avg 方法返回平均值。 你也可以使用 average 方法，它基本上是 avg 的别名。

$avg = collect([
    ['shoes' => 10],
    ['shoes' => 35],
    ['shoes' => 7],
    ['shoes' => 68],
])->avg('shoes');

上面的代码返回 30 ，这是所有四个数字的平均值。 如果你没有将任何键传递给avg 方法并且所有项都是数字，它将返回所有数字的平均值。 如果键未作为参数传递且集合包含键/值对，则 avg 方法返回 0。

$avg = collect([12, 32, 54, 92, 37]);

$avg->avg();

上面的代码返回 45.4，这是所有五个数字的平均值。

您可以使用这些 laravel 集合方法在您自己的项目中处理集合。

更多Laravel相关技术文章，请访问Laravel教程栏目进行学习！

以上是十五個常用的 Laravel 集合（Collection）的詳細內容。更多資訊請關注PHP中文網其他相關文章！