十五个经常使用的 Laravel 集合（Collection）

时间  2019-11-08
标签 十五个 经常 使用 laravel 集合 collection 栏目 快乐工作 繁體版
原文   原文链接

Laravel

文章转自： https://learnku.com/laravel/t...

Laravel Eloquent 一般返回一个集合做为结果，集合包含不少有用的、功能强大的方法。你能够很方便的对集合进行过滤、修改等操做。本次教程就一块儿来看一看集合的经常使用方法及功能。
集合并不只限于 eloquent ，也能够单独使用。但 Eloquent 的结果就是一个集合。你可使用助手函数 collect 将数组转化为集合。下面所列出的集合的方法适用于 eloquent 结果的同时也适用于集合自己。php

比方说，你有一个帖子模型。 你找到全部 php 类别的帖子。laravel

$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 集合上使用辅助方法时，不会再查询数据库。 咱们首先要从数据库中获取全部结果，而后咱们使用集合方法来过滤和修改它们，而无需查询数据库。post

filter()

filter，最有用的 laravel 集合方法之一，容许您使用回调过滤集合。 它只传递那些返回true的项。 全部其余项目都被删除。 filter 返回一个新实例而不更改原始实例。 它接受 value 和 key 做为回调中的两个参数。测试

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

$filter->all();

all 方法返回底层数组。 上面的代码返回如下响应。spa

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

search()

search 方法能够用给定的值查找集合。若是这个值在集合中，会返回对应的键。若是没有数据项匹配对应的值，会返回 false。3d

$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 上述代码结果。

Laravel

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

因此，基本上就是这样。若是数组的长度小于集合的长度，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"
]

When working with eloquent, you can pass a column name as an argument to extract its values. pluck also accepts a second argument and in the case of eloquent collections, it can be another column name. It will result in collection keyed by the values of the second argument.
使用 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']) < 13;
});
// true

回调函数接受当前迭代项和键的两个参数值。 这里咱们只是检查标题的长度是否小于13。在 Telegram Bot 中它是12，因此它返回 true。

forget()

forget 只是从集合中删除该项。 您只需传递一个键，它就会从集合中删除该项目。

$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 集合方法在您本身的项目中处理集合。

文章转自： https://learnku.com/laravel/t...

更多文章： https://learnku.com/laravel/c...
相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程