集合

简介

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

您还可以使用 make 和 fromJson 方法创建集合。

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

可用方法

对于剩余的大部分集合文档，我们将讨论 Collection 类上可用的每个方法。请记住，所有这些方法都可以链接以流畅地操作底层数组。此外，几乎每个方法都返回一个新的 Collection 实例，允许您在必要时保留集合的原始副本：

after
all
average
avg
before
chunk
chunkWhile
collapse
collapseWithKeys
collect
combine
concat
contains
containsOneItem
containsStrict
count
countBy
crossJoin
dd
diff
diffAssoc
diffAssocUsing
diffKeys
doesntContain
doesntContainStrict
dot
dump
duplicates
duplicatesStrict
each
eachSpread
ensure
every
except
filter
first
firstOrFail
firstWhere
flatMap
flatten
flip
forget
forPage
fromJson
get
groupBy
has
hasAny
implode
intersect
intersectUsing
intersectAssoc
intersectAssocUsing
intersectByKeys
isEmpty
isNotEmpty
join
keyBy
keys
last
lazy
macro
make
map
mapInto
mapSpread
mapToGroups
mapWithKeys
max
median
merge
mergeRecursive
min
mode
multiply
nth
only
pad
partition
percentage
pipe
pipeInto
pipeThrough
pluck
pop
prepend
pull
push
put
random
range
reduce
reduceSpread
reject
replace
replaceRecursive
reverse
search
select
shift
shuffle
skip
skipUntil
skipWhile
slice
sliding
sole
some
sort
sortBy
sortByDesc
sortDesc
sortKeys
sortKeysDesc
sortKeysUsing
splice
split
splitIn
sum
take
takeUntil
takeWhile
tap
times
toArray
toJson
toPrettyJson
transform
undot
union
unique
uniqueStrict
unless
unlessEmpty
unlessNotEmpty
unwrap
value
values
when
whenEmpty
whenNotEmpty
where
whereStrict
whereBetween
whereIn
whereInStrict
whereInstanceOf
whereNotBetween
whereNotIn
whereNotInStrict
whereNotNull
whereNull
wrap
zip

方法列表

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 方法主要用于将 lazy collections 转换为标准的 Collection 实例：

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

$collection = $lazyCollection->collect();

$collection::class;

// 'Illuminate\Support\Collection'

$collection->all();

// [1, 2, 3]

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 方法。

containsOneItem()containsOneItem 方法确定集合是否包含单个项目：

collect([])->containsOneItem();

// false

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

// true

collect(['1', '2'])->containsOneItem();

// false

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

// true

containsStrict() 此方法具有与 contains 方法相同的签名；但是，所有值都使用“严格”比较进行比较。

当使用 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(['alice@gmail.com', 'bob@yahoo.com', 'carlos@gmail.com']);

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

当使用 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]

回调必须是一个比较函数，它返回一个小于、等于或大于零的整数。有关更多信息，请参阅 PHP 文档中关于 array_diff_uassoc 的内容，diffAssocUsing 方法内部利用了该 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' => 'abigail@example.com', 'position' => 'Developer'],
    ['email' => 'james@example.com', 'position' => 'Designer'],
    ['email' => 'victoria@example.com', '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、bool 和 array 等基本类型：

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

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 方法。

当使用 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 方法将返回给定项目键的值为“真实”的第一个项目：

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

// []

与大多数其他集合方法不同，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 'taylor@example.com';
});

// taylor@example.com

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

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'

如果您想格式化被连接的值，您可以将闭包传递给 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']

当使用 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，我们避免了分配大量额外的内存。尽管原始集合仍将其值保留在内存中，但随后的过滤器不会。因此，在过滤集合结果时，几乎不会分配额外的内存。

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]

与大多数其他集合方法一样，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' => 'john@example.com',
    ],
    [
        'name' => 'Jane',
        'department' => 'Marketing',
        'email' => 'jane@example.com',
    ]
]);

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

$keyed->all();

/*
    [
        'john@example.com' => 'John',
        'jane@example.com' => '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' => 'user1@example.com'],
    ['name' => 'User #2', 'email' => 'user2@example.com'],
])->multiply(3);

/*
    [
        ['name' => 'User #1', 'email' => 'user1@example.com'],
        ['name' => 'User #2', 'email' => 'user2@example.com'],
        ['name' => 'User #1', 'email' => 'user1@example.com'],
        ['name' => 'User #2', 'email' => 'user2@example.com'],
        ['name' => 'User #1', 'email' => 'user1@example.com'],
        ['name' => 'User #2', 'email' => 'user2@example.com'],
    ]
*/

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 的相反，请参阅 except 方法。

当使用 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]

在与 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()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 方法跳过集合中的项目，直到给定的回调返回 true。一旦回调返回 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]

如果找不到给定值或回调从未返回 true，skipUntil 方法将返回一个空集合。

skipWhile()skipWhile 方法跳过集合中的项目，只要给定的回调返回 true。一旦回调返回 false，集合中所有剩余的项目将作为新集合返回：

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

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

$subset->all();

// [4]

如果回调从未返回 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;
});

您可以选择传递第二个“步长”值，该值确定每个块的第一个项目之间的距离：

$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。请参阅 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],
    ]
*/

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

$sorted->all();

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

回调必须是比较函数，它返回一个小于、等于或大于零的整数。有关更多信息，请参阅 PHP 文档中关于 uksort 的内容，sortKeysUsing 方法内部利用了该 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]

如果找不到给定值或回调从未返回 true，takeUntil 方法将返回集合中的所有项目。

takeWhile()takeWhile 方法返回集合中的项目，直到给定的回调返回 false：

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

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

$subset->all();

// [1, 2]

如果回调从未返回 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],
    ]
*/

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]

与大多数其他集合方法不同，transform 修改集合本身。如果您希望改为创建一个新集合，请使用 map 方法。

undot()undot 方法将使用“点”符号的单维集合扩展为多维集合：

$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 方法以使用“严格”比较进行过滤。

当使用 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' => 'Desk', 'price' => 200],
]);

$values = $collection->values();

$values->all();

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

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 方法以使用“严格”比较进行过滤。

您可以选择将比较运算符作为第二个参数传递。支持的运算符有：'==='、'!=='、'!='、'=='、'='、'<>'、'>'、'<'、'>=' 和 '<='：

$collection = collect([
    ['name' => 'Jim', 'deleted_at' => '2019-01-01 00:00:00'],
    ['name' => 'Sally', 'deleted_at' => '2019-01-02 00:00:00'],
    ['name' => 'Sue', 'deleted_at' => null],
]);

$filtered = $collection->where('deleted_at', '!=', null);

$filtered->all();

/*
    [
        ['name' => 'Jim', 'deleted_at' => '2019-01-01 00:00:00'],
        ['name' => 'Sally', 'deleted_at' => '2019-01-02 00:00:00'],
    ]
*/

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

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

$filtered->all();

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

whereNull()whereNull 方法返回集合中给定键为 null 的项目：

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

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

集合还支持“高级消息”，这是执行集合上常见操作的快捷方式。提供高级消息的集合方法有：average、avg、contains、each、every、filter、first、flatMap、groupBy、keyBy、map、max、min、partition、reject、skipUntil、skipWhile、some、sortBy、sortByDesc、sum、takeUntil、takeWhile 和 unique。

每个高级消息都可以作为集合实例上的动态属性来访问。例如，让我们使用 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 Collections）

简介

在学习更多关于 Laravel 的惰性集合之前，请花一些时间熟悉 PHP 生成器。

为了补充已经很强大的 Collection 类，LazyCollection 类利用 PHP 的生成器，让您能够处理非常大的数据集，同时保持内存使用量较低。

例如，假设您的应用程序需要处理一个多 GB 的日志文件，同时利用 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;
}

创建惰性集合

要创建惰性集合实例，您应该将 PHP 生成器函数传递给集合的 make 方法：

use Illuminate\Support\LazyCollection;

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

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

    fclose($handle);
});

可枚举契约（The Enumerable Contract）

Collection 类上的几乎所有方法也可用于 LazyCollection 类。这两个类都实现了 Illuminate\Support\Enumerable 契约，该契约定义了以下方法：

all
average
avg
chunk
chunkWhile
collapse
collect
combine
concat
contains
containsStrict
count
countBy
crossJoin
dd
diff
diffAssoc
diffKeys
dump
duplicates
duplicatesStrict
each
eachSpread
every
except
filter
first
firstOrFail
firstWhere
flatMap
flatten
flip
forPage
get
groupBy
has
implode
intersect
intersectAssoc
intersectByKeys
isEmpty
isNotEmpty
join
keyBy
keys
last
macro
make
map
mapInto
mapSpread
mapToGroups
mapWithKeys
max
median
merge
mergeRecursive
min
mode
nth
only
pad
partition
pipe
pluck
random
reduce
reject
replace
replaceRecursive
reverse
search
shuffle
skip
slice
sole
some
sort
sortBy
sortByDesc
sortKeys
sortKeysDesc
split
sum
take
tap
times
toArray
toJson
union
unique
uniqueStrict
unless
unlessEmpty
unlessNotEmpty
unwrap
values
when
whenEmpty
whenNotEmpty
where
whereStrict
whereBetween
whereIn
whereInStrict
whereInstanceOf
whereNotBetween
whereNotIn
whereNotInStrict
wrap
zip

更改集合的方法（例如 shift、pop、prepend 等）在 LazyCollection 类上不可用。

惰性集合方法

除了 Enumerable 契约中定义的方法外，LazyCollection 类还包含以下方法：

takeUntilTimeout()takeUntilTimeout 方法返回一个新的惰性集合，该集合将枚举值直到指定的时间。在该时间之后，集合将停止枚举：

$lazyCollection = LazyCollection::times(INF)
    ->takeUntilTimeout(now()->addMinute());

$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 方法只会在项目一个接一个地从列表中取出时调用给定的回调：

// 目前还没有任何东西被 dump...
$lazyCollection = LazyCollection::times(INF)->tapEach(function (int $value) {
    dump($value);
});

// 三个项目被 dump...
$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 方法返回一个新的惰性集合，它将记住任何已经枚举过的值，并且在随后的集合枚举中不会再次检索它们：

// 尚未执行查询...
$users = User::cursor()->remember();

// 查询被执行...
// 前 5 个用户从数据库中被 hydrated...
$users->take(5)->all();

// 前 5 个用户来自集合的缓存...
// 其余的从数据库中被 hydrated...
$users->take(20)->all();

withHeartbeat()withHeartbeat 方法允许您在惰性集合被枚举时以固定的时间间隔执行回调。这对于需要定期维护任务（例如延长锁或发送进度更新）的长时间运行操作特别有用：

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

$lock = Cache::lock('generate-reports', CarbonInterval::minutes(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();
    }
}

缓存

并发（Concurrency）