集合
简介
Illuminate\Support\Collection 类为处理数据数组提供了流畅、便捷的包装器。例如，查看以下代码。我们将使用 collect 辅助函数从数组创建一个新的集合实例，在每个元素上运行 strtoupper 函数，然后删除所有空元素
1$collection = collect(['taylor', 'abigail', null])->map(function (?string $name) {2 return strtoupper($name);3})->reject(function (string $name) {4 return empty($name);5});正如你所看到的，Collection 类允许你链式调用其方法，以对底层数组执行流畅的映射和归约操作。通常，集合是不可变的，这意味着每个 Collection 方法都会返回一个全新的 Collection 实例。
创建集合
如上所述，collect 辅助函数为给定的数组返回一个新的 Illuminate\Support\Collection 实例。因此，创建一个集合就像这样简单：
1$collection = collect([1, 2, 3]);Eloquent 查询的结果总是作为 Collection 实例返回。
扩展集合
集合是“可宏扩展的”，这允许你在运行时向 Collection 类添加额外的方法。Illuminate\Support\Collection 类的 macro 方法接受一个闭包，该闭包将在调用你的宏时执行。宏闭包可以像访问集合类的真实方法一样，通过 $this 访问集合的其他方法。例如，以下代码向 Collection 类添加了一个 toUpper 方法：
1use Illuminate\Support\Collection; 2use Illuminate\Support\Str; 3 4Collection::macro('toUpper', function () { 5 return $this->map(function (string $value) { 6 return Str::upper($value); 7 }); 8}); 9 10$collection = collect(['first', 'second']);11 12$upper = $collection->toUpper();13 14// ['FIRST', 'SECOND']通常，你应该在服务提供者的 boot 方法中声明集合宏。
宏参数
如有必要，你可以定义接受额外参数的宏
1use Illuminate\Support\Collection; 2use Illuminate\Support\Facades\Lang; 3 4Collection::macro('toLocale', function (string $locale) { 5 return $this->map(function (string $value) use ($locale) { 6 return Lang::get($value, [], $locale); 7 }); 8}); 9 10$collection = collect(['first', 'second']);11 12$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 dot dump duplicates duplicatesStrict each eachSpread ensure every except filter first firstOrFail firstWhere flatMap flatten flip forget forPage 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 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
1$collection = collect([1, 2, 3, 4, 5]);2 3$collection->after(3);4 5// 46 7$collection->after(5);8 9// null此方法使用“宽松”比较搜索给定的项目，这意味着包含整数值的字符串将被视为等于相同值的整数。要使用“严格”比较，你可以为该方法提供 strict 参数
1collect([2, 4, 6, 8])->after('4', strict: true);2 3// null或者，你可以提供你自己的闭包来搜索第一个通过给定真值测试的项目
1collect([2, 4, 6, 8])->after(function (int $item, int $key) {2 return $item > 5;3});4 5// 8all()
all 方法返回集合表示的底层数组
1collect([1, 2, 3])->all();2 3// [1, 2, 3]average()
avg 方法的别名。
avg()
avg 方法返回给定键的平均值
1$average = collect([ 2 ['foo' => 10], 3 ['foo' => 10], 4 ['foo' => 20], 5 ['foo' => 40] 6])->avg('foo'); 7 8// 20 9 10$average = collect([1, 1, 2, 4])->avg();11 12// 2before()
before 方法与 after 方法相反。它返回给定项目之前的项目。如果未找到给定项目或给定项目是第一个项目，则返回 null
1$collection = collect([1, 2, 3, 4, 5]); 2 3$collection->before(3); 4 5// 2 6 7$collection->before(1); 8 9// null10 11collect([2, 4, 6, 8])->before('4', strict: true);12 13// null14 15collect([2, 4, 6, 8])->before(function (int $item, int $key) {16 return $item > 5;17});18 19// 4chunk()
chunk 方法将集合分解为多个给定大小的较小集合
1$collection = collect([1, 2, 3, 4, 5, 6, 7]);2 3$chunks = $collection->chunk(4);4 5$chunks->all();6 7// [[1, 2, 3, 4], [5, 6, 7]]当在 视图 中使用网格系统（例如 Bootstrap）时，此方法特别有用。例如，假设你有一个 Eloquent 模型集合，你想要在网格中显示它们
1@foreach ($products->chunk(3) as $chunk)2 <div class="row">3 @foreach ($chunk as $product)4 <div class="col-xs-4">{{ $product->name }}</div>5 @endforeach6 </div>7@endforeachchunkWhile()
chunkWhile 方法根据给定回调的评估结果，将集合分解为多个较小的集合。传递给闭包的 $chunk 变量可用于检查前一个元素
1$collection = collect(str_split('AABBCCCD'));2 3$chunks = $collection->chunkWhile(function (string $value, int $key, Collection $chunk) {4 return $value === $chunk->last();5});6 7$chunks->all();8 9// [['A', 'A'], ['B', 'B'], ['C', 'C', 'C'], ['D']]collapse()
collapse 方法将数组集合折叠为单个扁平集合
1$collection = collect([ 2 [1, 2, 3], 3 [4, 5, 6], 4 [7, 8, 9], 5]); 6 7$collapsed = $collection->collapse(); 8 9$collapsed->all();10 11// [1, 2, 3, 4, 5, 6, 7, 8, 9]collapseWithKeys()
collapseWithKeys 方法将数组或集合的集合展平为单个集合，同时保持原始键不变
1$collection = collect([ 2 ['first' => collect([1, 2, 3])], 3 ['second' => [4, 5, 6]], 4 ['third' => collect([7, 8, 9])] 5]); 6 7$collapsed = $collection->collapseWithKeys(); 8 9$collapsed->all();10 11// [12// 'first' => [1, 2, 3],13// 'second' => [4, 5, 6],14// 'third' => [7, 8, 9],15// ]collect()
collect 方法返回一个新的 Collection 实例，其中包含集合中当前的项
1$collectionA = collect([1, 2, 3]);2 3$collectionB = $collectionA->collect();4 5$collectionB->all();6 7// [1, 2, 3]collect 方法主要用于将惰性集合转换为标准 Collection 实例
1$lazyCollection = LazyCollection::make(function () { 2 yield 1; 3 yield 2; 4 yield 3; 5}); 6 7$collection = $lazyCollection->collect(); 8 9$collection::class;10 11// 'Illuminate\Support\Collection'12 13$collection->all();14 15// [1, 2, 3]当你有一个 Enumerable 实例并且需要一个非惰性集合实例时，collect 方法尤其有用。由于 collect() 是 Enumerable 契约的一部分，因此你可以安全地使用它来获取 Collection 实例。
combine()
combine 方法将集合的值（作为键）与另一个数组或集合的值组合在一起
1$collection = collect(['name', 'age']);2 3$combined = $collection->combine(['George', 29]);4 5$combined->all();6 7// ['name' => 'George', 'age' => 29]concat()
concat 方法将给定的 array 或集合的值附加到另一个集合的末尾
1$collection = collect(['John Doe']);2 3$concatenated = $collection->concat(['Jane Doe'])->concat(['name' => 'Johnny Doe']);4 5$concatenated->all();6 7// ['John Doe', 'Jane Doe', 'Johnny Doe']concat 方法为连接到原始集合的项目重新索引数字键。要在关联集合中维护键，请参阅 merge 方法。
contains()
contains 方法确定集合是否包含给定的项目。你可以将闭包传递给 contains 方法，以确定集合中是否存在与给定真值测试匹配的元素
1$collection = collect([1, 2, 3, 4, 5]);2 3$collection->contains(function (int $value, int $key) {4 return $value > 5;5});6 7// false或者，你可以将字符串传递给 contains 方法，以确定集合是否包含给定的项目值
1$collection = collect(['name' => 'Desk', 'price' => 100]);2 3$collection->contains('Desk');4 5// true6 7$collection->contains('New York');8 9// false你还可以将键/值对传递给 contains 方法，这将确定给定对是否存在于集合中
1$collection = collect([2 ['product' => 'Desk', 'price' => 200],3 ['product' => 'Chair', 'price' => 100],4]);5 6$collection->contains('product', 'Bookcase');7 8// falsecontains 方法在检查项目值时使用“宽松”比较，这意味着具有整数值的字符串将被视为等于相同值的整数。使用 containsStrict 方法使用“严格”比较进行过滤。
对于 contains 的反向操作，请参阅 doesntContain 方法。
containsOneItem()
containsOneItem 方法确定集合是否包含单个项目
1collect([])->containsOneItem(); 2 3// false 4 5collect(['1'])->containsOneItem(); 6 7// true 8 9collect(['1', '2'])->containsOneItem();10 11// falsecontainsStrict()
此方法具有与 contains 方法相同的签名；但是，所有值都使用“严格”比较进行比较。
当使用 Eloquent 集合时，此方法的行为会被修改。
count()
count 方法返回集合中项目的总数
1$collection = collect([1, 2, 3, 4]);2 3$collection->count();4 5// 4countBy()
countBy 方法计算集合中值的出现次数。默认情况下，该方法计算每个元素的出现次数，允许你计算集合中某些“类型”的元素
1$collection = collect([1, 2, 2, 2, 3]);2 3$counted = $collection->countBy();4 5$counted->all();6 7// [1 => 1, 2 => 3, 3 => 1]你将闭包传递给 countBy 方法，以按自定义值计算所有项目
2 3$counted = $collection->countBy(function (string $email) {4 return substr(strrchr($email, "@"), 1);5});6 7$counted->all();8 9// ['gmail.com' => 2, 'yahoo.com' => 1]crossJoin()
crossJoin 方法在给定的数组或集合之间交叉连接集合的值，返回包含所有可能排列的笛卡尔积
1$collection = collect([1, 2]); 2 3$matrix = $collection->crossJoin(['a', 'b']); 4 5$matrix->all(); 6 7/* 8 [ 9 [1, 'a'],10 [1, 'b'],11 [2, 'a'],12 [2, 'b'],13 ]14*/15 16$collection = collect([1, 2]);17 18$matrix = $collection->crossJoin(['a', 'b'], ['I', 'II']);19 20$matrix->all();21 22/*23 [24 [1, 'a', 'I'],25 [1, 'a', 'II'],26 [1, 'b', 'I'],27 [1, 'b', 'II'],28 [2, 'a', 'I'],29 [2, 'a', 'II'],30 [2, 'b', 'I'],31 [2, 'b', 'II'],32 ]33*/dd()
dd 方法转储集合的项目并结束脚本的执行
1$collection = collect(['John Doe', 'Jane Doe']); 2 3$collection->dd(); 4 5/* 6 Collection { 7 #items: array:2 [ 8 0 => "John Doe" 9 1 => "Jane Doe"10 ]11 }12*/如果你不想停止执行脚本，请改用 dump 方法。
diff()
diff 方法根据值将集合与另一个集合或纯 PHP array 进行比较。此方法将返回原始集合中不存在于给定集合中的值
1$collection = collect([1, 2, 3, 4, 5]);2 3$diff = $collection->diff([2, 4, 6, 8]);4 5$diff->all();6 7// [1, 3, 5]当使用 Eloquent 集合时，此方法的行为会被修改。
diffAssoc()
diffAssoc 方法根据键和值将集合与另一个集合或纯 PHP array 进行比较。此方法将返回原始集合中不存在于给定集合中的键/值对
1$collection = collect([ 2 'color' => 'orange', 3 'type' => 'fruit', 4 'remain' => 6, 5]); 6 7$diff = $collection->diffAssoc([ 8 'color' => 'yellow', 9 'type' => 'fruit',10 'remain' => 3,11 'used' => 6,12]);13 14$diff->all();15 16// ['color' => 'orange', 'remain' => 6]diffAssocUsing()
与 diffAssoc 不同，diffAssocUsing 接受用户提供的回调函数用于索引比较
1$collection = collect([ 2 'color' => 'orange', 3 'type' => 'fruit', 4 'remain' => 6, 5]); 6 7$diff = $collection->diffAssocUsing([ 8 'Color' => 'yellow', 9 'Type' => 'fruit',10 'Remain' => 3,11], 'strnatcasecmp');12 13$diff->all();14 15// ['color' => 'orange', 'remain' => 6]回调必须是一个比较函数，它返回一个小于、等于或大于零的整数。有关更多信息，请参阅 PHP 文档中关于 array_diff_uassoc 的说明，这是 diffAssocUsing 方法在内部使用的 PHP 函数。
diffKeys()
diffKeys 方法根据键将集合与另一个集合或纯 PHP array 进行比较。此方法将返回原始集合中不存在于给定集合中的键/值对
1$collection = collect([ 2 'one' => 10, 3 'two' => 20, 4 'three' => 30, 5 'four' => 40, 6 'five' => 50, 7]); 8 9$diff = $collection->diffKeys([10 'two' => 2,11 'four' => 4,12 'six' => 6,13 'eight' => 8,14]);15 16$diff->all();17 18// ['one' => 10, 'three' => 30, 'five' => 50]doesntContain()
doesntContain 方法确定集合是否不包含给定的项目。你可以将闭包传递给 doesntContain 方法，以确定集合中是否存在不与给定真值测试匹配的元素
1$collection = collect([1, 2, 3, 4, 5]);2 3$collection->doesntContain(function (int $value, int $key) {4 return $value < 5;5});6 7// false或者，你可以将字符串传递给 doesntContain 方法，以确定集合是否不包含给定的项目值
1$collection = collect(['name' => 'Desk', 'price' => 100]);2 3$collection->doesntContain('Table');4 5// true6 7$collection->doesntContain('Desk');8 9// false你还可以将键/值对传递给 doesntContain 方法，这将确定给定对是否不存在于集合中
1$collection = collect([2 ['product' => 'Desk', 'price' => 200],3 ['product' => 'Chair', 'price' => 100],4]);5 6$collection->doesntContain('product', 'Bookcase');7 8// truedoesntContain 方法在检查项目值时使用“宽松”比较，这意味着具有整数值的字符串将被视为等于相同值的整数。
dot()
dot 方法将多维集合展平为单级集合，该集合使用“点”表示法来指示深度
1$collection = collect(['products' => ['desk' => ['price' => 100]]]);2 3$flattened = $collection->dot();4 5$flattened->all();6 7// ['products.desk.price' => 100]dump()
dump 方法转储集合的项目
1 2``````php 3$collection = collect(['John Doe', 'Jane Doe']); 4 5$collection->dump(); 6 7/* 8 Collection { 9 #items: array:2 [10 0 => "John Doe"11 1 => "Jane Doe"12 ]13 }14*/如果你想在转储集合后停止执行脚本，请改用 dd 方法。
duplicates()
duplicates 方法从集合中检索并返回重复值
1 2``````php3$collection = collect(['a', 'b', 'a', 'c', 'b']);4 5$collection->duplicates();6 7// [2 => 'a', 4 => 'b']如果集合包含数组或对象，你可以传递你希望检查重复值的属性的键
1 2``````php 3$employees = collect([ 7]); 8 9$employees->duplicates('position');10 11// [2 => 'Developer']duplicatesStrict()
此方法具有与 duplicates 方法相同的签名；但是，所有值都使用“严格”比较进行比较。
each()
each 方法迭代集合中的项目并将每个项目传递给一个闭包
1$collection = collect([1, 2, 3, 4]);2 3$collection->each(function (int $item, int $key) {4 // ...5});如果你想停止迭代项目，你可以从闭包中返回 false
1$collection->each(function (int $item, int $key) {2 if (/* condition */) {3 return false;4 }5});eachSpread()
eachSpread 方法迭代集合的项目，并将每个嵌套的项目值传递到给定的回调中
1$collection = collect([['John Doe', 35], ['Jane Doe', 33]]);2 3$collection->eachSpread(function (string $name, int $age) {4 // ...5});你可以通过从回调中返回 false 来停止迭代项目
1$collection->eachSpread(function (string $name, int $age) {2 return false;3});ensure()
ensure 方法可用于验证集合的所有元素是否为给定的类型或类型列表。否则，将抛出 UnexpectedValueException 异常
1return $collection->ensure(User::class);2 3return $collection->ensure([User::class, Customer::class]);也可以指定原始类型，例如 string、int、float、bool 和 array
1return $collection->ensure('int');ensure 方法不保证以后不会将不同类型的元素添加到集合中。
every()
every 方法可用于验证集合的所有元素是否都通过给定的真值测试
1collect([1, 2, 3, 4])->every(function (int $value, int $key) {2 return $value > 2;3});4 5// false如果集合为空，则 every 方法将返回 true
1$collection = collect([]);2 3$collection->every(function (int $value, int $key) {4 return $value > 2;5});6 7// trueexcept()
except 方法返回集合中除了具有指定键的项目之外的所有项目
1$collection = collect(['product_id' => 1, 'price' => 100, 'discount' => false]);2 3$filtered = $collection->except(['price', 'discount']);4 5$filtered->all();6 7// ['product_id' => 1]对于 except 的反向操作，请参阅 only 方法。
当使用 Eloquent 集合时，此方法的行为会被修改。
filter()
filter 方法使用给定的回调过滤集合，仅保留那些通过给定真值测试的项目
1$collection = collect([1, 2, 3, 4]);2 3$filtered = $collection->filter(function (int $value, int $key) {4 return $value > 2;5});6 7$filtered->all();8 9// [3, 4]如果未提供回调，则将删除集合中所有等效于 false 的条目
1$collection = collect([1, 2, 3, null, false, '', 0, []]);2 3$collection->filter()->all();4 5// [1, 2, 3]对于 filter 的反向操作，请参阅 reject 方法。
first()
first 方法返回集合中第一个通过给定真值测试的元素
1collect([1, 2, 3, 4])->first(function (int $value, int $key) {2 return $value > 2;3});4 5// 3你也可以在不带参数的情况下调用 first 方法，以获取集合中的第一个元素。如果集合为空，则返回 null
1collect([1, 2, 3, 4])->first();2 3// 1firstOrFail()
firstOrFail 方法与 first 方法相同；但是，如果未找到结果，则会抛出 Illuminate\Support\ItemNotFoundException 异常
1collect([1, 2, 3, 4])->firstOrFail(function (int $value, int $key) {2 return $value > 5;3});4 5// Throws ItemNotFoundException...你也可以在不带参数的情况下调用 firstOrFail 方法，以获取集合中的第一个元素。如果集合为空，则会抛出 Illuminate\Support\ItemNotFoundException 异常
1collect([])->firstOrFail();2 3// Throws ItemNotFoundException...firstWhere()
firstWhere 方法返回集合中第一个具有给定键/值对的元素
1$collection = collect([ 2 ['name' => 'Regena', 'age' => null], 3 ['name' => 'Linda', 'age' => 14], 4 ['name' => 'Diego', 'age' => 23], 5 ['name' => 'Linda', 'age' => 84], 6]); 7 8$collection->firstWhere('name', 'Linda'); 9 10// ['name' => 'Linda', 'age' => 14]你也可以使用比较运算符调用 firstWhere 方法
1$collection->firstWhere('age', '>=', 18);2 3// ['name' => 'Diego', 'age' => 23]与 where 方法类似，你可以将一个参数传递给 firstWhere 方法。在这种情况下，firstWhere 方法将返回给定项目键的值为“truthy”的第一个项目
1$collection->firstWhere('age');2 3// ['name' => 'Linda', 'age' => 14]flatMap()
flatMap 方法迭代集合并将每个值传递给给定的闭包。闭包可以自由修改项目并返回它，从而形成一个新的修改后的项目集合。然后，数组被展平一级
1$collection = collect([ 2 ['name' => 'Sally'], 3 ['school' => 'Arkansas'], 4 ['age' => 28] 5]); 6 7$flattened = $collection->flatMap(function (array $values) { 8 return array_map('strtoupper', $values); 9});10 11$flattened->all();12 13// ['name' => 'SALLY', 'school' => 'ARKANSAS', 'age' => '28'];flatten()
flatten 方法将多维集合展平为单维
1$collection = collect([ 2 'name' => 'taylor', 3 'languages' => [ 4 'php', 'javascript' 5 ] 6]); 7 8$flattened = $collection->flatten(); 9 10$flattened->all();11 12// ['taylor', 'php', 'javascript'];如有必要，你可以为 flatten 方法传递一个“depth”参数
1$collection = collect([ 2 'Apple' => [ 3 [ 4 'name' => 'iPhone 6S', 5 'brand' => 'Apple' 6 ], 7 ], 8 'Samsung' => [ 9 [10 'name' => 'Galaxy S7',11 'brand' => 'Samsung'12 ],13 ],14]);15 16$products = $collection->flatten(1);17 18$products->values()->all();19 20/*21 [22 ['name' => 'iPhone 6S', 'brand' => 'Apple'],23 ['name' => 'Galaxy S7', 'brand' => 'Samsung'],24 ]25*/在此示例中，在不提供深度的情况下调用 flatten 也会展平嵌套数组，从而得到 ['iPhone 6S', 'Apple', 'Galaxy S7', 'Samsung']。提供深度允许你指定嵌套数组将被展平的级别数。
flip()
flip 方法交换集合的键及其对应的值
1$collection = collect(['name' => 'taylor', 'framework' => 'laravel']);2 3$flipped = $collection->flip();4 5$flipped->all();6 7// ['taylor' => 'name', 'laravel' => 'framework']forget()
forget 方法通过键从集合中删除一个项目
1$collection = collect(['name' => 'taylor', 'framework' => 'laravel']); 2 3// Forget a single key... 4$collection->forget('name'); 5 6// ['framework' => 'laravel'] 7 8// Forget multiple keys... 9$collection->forget(['name', 'framework']);10 11// []与大多数其他集合方法不同，forget 不会返回新的修改后的集合；它会修改并返回调用它的集合。
forPage()
forPage 方法返回一个新的集合，其中包含将出现在给定页码上的项目。该方法接受页码作为其第一个参数，每页显示的项目数作为其第二个参数
1$collection = collect([1, 2, 3, 4, 5, 6, 7, 8, 9]);2 3$chunk = $collection->forPage(2, 3);4 5$chunk->all();6 7// [4, 5, 6]get()
get 方法返回给定键处的项目。如果键不存在，则返回 null
1$collection = collect(['name' => 'taylor', 'framework' => 'laravel']);2 3$value = $collection->get('name');4 5// taylor你可以选择性地传递一个默认值作为第二个参数
1$collection = collect(['name' => 'taylor', 'framework' => 'laravel']);2 3$value = $collection->get('age', 34);4 5// 34你甚至可以将回调作为该方法的默认值传递。如果指定的键不存在，则将返回回调的结果
1$collection->get('email', function () {3});4 groupBy()
groupBy 方法按给定的键对集合的项目进行分组
1$collection = collect([ 2 ['account_id' => 'account-x10', 'product' => 'Chair'], 3 ['account_id' => 'account-x10', 'product' => 'Bookcase'], 4 ['account_id' => 'account-x11', 'product' => 'Desk'], 5]); 6 7$grouped = $collection->groupBy('account_id'); 8 9$grouped->all();10 11/*12 [13 'account-x10' => [14 ['account_id' => 'account-x10', 'product' => 'Chair'],15 ['account_id' => 'account-x10', 'product' => 'Bookcase'],16 ],17 'account-x11' => [18 ['account_id' => 'account-x11', 'product' => 'Desk'],19 ],20 ]21*/你可以传递一个回调而不是传递字符串 key。回调应返回你希望作为分组键的值
1$grouped = $collection->groupBy(function (array $item, int $key) { 2 return substr($item['account_id'], -3); 3}); 4 5$grouped->all(); 6 7/* 8 [ 9 'x10' => [10 ['account_id' => 'account-x10', 'product' => 'Chair'],11 ['account_id' => 'account-x10', 'product' => 'Bookcase'],12 ],13 'x11' => [14 ['account_id' => 'account-x11', 'product' => 'Desk'],15 ],16 ]17*/可以将多个分组条件作为数组传递。每个数组元素将应用于多维数组中的相应级别
1$data = new Collection([ 2 10 => ['user' => 1, 'skill' => 1, 'roles' => ['Role_1', 'Role_3']], 3 20 => ['user' => 2, 'skill' => 1, 'roles' => ['Role_1', 'Role_2']], 4 30 => ['user' => 3, 'skill' => 2, 'roles' => ['Role_1']], 5 40 => ['user' => 4, 'skill' => 2, 'roles' => ['Role_2']], 6]); 7 8$result = $data->groupBy(['skill', function (array $item) { 9 return $item['roles'];10}], preserveKeys: true);11 12/*13[14 1 => [15 'Role_1' => [16 10 => ['user' => 1, 'skill' => 1, 'roles' => ['Role_1', 'Role_3']],17 20 => ['user' => 2, 'skill' => 1, 'roles' => ['Role_1', 'Role_2']],18 ],19 'Role_2' => [20 20 => ['user' => 2, 'skill' => 1, 'roles' => ['Role_1', 'Role_2']],21 ],22 'Role_3' => [23 10 => ['user' => 1, 'skill' => 1, 'roles' => ['Role_1', 'Role_3']],24 ],25 ],26 2 => [27 'Role_1' => [28 30 => ['user' => 3, 'skill' => 2, 'roles' => ['Role_1']],29 ],30 'Role_2' => [31 40 => ['user' => 4, 'skill' => 2, 'roles' => ['Role_2']],32 ],33 ],34];35*/has()
has 方法确定集合中是否存在给定的键
1$collection = collect(['account_id' => 1, 'product' => 'Desk', 'amount' => 5]); 2 3$collection->has('product'); 4 5// true 6 7$collection->has(['product', 'amount']); 8 9// true10 11$collection->has(['amount', 'price']);12 13// falsehasAny()
hasAny 方法确定集合中是否存在任何给定的键
1$collection = collect(['account_id' => 1, 'product' => 'Desk', 'amount' => 5]);2 3$collection->hasAny(['product', 'price']);4 5// true6 7$collection->hasAny(['name', 'price']);8 9// falseimplode()
implode 方法连接集合中的项目。其参数取决于集合中项目的类型。如果集合包含数组或对象，则应传递你希望连接的属性的键，以及你希望放置在值之间的“胶水”字符串
1$collection = collect([2 ['account_id' => 1, 'product' => 'Desk'],3 ['account_id' => 2, 'product' => 'Chair'],4]);5 6$collection->implode('product', ', ');7 8// Desk, Chair如果集合包含简单的字符串或数值，则应将“胶水”作为该方法的唯一参数传递
1collect([1, 2, 3, 4, 5])->implode('-');2 3// '1-2-3-4-5'如果你想格式化正在连接的值，则可以将闭包传递给 implode 方法
1$collection->implode(function (array $item, int $key) {2 return strtoupper($item['product']);3}, ', ');4 5// DESK, CHAIRintersect()
intersect 方法从原始集合中删除给定 array 或集合中不存在的任何值。结果集合将保留原始集合的键
1$collection = collect(['Desk', 'Sofa', 'Chair']);2 3$intersect = $collection->intersect(['Desk', 'Chair', 'Bookcase']);4 5$intersect->all();6 7// [0 => 'Desk', 2 => 'Chair']当使用 Eloquent 集合时，此方法的行为会被修改。
intersectUsing()
intersectUsing 方法从原始集合中删除给定 array 或集合中不存在的任何值，并使用自定义回调来比较值。结果集合将保留原始集合的键
1$collection = collect(['Desk', 'Sofa', 'Chair']);2 3$intersect = $collection->intersectUsing(['desk', 'chair', 'bookcase'], function ($a, $b) {4 return strcasecmp($a, $b);5});6 7$intersect->all();8 9// [0 => 'Desk', 2 => 'Chair']intersectAssoc()
intersectAssoc 方法将原始集合与另一个集合或 array 进行比较，返回所有给定集合中都存在的键/值对
1$collection = collect([ 2 'color' => 'red', 3 'size' => 'M', 4 'material' => 'cotton' 5]); 6 7$intersect = $collection->intersectAssoc([ 8 'color' => 'blue', 9 'size' => 'M',10 'material' => 'polyester'11]);12 13$intersect->all();14 15// ['size' => 'M']intersectAssocUsing()
intersectAssocUsing 方法将原始集合与另一个集合或 array 进行比较，返回两者都存在的键/值对，并使用自定义比较回调来确定键和值的相等性
1$collection = collect([ 2 'color' => 'red', 3 'Size' => 'M', 4 'material' => 'cotton', 5]); 6 7$intersect = $collection->intersectAssocUsing([ 8 'color' => 'blue', 9 'size' => 'M',10 'material' => 'polyester',11], function ($a, $b) {12 return strcasecmp($a, $b);13});14 15$intersect->all();16 17// ['Size' => 'M']intersectByKeys()
intersectByKeys 方法会从原始集合中移除所有键及其对应的值，这些键未在给定的 array 或集合中出现。
1$collection = collect([ 2 'serial' => 'UX301', 'type' => 'screen', 'year' => 2009, 3]); 4 5$intersect = $collection->intersectByKeys([ 6 'reference' => 'UX404', 'type' => 'tab', 'year' => 2011, 7]); 8 9$intersect->all();10 11// ['type' => 'screen', 'year' => 2009]isEmpty()
isEmpty 方法会返回 true，如果集合为空；否则，返回 false。
1collect([])->isEmpty();2 3// trueisNotEmpty()
isNotEmpty 方法会返回 true，如果集合不为空；否则，返回 false。
1collect([])->isNotEmpty();2 3// falsejoin()
join 方法使用字符串连接集合中的值。使用此方法的第二个参数，您还可以指定如何将最后一个元素附加到字符串。
1collect(['a', 'b', 'c'])->join(', '); // 'a, b, c'2collect(['a', 'b', 'c'])->join(', ', ', and '); // 'a, b, and c'3collect(['a', 'b'])->join(', ', ' and '); // 'a and b'4collect(['a'])->join(', ', ' and '); // 'a'5collect([])->join(', ', ' and '); // ''keyBy()
keyBy 方法通过给定的键对集合进行键控。如果多个项目具有相同的键，则只有最后一个项目会出现在新集合中。
1$collection = collect([ 2 ['product_id' => 'prod-100', 'name' => 'Desk'], 3 ['product_id' => 'prod-200', 'name' => 'Chair'], 4]); 5 6$keyed = $collection->keyBy('product_id'); 7 8$keyed->all(); 9 10/*11 [12 'prod-100' => ['product_id' => 'prod-100', 'name' => 'Desk'],13 'prod-200' => ['product_id' => 'prod-200', 'name' => 'Chair'],14 ]15*/您还可以传递一个回调函数给此方法。回调函数应返回用于键控集合的值。
1$keyed = $collection->keyBy(function (array $item, int $key) { 2 return strtoupper($item['product_id']); 3}); 4 5$keyed->all(); 6 7/* 8 [ 9 'PROD-100' => ['product_id' => 'prod-100', 'name' => 'Desk'],10 'PROD-200' => ['product_id' => 'prod-200', 'name' => 'Chair'],11 ]12*/keys()
keys 方法返回集合的所有键。
1$collection = collect([ 2 'prod-100' => ['product_id' => 'prod-100', 'name' => 'Desk'], 3 'prod-200' => ['product_id' => 'prod-200', 'name' => 'Chair'], 4]); 5 6$keys = $collection->keys(); 7 8$keys->all(); 9 10// ['prod-100', 'prod-200']last()
last 方法返回集合中最后一个通过给定真值测试的元素。
1collect([1, 2, 3, 4])->last(function (int $value, int $key) {2 return $value < 3;3});4 5// 2您也可以在不带参数的情况下调用 last 方法，以获取集合中的最后一个元素。如果集合为空，则返回 null。
1collect([1, 2, 3, 4])->last();2 3// 4lazy()
lazy 方法从底层项目数组返回一个新的 LazyCollection 实例。
1$lazyCollection = collect([1, 2, 3, 4])->lazy();2 3$lazyCollection::class;4 5// Illuminate\Support\LazyCollection6 7$lazyCollection->all();8 9// [1, 2, 3, 4]当您需要对包含大量项目的庞大 Collection 执行转换时，这尤其有用。
1$count = $hugeCollection2 ->lazy()3 ->where('country', 'FR')4 ->where('balance', '>', '100')5 ->count();通过将集合转换为 LazyCollection，我们避免了分配大量额外内存。虽然原始集合仍然将其值保存在内存中，但后续的过滤器则不会。因此，在过滤集合的结果时，实际上不会分配额外的内存。
macro()
静态 macro 方法允许您在运行时向 Collection 类添加方法。有关更多信息，请参阅关于 扩展集合 的文档。
make()
静态 make 方法创建一个新的集合实例。请参阅 创建集合 部分。
map()
map 方法迭代集合，并将每个值传递给给定的回调函数。回调函数可以自由修改项目并返回它，从而形成一个包含修改后项目的新集合。
1$collection = collect([1, 2, 3, 4, 5]);2 3$multiplied = $collection->map(function (int $item, int $key) {4 return $item * 2;5});6 7$multiplied->all();8 9// [2, 4, 6, 8, 10]像大多数其他集合方法一样，map 返回一个新的集合实例；它不会修改在其上调用的集合。如果您想转换原始集合，请使用 transform 方法。
mapInto()
mapInto() 方法迭代集合，通过将值传递给构造函数来创建给定类的新实例。
1class Currency 2{ 3 /** 4 * Create a new currency instance. 5 */ 6 function __construct( 7 public string $code, 8 ) {} 9}10 11$collection = collect(['USD', 'EUR', 'GBP']);12 13$currencies = $collection->mapInto(Currency::class);14 15$currencies->all();16 17// [Currency('USD'), Currency('EUR'), Currency('GBP')]mapSpread()
mapSpread 方法迭代集合的项目，并将每个嵌套的项目值传递给给定的闭包。闭包可以自由修改项目并返回它，从而形成一个包含修改后项目的新集合。
1$collection = collect([0, 1, 2, 3, 4, 5, 6, 7, 8, 9]); 2 3$chunks = $collection->chunk(2); 4 5$sequence = $chunks->mapSpread(function (int $even, int $odd) { 6 return $even + $odd; 7}); 8 9$sequence->all();10 11// [1, 5, 9, 13, 17]mapToGroups()
mapToGroups 方法通过给定的闭包对集合的项目进行分组。闭包应返回一个包含单个键/值对的关联数组，从而形成一个包含分组值的新集合。
1$collection = collect([ 2 [ 3 'name' => 'John Doe', 4 'department' => 'Sales', 5 ], 6 [ 7 'name' => 'Jane Doe', 8 'department' => 'Sales', 9 ],10 [11 'name' => 'Johnny Doe',12 'department' => 'Marketing',13 ]14]);15 16$grouped = $collection->mapToGroups(function (array $item, int $key) {17 return [$item['department'] => $item['name']];18});19 20$grouped->all();21 22/*23 [24 'Sales' => ['John Doe', 'Jane Doe'],25 'Marketing' => ['Johnny Doe'],26 ]27*/28 29$grouped->get('Sales')->all();30 31// ['John Doe', 'Jane Doe']mapWithKeys()
mapWithKeys 方法迭代集合，并将每个值传递给给定的回调函数。回调函数应返回一个包含单个键/值对的关联数组。
1$collection = collect([ 2 [ 3 'name' => 'John', 4 'department' => 'Sales', 6 ], 7 [ 8 'name' => 'Jane', 9 'department' => 'Marketing',11 ]12]);13 14$keyed = $collection->mapWithKeys(function (array $item, int $key) {15 return [$item['email'] => $item['name']];16});17 18$keyed->all();19 20/*21 [22 '[email protected]' => 'John',23 '[email protected]' => 'Jane',24 ]25*/max()
max 方法返回给定键的最大值。
1$max = collect([ 2 ['foo' => 10], 3 ['foo' => 20] 4])->max('foo'); 5 6// 20 7 8$max = collect([1, 2, 3, 4, 5])->max(); 9 10// 5median()
median 方法返回给定键的 中位数。
1$median = collect([ 2 ['foo' => 10], 3 ['foo' => 10], 4 ['foo' => 20], 5 ['foo' => 40] 6])->median('foo'); 7 8// 15 9 10$median = collect([1, 1, 2, 4])->median();11 12// 1.5merge()
merge 方法将给定的数组或集合与原始集合合并。如果给定项目中的字符串键与原始集合中的字符串键匹配，则给定项目的值将覆盖原始集合中的值。
1$collection = collect(['product_id' => 1, 'price' => 100]);2 3$merged = $collection->merge(['price' => 200, 'discount' => false]);4 5$merged->all();6 7// ['product_id' => 1, 'price' => 200, 'discount' => false]如果给定项目的键是数字，则这些值将追加到集合的末尾。
1$collection = collect(['Desk', 'Chair']);2 3$merged = $collection->merge(['Bookcase', 'Door']);4 5$merged->all();6 7// ['Desk', 'Chair', 'Bookcase', 'Door']mergeRecursive()
mergeRecursive 方法以递归方式将给定的数组或集合与原始集合合并。如果给定项目中的字符串键与原始集合中的字符串键匹配，则这些键的值将合并到一个数组中，并且这是递归完成的。
1$collection = collect(['product_id' => 1, 'price' => 100]); 2 3$merged = $collection->mergeRecursive([ 4 'product_id' => 2, 5 'price' => 200, 6 'discount' => false 7]); 8 9$merged->all();10 11// ['product_id' => [1, 2], 'price' => [100, 200], 'discount' => false]min()
min 方法返回给定键的最小值。
1$min = collect([['foo' => 10], ['foo' => 20]])->min('foo');2 3// 104 5$min = collect([1, 2, 3, 4, 5])->min();6 7// 1mode()
mode 方法返回给定键的 众数。
1$mode = collect([ 2 ['foo' => 10], 3 ['foo' => 10], 4 ['foo' => 20], 5 ['foo' => 40] 6])->mode('foo'); 7 8// [10] 9 10$mode = collect([1, 1, 2, 4])->mode();11 12// [1]13 14$mode = collect([1, 1, 2, 2])->mode();15 16// [1, 2]multiply()
multiply 方法创建集合中所有项目的指定数量的副本。
1$users = collect([ 4])->multiply(3); 5 6/* 7 [ 8 ['name' => 'User #1', 'email' => '[email protected]'], 9 ['name' => 'User #2', 'email' => '[email protected]'],10 ['name' => 'User #1', 'email' => '[email protected]'],11 ['name' => 'User #2', 'email' => '[email protected]'],12 ['name' => 'User #1', 'email' => '[email protected]'],13 ['name' => 'User #2', 'email' => '[email protected]'],14 ]15*/nth()
nth 方法创建一个新集合，其中包含每第 n 个元素。
1$collection = collect(['a', 'b', 'c', 'd', 'e', 'f']);2 3$collection->nth(4);4 5// ['a', 'e']您可以选择传递一个起始偏移量作为第二个参数。
1$collection->nth(4, 1);2 3// ['b', 'f']only()
only 方法返回集合中具有指定键的项目。
1$collection = collect([ 2 'product_id' => 1, 3 'name' => 'Desk', 4 'price' => 100, 5 'discount' => false 6]); 7 8$filtered = $collection->only(['product_id', 'name']); 9 10$filtered->all();11 12// ['product_id' => 1, 'name' => 'Desk']对于 only 的逆操作，请参阅 except 方法。
当使用 Eloquent 集合 时，此方法的行为会发生修改。
pad()
pad 方法将使用给定的值填充数组，直到数组达到指定的尺寸。此方法的行为类似于 array_pad PHP 函数。
要向左填充，您应指定一个负数尺寸。如果给定尺寸的绝对值小于或等于数组的长度，则不会进行填充。
1$collection = collect(['A', 'B', 'C']); 2 3$filtered = $collection->pad(5, 0); 4 5$filtered->all(); 6 7// ['A', 'B', 'C', 0, 0] 8 9$filtered = $collection->pad(-5, 0);10 11$filtered->all();12 13// [0, 0, 'A', 'B', 'C']partition()
partition 方法可以与 PHP 数组解构结合使用，以将通过给定真值测试的元素与未通过测试的元素分开。
1$collection = collect([1, 2, 3, 4, 5, 6]); 2 3[$underThree, $equalOrAboveThree] = $collection->partition(function (int $i) { 4 return $i < 3; 5}); 6 7$underThree->all(); 8 9// [1, 2]10 11$equalOrAboveThree->all();12 13// [3, 4, 5, 6]percentage()
percentage 方法可用于快速确定集合中通过给定真值测试的项目的百分比。
1$collection = collect([1, 1, 2, 2, 2, 3]);2 3$percentage = $collection->percentage(fn ($value) => $value === 1);4 5// 33.33默认情况下，百分比将四舍五入到小数点后两位。但是，您可以通过为该方法提供第二个参数来自定义此行为。
1$percentage = $collection->percentage(fn ($value) => $value === 1, precision: 3);2 3// 33.333pipe()
pipe 方法将集合传递给给定的闭包，并返回执行的闭包的结果。
1$collection = collect([1, 2, 3]);2 3$piped = $collection->pipe(function (Collection $collection) {4 return $collection->sum();5});6 7// 6pipeInto()
pipeInto 方法创建给定类的新实例，并将集合传递给构造函数。
1class ResourceCollection 2{ 3 /** 4 * Create a new ResourceCollection instance. 5 */ 6 public function __construct( 7 public Collection $collection, 8 ) {} 9}10 11$collection = collect([1, 2, 3]);12 13$resource = $collection->pipeInto(ResourceCollection::class);14 15$resource->collection->all();16 17// [1, 2, 3]pipeThrough()
pipeThrough 方法将集合传递给给定的闭包数组，并返回执行的闭包的结果。
1use Illuminate\Support\Collection; 2 3$collection = collect([1, 2, 3]); 4 5$result = $collection->pipeThrough([ 6 function (Collection $collection) { 7 return $collection->merge([4, 5]); 8 }, 9 function (Collection $collection) {10 return $collection->sum();11 },12]);13 14// 15pluck()
pluck 方法检索给定键的所有值。
1$collection = collect([ 2 ['product_id' => 'prod-100', 'name' => 'Desk'], 3 ['product_id' => 'prod-200', 'name' => 'Chair'], 4]); 5 6$plucked = $collection->pluck('name'); 7 8$plucked->all(); 9 10// ['Desk', 'Chair']您还可以指定希望如何键控结果集合。
1$plucked = $collection->pluck('name', 'product_id');2 3$plucked->all();4 5// ['prod-100' => 'Desk', 'prod-200' => 'Chair']pluck 方法还支持使用“点”表示法检索嵌套值。
1$collection = collect([ 2 [ 3 'name' => 'Laracon', 4 'speakers' => [ 5 'first_day' => ['Rosa', 'Judith'], 6 ], 7 ], 8 [ 9 'name' => 'VueConf',10 'speakers' => [11 'first_day' => ['Abigail', 'Joey'],12 ],13 ],14]);15 16$plucked = $collection->pluck('speakers.first_day');17 18$plucked->all();19 20// [['Rosa', 'Judith'], ['Abigail', 'Joey']]如果存在重复的键，则最后一个匹配的元素将插入到 plucked 集合中。
1$collection = collect([ 2 ['brand' => 'Tesla', 'color' => 'red'], 3 ['brand' => 'Pagani', 'color' => 'white'], 4 ['brand' => 'Tesla', 'color' => 'black'], 5 ['brand' => 'Pagani', 'color' => 'orange'], 6]); 7 8$plucked = $collection->pluck('color', 'brand'); 9 10$plucked->all();11 12// ['Tesla' => 'black', 'Pagani' => 'orange']pop()
pop 方法从集合中移除并返回最后一个项目。
1$collection = collect([1, 2, 3, 4, 5]);2 3$collection->pop();4 5// 56 7$collection->all();8 9// [1, 2, 3, 4]您可以传递一个整数给 pop 方法，以从集合末尾移除并返回多个项目。
1$collection = collect([1, 2, 3, 4, 5]);2 3$collection->pop(3);4 5// collect([5, 4, 3])6 7$collection->all();8 9// [1, 2]prepend()
prepend 方法将一个项目添加到集合的开头。
1$collection = collect([1, 2, 3, 4, 5]);2 3$collection->prepend(0);4 5$collection->all();6 7// [0, 1, 2, 3, 4, 5]您还可以传递第二个参数来指定前置项目的键。
1$collection = collect(['one' => 1, 'two' => 2]);2 3$collection->prepend(0, 'zero');4 5$collection->all();6 7// ['zero' => 0, 'one' => 1, 'two' => 2]pull()
pull 方法通过键从集合中移除并返回一个项目。
1$collection = collect(['product_id' => 'prod-100', 'name' => 'Desk']);2 3$collection->pull('name');4 5// 'Desk'6 7$collection->all();8 9// ['product_id' => 'prod-100']push()
push 方法将一个项目追加到集合的末尾。
1$collection = collect([1, 2, 3, 4]);2 3$collection->push(5);4 5$collection->all();6 7// [1, 2, 3, 4, 5]put()
put 方法在集合中设置给定的键和值。
1$collection = collect(['product_id' => 1, 'name' => 'Desk']);2 3$collection->put('price', 100);4 5$collection->all();6 7// ['product_id' => 1, 'name' => 'Desk', 'price' => 100]random()
random 方法从集合中返回一个随机项目。
1$collection = collect([1, 2, 3, 4, 5]);2 3$collection->random();4 5// 4 - (retrieved randomly)您可以传递一个整数给 random 以指定您想要随机检索多少个项目。当显式传递您希望接收的项目数量时，始终返回一个项目集合。
1$random = $collection->random(3);2 3$random->all();4 5// [2, 4, 5] - (retrieved randomly)如果集合实例的项目少于请求的数量，则 random 方法将抛出 InvalidArgumentException 异常。
random 方法还接受一个闭包，它将接收当前的集合实例。
1use Illuminate\Support\Collection;2 3$random = $collection->random(fn (Collection $items) => min(10, count($items)));4 5$random->all();6 7// [1, 2, 3, 4, 5] - (retrieved randomly)range()
range 方法返回一个包含指定范围之间整数的集合。
1$collection = collect()->range(3, 6);2 3$collection->all();4 5// [3, 4, 5, 6]reduce()
reduce 方法将集合缩减为单个值，并将每次迭代的结果传递到后续迭代中。
1$collection = collect([1, 2, 3]);2 3$total = $collection->reduce(function (?int $carry, int $item) {4 return $carry + $item;5});6 7// 6第一次迭代时 $carry 的值为 null；但是，您可以通过传递第二个参数给 reduce 来指定其初始值。
1$collection->reduce(function (int $carry, int $item) {2 return $carry + $item;3}, 4);4 5// 10reduce 方法还将关联集合中的数组键传递给给定的回调函数。
1$collection = collect([ 2 'usd' => 1400, 3 'gbp' => 1200, 4 'eur' => 1000, 5]); 6 7$ratio = [ 8 'usd' => 1, 9 'gbp' => 1.37,10 'eur' => 1.22,11];12 13$collection->reduce(function (int $carry, int $value, int $key) use ($ratio) {14 return $carry + ($value * $ratio[$key]);15});16 17// 4264reduceSpread()
reduceSpread 方法将集合缩减为一个值数组，并将每次迭代的结果传递到后续迭代中。此方法类似于 reduce 方法；但是，它可以接受多个初始值。
1[$creditsRemaining, $batch] = Image::where('status', 'unprocessed') 2 ->get() 3 ->reduceSpread(function (int $creditsRemaining, Collection $batch, Image $image) { 4 if ($creditsRemaining >= $image->creditsRequired()) { 5 $batch->push($image); 6 7 $creditsRemaining -= $image->creditsRequired(); 8 } 9 10 return [$creditsRemaining, $batch];11 }, $creditsAvailable, collect());reject()
reject 方法使用给定的闭包过滤集合。如果项目应从结果集合中移除，则闭包应返回 true。
1$collection = collect([1, 2, 3, 4]);2 3$filtered = $collection->reject(function (int $value, int $key) {4 return $value > 2;5});6 7$filtered->all();8 9// [1, 2]对于 reject 方法的逆操作，请参阅 filter 方法。
replace()
replace 方法的行为类似于 merge；但是，除了覆盖具有字符串键的匹配项目外，replace 方法还将覆盖集合中具有匹配数字键的项目。
1$collection = collect(['Taylor', 'Abigail', 'James']);2 3$replaced = $collection->replace([1 => 'Victoria', 3 => 'Finn']);4 5$replaced->all();6 7// ['Taylor', 'Victoria', 'James', 'Finn']replaceRecursive()
此方法的工作方式类似于 replace，但它将递归到数组中，并将相同的替换过程应用于内部值。
1$collection = collect([ 2 'Taylor', 3 'Abigail', 4 [ 5 'James', 6 'Victoria', 7 'Finn' 8 ] 9]);10 11$replaced = $collection->replaceRecursive([12 'Charlie',13 2 => [1 => 'King']14]);15 16$replaced->all();17 18// ['Charlie', 'Abigail', ['James', 'King', 'Finn']]reverse()
reverse 方法反转集合中项目的顺序，同时保留原始键。
1$collection = collect(['a', 'b', 'c', 'd', 'e']); 2 3$reversed = $collection->reverse(); 4 5$reversed->all(); 6 7/* 8 [ 9 4 => 'e',10 3 => 'd',11 2 => 'c',12 1 => 'b',13 0 => 'a',14 ]15*/search()
search 方法在集合中搜索给定的值，如果找到则返回其键。如果未找到该项目，则返回 false。
1$collection = collect([2, 4, 6, 8]);2 3$collection->search(4);4 5// 1搜索使用“宽松”比较完成，这意味着具有整数值的字符串将被视为等于相同值的整数。要使用“严格”比较，请将 true 作为第二个参数传递给该方法。
1collect([2, 4, 6, 8])->search('4', strict: true);2 3// false或者，你可以提供你自己的闭包来搜索第一个通过给定真值测试的项目
1collect([2, 4, 6, 8])->search(function (int $item, int $key) {2 return $item > 5;3});4 5// 2select()
select 方法从集合中选择给定的键，类似于 SQL SELECT 语句。
1$users = collect([ 2 ['name' => 'Taylor Otwell', 'role' => 'Developer', 'status' => 'active'], 3 ['name' => 'Victoria Faith', 'role' => 'Researcher', 'status' => 'active'], 4]); 5 6$users->select(['name', 'role']); 7 8/* 9 [10 ['name' => 'Taylor Otwell', 'role' => 'Developer'],11 ['name' => 'Victoria Faith', 'role' => 'Researcher'],12 ],13*/shift()
shift 方法从集合中移除并返回第一个项目。
1$collection = collect([1, 2, 3, 4, 5]);2 3$collection->shift();4 5// 16 7$collection->all();8 9// [2, 3, 4, 5]您可以传递一个整数给 shift 方法，以从集合开头移除并返回多个项目。
1$collection = collect([1, 2, 3, 4, 5]);2 3$collection->shift(3);4 5// collect([1, 2, 3])6 7$collection->all();8 9// [4, 5]shuffle()
shuffle 方法随机打乱集合中的项目。
1$collection = collect([1, 2, 3, 4, 5]);2 3$shuffled = $collection->shuffle();4 5$shuffled->all();6 7// [3, 2, 5, 1, 4] - (generated randomly)skip()
skip 方法返回一个新的集合，其中从集合开头移除了给定数量的元素。
1$collection = collect([1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);2 3$collection = $collection->skip(4);4 5$collection->all();6 7// [5, 6, 7, 8, 9, 10]skipUntil()
skipUntil 方法跳过集合中的项目，只要给定的回调函数返回 false。一旦回调函数返回 true，集合中所有剩余的项目都将作为新集合返回。
1$collection = collect([1, 2, 3, 4]);2 3$subset = $collection->skipUntil(function (int $item) {4 return $item >= 3;5});6 7$subset->all();8 9// [3, 4]您也可以传递一个简单值给 skipUntil 方法，以跳过所有项目，直到找到给定的值。
1$collection = collect([1, 2, 3, 4]);2 3$subset = $collection->skipUntil(3);4 5$subset->all();6 7// [3, 4]如果未找到给定的值或回调函数永不返回 true，则 skipUntil 方法将返回一个空集合。
skipWhile()
skipWhile 方法跳过集合中的项目，只要给定的回调函数返回 true。一旦回调函数返回 false，集合中所有剩余的项目都将作为新集合返回。
1$collection = collect([1, 2, 3, 4]);2 3$subset = $collection->skipWhile(function (int $item) {4 return $item <= 3;5});6 7$subset->all();8 9// [4]如果回调函数永不返回 false，则 skipWhile 方法将返回一个空集合。
slice()
slice 方法返回从给定索引开始的集合切片。
1$collection = collect([1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);2 3$slice = $collection->slice(4);4 5$slice->all();6 7// [5, 6, 7, 8, 9, 10]如果您想限制返回切片的大小，请将所需的尺寸作为第二个参数传递给该方法。
1$slice = $collection->slice(4, 2);2 3$slice->all();4 5// [5, 6]默认情况下，返回的切片将保留键。如果您不希望保留原始键，可以使用 values 方法重新索引它们。
sliding()
sliding 方法返回一个新的块集合，表示集合中项目的“滑动窗口”视图。
1$collection = collect([1, 2, 3, 4, 5]);2 3$chunks = $collection->sliding(2);4 5$chunks->toArray();6 7// [[1, 2], [2, 3], [3, 4], [4, 5]]这与 eachSpread 方法结合使用时尤其有用。
1$transactions->sliding(2)->eachSpread(function (Collection $previous, Collection $current) {2 $current->total = $previous->total + $current->amount;3});您可以选择传递第二个“步长”值，该值确定每个块的第一个项目之间的距离。
1$collection = collect([1, 2, 3, 4, 5]);2 3$chunks = $collection->sliding(3, step: 2);4 5$chunks->toArray();6 7// [[1, 2, 3], [3, 4, 5]]sole()
sole 方法返回集合中第一个通过给定真值测试的元素，但前提是真值测试恰好匹配一个元素。
1collect([1, 2, 3, 4])->sole(function (int $value, int $key) {2 return $value === 2;3});4 5// 2您还可以传递一个键/值对给 sole 方法，这将返回集合中第一个与给定对匹配的元素，但前提是恰好只有一个元素匹配。
1$collection = collect([2 ['product' => 'Desk', 'price' => 200],3 ['product' => 'Chair', 'price' => 100],4]);5 6$collection->sole('product', 'Chair');7 8// ['product' => 'Chair', 'price' => 100]或者，您也可以在不带参数的情况下调用 sole 方法，以获取集合中的第一个元素（如果只有一个元素）。
1$collection = collect([2 ['product' => 'Desk', 'price' => 200],3]);4 5$collection->sole();6 7// ['product' => 'Desk', 'price' => 200]如果集合中没有应由 sole 方法返回的元素，则会抛出 \Illuminate\Collections\ItemNotFoundException 异常。如果应该返回多个元素，则会抛出 \Illuminate\Collections\MultipleItemsFoundException。
some()
contains 方法的别名。
sort()
sort 方法对集合进行排序。排序后的集合保留原始数组键，因此在以下示例中，我们将使用 values 方法将键重置为连续编号的索引。
1$collection = collect([5, 3, 1, 2, 4]);2 3$sorted = $collection->sort();4 5$sorted->values()->all();6 7// [1, 2, 3, 4, 5]如果您的排序需求更高级，您可以将回调函数传递给 sort，其中包含您自己的算法。请参阅关于 uasort 的 PHP 文档，这是集合的 sort 方法在内部使用的函数。
如果您需要对嵌套数组或对象的集合进行排序，请参阅 sortBy 和 sortByDesc 方法。
sortBy()
sortBy 方法按给定的键对集合进行排序。排序后的集合保留原始数组键，因此在以下示例中，我们将使用 values 方法将键重置为连续编号的索引。
1$collection = collect([ 2 ['name' => 'Desk', 'price' => 200], 3 ['name' => 'Chair', 'price' => 100], 4 ['name' => 'Bookcase', 'price' => 150], 5]); 6 7$sorted = $collection->sortBy('price'); 8 9$sorted->values()->all();10 11/*12 [13 ['name' => 'Chair', 'price' => 100],14 ['name' => 'Bookcase', 'price' => 150],15 ['name' => 'Desk', 'price' => 200],16 ]17*/sortBy 方法接受 排序标志 作为其第二个参数。
1$collection = collect([ 2 ['title' => 'Item 1'], 3 ['title' => 'Item 12'], 4 ['title' => 'Item 3'], 5]); 6 7$sorted = $collection->sortBy('title', SORT_NATURAL); 8 9$sorted->values()->all();10 11/*12 [13 ['title' => 'Item 1'],14 ['title' => 'Item 3'],15 ['title' => 'Item 12'],16 ]17*/或者，您可以传递自己的闭包来确定如何对集合的值进行排序。
1$collection = collect([ 2 ['name' => 'Desk', 'colors' => ['Black', 'Mahogany']], 3 ['name' => 'Chair', 'colors' => ['Black']], 4 ['name' => 'Bookcase', 'colors' => ['Red', 'Beige', 'Brown']], 5]); 6 7$sorted = $collection->sortBy(function (array $product, int $key) { 8 return count($product['colors']); 9});10 11$sorted->values()->all();12 13/*14 [15 ['name' => 'Chair', 'colors' => ['Black']],16 ['name' => 'Desk', 'colors' => ['Black', 'Mahogany']],17 ['name' => 'Bookcase', 'colors' => ['Red', 'Beige', 'Brown']],18 ]19*/如果您想按多个属性对集合进行排序，您可以将排序操作数组传递给 sortBy 方法。每个排序操作都应是一个数组，其中包含您希望排序的属性和所需排序的方向。
1$collection = collect([ 2 ['name' => 'Taylor Otwell', 'age' => 34], 3 ['name' => 'Abigail Otwell', 'age' => 30], 4 ['name' => 'Taylor Otwell', 'age' => 36], 5 ['name' => 'Abigail Otwell', 'age' => 32], 6]); 7 8$sorted = $collection->sortBy([ 9 ['name', 'asc'],10 ['age', 'desc'],11]);12 13$sorted->values()->all();14 15/*16 [17 ['name' => 'Abigail Otwell', 'age' => 32],18 ['name' => 'Abigail Otwell', 'age' => 30],19 ['name' => 'Taylor Otwell', 'age' => 36],20 ['name' => 'Taylor Otwell', 'age' => 34],21 ]22*/当按多个属性对集合进行排序时，您还可以提供定义每个排序操作的闭包。
1$collection = collect([ 2 ['name' => 'Taylor Otwell', 'age' => 34], 3 ['name' => 'Abigail Otwell', 'age' => 30], 4 ['name' => 'Taylor Otwell', 'age' => 36], 5 ['name' => 'Abigail Otwell', 'age' => 32], 6]); 7 8$sorted = $collection->sortBy([ 9 fn (array $a, array $b) => $a['name'] <=> $b['name'],10 fn (array $a, array $b) => $b['age'] <=> $a['age'],11]);12 13$sorted->values()->all();14 15/*16 [17 ['name' => 'Abigail Otwell', 'age' => 32],18 ['name' => 'Abigail Otwell', 'age' => 30],19 ['name' => 'Taylor Otwell', 'age' => 36],20 ['name' => 'Taylor Otwell', 'age' => 34],21 ]22*/sortByDesc()
此方法具有与 sortBy 方法相同的签名，但将以相反的顺序对集合进行排序。
sortDesc()
此方法将以与 sort 方法相反的顺序对集合进行排序。
1$collection = collect([5, 3, 1, 2, 4]);2 3$sorted = $collection->sortDesc();4 5$sorted->values()->all();6 7// [5, 4, 3, 2, 1]与 sort 不同，您不能将闭包传递给 sortDesc。相反，您应该使用 sort 方法并反转您的比较。
sortKeys()
sortKeys 方法按底层关联数组的键对集合进行排序。
1$collection = collect([ 2 'id' => 22345, 3 'first' => 'John', 4 'last' => 'Doe', 5]); 6 7$sorted = $collection->sortKeys(); 8 9$sorted->all();10 11/*12 [13 'first' => 'John',14 'id' => 22345,15 'last' => 'Doe',16 ]17*/sortKeysDesc()
此方法具有与 sortKeys 方法相同的签名，但将以相反的顺序对集合进行排序。
sortKeysUsing()
sortKeysUsing 方法使用回调函数按底层关联数组的键对集合进行排序。
1$collection = collect([ 2 'ID' => 22345, 3 'first' => 'John', 4 'last' => 'Doe', 5]); 6 7$sorted = $collection->sortKeysUsing('strnatcasecmp'); 8 9$sorted->all();10 11/*12 [13 'first' => 'John',14 'ID' => 22345,15 'last' => 'Doe',16 ]17*/回调函数必须是一个比较函数，它返回一个小于、等于或大于零的整数。有关更多信息，请参阅关于 uksort 的 PHP 文档，这是 sortKeysUsing 方法在内部使用的 PHP 函数。
splice()
splice 方法移除并返回从指定索引开始的项目切片。
1$collection = collect([1, 2, 3, 4, 5]); 2 3$chunk = $collection->splice(2); 4 5$chunk->all(); 6 7// [3, 4, 5] 8 9$collection->all();10 11// [1, 2]您可以传递第二个参数来限制结果集合的大小。
1$collection = collect([1, 2, 3, 4, 5]); 2 3$chunk = $collection->splice(2, 1); 4 5$chunk->all(); 6 7// [3] 8 9$collection->all();10 11// [1, 2, 4, 5]此外，您可以传递第三个参数，其中包含要替换从集合中移除的项的新项。
1$collection = collect([1, 2, 3, 4, 5]); 2 3$chunk = $collection->splice(2, 1, [10, 11]); 4 5$chunk->all(); 6 7// [3] 8 9$collection->all();10 11// [1, 2, 10, 11, 4, 5]split()
split 方法将集合分成给定的组数。
1$collection = collect([1, 2, 3, 4, 5]);2 3$groups = $collection->split(3);4 5$groups->all();6 7// [[1, 2], [3, 4], [5]]splitIn()
splitIn 方法将集合分成给定的组数，在将剩余部分分配给最后一组之前，先完全填充非终端组。
1$collection = collect([1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);2 3$groups = $collection->splitIn(3);4 5$groups->all();6 7// [[1, 2, 3, 4], [5, 6, 7, 8], [9, 10]]sum()
sum 方法返回集合中所有项目的总和。
1collect([1, 2, 3, 4, 5])->sum();2 3// 15如果集合包含嵌套数组或对象，则应传递一个键，该键将用于确定要汇总的值。
1$collection = collect([2 ['name' => 'JavaScript: The Good Parts', 'pages' => 176],3 ['name' => 'JavaScript: The Definitive Guide', 'pages' => 1096],4]);5 6$collection->sum('pages');7 8// 1272此外，您可以传递自己的闭包来确定要汇总的集合值。
1$collection = collect([ 2 ['name' => 'Chair', 'colors' => ['Black']], 3 ['name' => 'Desk', 'colors' => ['Black', 'Mahogany']], 4 ['name' => 'Bookcase', 'colors' => ['Red', 'Beige', 'Brown']], 5]); 6 7$collection->sum(function (array $product) { 8 return count($product['colors']); 9});10 11// 6take()
take 方法返回一个包含指定数量项目的新集合。
1$collection = collect([0, 1, 2, 3, 4, 5]);2 3$chunk = $collection->take(3);4 5$chunk->all();6 7// [0, 1, 2]您也可以传递一个负整数，以从集合末尾获取指定数量的项目。
1$collection = collect([0, 1, 2, 3, 4, 5]);2 3$chunk = $collection->take(-2);4 5$chunk->all();6 7// [4, 5]takeUntil()
takeUntil 方法返回集合中的项目，直到给定的回调函数返回 true。
1$collection = collect([1, 2, 3, 4]);2 3$subset = $collection->takeUntil(function (int $item) {4 return $item >= 3;5});6 7$subset->all();8 9// [1, 2]您也可以传递一个简单值给 takeUntil 方法，以获取项目，直到找到给定的值。
1$collection = collect([1, 2, 3, 4]);2 3$subset = $collection->takeUntil(3);4 5$subset->all();6 7// [1, 2]如果未找到给定的值或回调函数永不返回 true，则 takeUntil 方法将返回集合中的所有项目。
takeWhile()
takeWhile 方法返回集合中的项目，直到给定的回调函数返回 false。
1$collection = collect([1, 2, 3, 4]);2 3$subset = $collection->takeWhile(function (int $item) {4 return $item < 3;5});6 7$subset->all();8 9// [1, 2]如果回调函数永不返回 false，则 takeWhile 方法将返回集合中的所有项目。
tap()
tap 方法将集合传递给给定的回调函数，使您可以在特定点“tap”到集合中，并对项目执行某些操作，而不会影响集合本身。然后，tap 方法返回该集合。
1collect([2, 4, 3, 1, 5])2 ->sort()3 ->tap(function (Collection $collection) {4 Log::debug('Values after sorting', $collection->values()->all());5 })6 ->shift();7 8// 1times()
静态 times 方法通过调用给定闭包指定的次数来创建新的集合。
1$collection = Collection::times(10, function (int $number) {2 return $number * 9;3});4 5$collection->all();6 7// [9, 18, 27, 36, 45, 54, 63, 72, 81, 90]toArray()
toArray 方法将集合转换为纯 PHP array。如果集合的值是 Eloquent 模型，则模型也将转换为数组。
1$collection = collect(['name' => 'Desk', 'price' => 200]);2 3$collection->toArray();4 5/*6 [7 ['name' => 'Desk', 'price' => 200],8 ]9*/
toArray 还会将集合的所有嵌套对象（它们是 Arrayable 的实例）转换为数组。如果您想获取集合底层的原始数组，请改用 all 方法。
toJson()
toJson 方法将集合转换为 JSON 序列化字符串。
1$collection = collect(['name' => 'Desk', 'price' => 200]);2 3$collection->toJson();4 5// '{"name":"Desk", "price":200}'transform()
transform 方法迭代集合，并使用集合中的每个项目调用给定的回调函数。集合中的项目将被回调函数返回的值替换。
1$collection = collect([1, 2, 3, 4, 5]);2 3$collection->transform(function (int $item, int $key) {4 return $item * 2;5});6 7$collection->all();8 9// [2, 4, 6, 8, 10]与大多数其他集合方法不同，transform 会修改集合本身。如果您希望创建新的集合，请使用 map 方法。
undot()
undot 方法将使用“点”表示法的单维集合扩展为多维集合。
1$person = collect([ 2 'name.first_name' => 'Marie', 3 'name.last_name' => 'Valentine', 4 'address.line_1' => '2992 Eagle Drive', 5 'address.line_2' => '', 6 'address.suburb' => 'Detroit', 7 'address.state' => 'MI', 8 'address.postcode' => '48219' 9]);10 11$person = $person->undot();12 13$person->toArray();14 15/*16 [17 "name" => [18 "first_name" => "Marie",19 "last_name" => "Valentine",20 ],21 "address" => [22 "line_1" => "2992 Eagle Drive",23 "line_2" => "",24 "suburb" => "Detroit",25 "state" => "MI",26 "postcode" => "48219",27 ],28 ]29*/union()
union 方法将给定的数组添加到集合中。如果给定的数组包含已在原始集合中的键，则原始集合的值将被优先使用。
1$collection = collect([1 => ['a'], 2 => ['b']]);2 3$union = $collection->union([3 => ['c'], 1 => ['d']]);4 5$union->all();6 7// [1 => ['a'], 2 => ['b'], 3 => ['c']]unique()
unique 方法返回集合中所有唯一的项目。返回的集合保留原始数组键，因此在以下示例中，我们将使用 values 方法将键重置为连续编号的索引。
1$collection = collect([1, 1, 2, 2, 3, 4, 2]);2 3$unique = $collection->unique();4 5$unique->values()->all();6 7// [1, 2, 3, 4]当处理嵌套数组或对象时，您可以指定用于确定唯一性的键。
1$collection = collect([ 2 ['name' => 'iPhone 6', 'brand' => 'Apple', 'type' => 'phone'], 3 ['name' => 'iPhone 5', 'brand' => 'Apple', 'type' => 'phone'], 4 ['name' => 'Apple Watch', 'brand' => 'Apple', 'type' => 'watch'], 5 ['name' => 'Galaxy S6', 'brand' => 'Samsung', 'type' => 'phone'], 6 ['name' => 'Galaxy Gear', 'brand' => 'Samsung', 'type' => 'watch'], 7]); 8 9$unique = $collection->unique('brand');10 11$unique->values()->all();12 13/*14 [15 ['name' => 'iPhone 6', 'brand' => 'Apple', 'type' => 'phone'],16 ['name' => 'Galaxy S6', 'brand' => 'Samsung', 'type' => 'phone'],17 ]18*/最后，您还可以将自己的闭包传递给 unique 方法，以指定哪个值应确定项目的唯一性。
1$unique = $collection->unique(function (array $item) { 2 return $item['brand'].$item['type']; 3}); 4 5$unique->values()->all(); 6 7/* 8 [ 9 ['name' => 'iPhone 6', 'brand' => 'Apple', 'type' => 'phone'],10 ['name' => 'Apple Watch', 'brand' => 'Apple', 'type' => 'watch'],11 ['name' => 'Galaxy S6', 'brand' => 'Samsung', 'type' => 'phone'],12 ['name' => 'Galaxy Gear', 'brand' => 'Samsung', 'type' => 'watch'],13 ]14*/当检查项目值时，unique 方法使用“宽松”比较，这意味着具有整数值的字符串将被视为等于相同值的整数。使用 uniqueStrict 方法使用“严格”比较进行过滤。
当使用 Eloquent 集合 时，此方法的行为会发生修改。
uniqueStrict()
此方法具有与 unique 方法相同的签名；但是，所有值都使用“严格”比较进行比较。
unless()
unless 方法将执行给定的回调函数，除非传递给该方法的第一个参数的计算结果为 true。
1$collection = collect([1, 2, 3]); 2 3$collection->unless(true, function (Collection $collection) { 4 return $collection->push(4); 5}); 6 7$collection->unless(false, function (Collection $collection) { 8 return $collection->push(5); 9});10 11$collection->all();12 13// [1, 2, 3, 5]可以将第二个回调函数传递给 unless 方法。当传递给 unless 方法的第一个参数的计算结果为 true 时，将执行第二个回调函数。
1$collection = collect([1, 2, 3]); 2 3$collection->unless(true, function (Collection $collection) { 4 return $collection->push(4); 5}, function (Collection $collection) { 6 return $collection->push(5); 7}); 8 9$collection->all();10 11// [1, 2, 3, 5]对于 unless 的逆操作，请参阅 when 方法。
unlessEmpty()
whenNotEmpty 方法的别名。
unlessNotEmpty()
whenEmpty 方法的别名。
unwrap()
静态 unwrap 方法从给定的值返回集合的底层项目（如果适用）。
1Collection::unwrap(collect('John Doe')); 2 3// ['John Doe'] 4 5Collection::unwrap(['John Doe']); 6 7// ['John Doe'] 8 9Collection::unwrap('John Doe');10 11// 'John Doe'value()
value 方法从集合的第一个元素中检索给定的值。
1$collection = collect([2 ['product' => 'Desk', 'price' => 200],3 ['product' => 'Speaker', 'price' => 400],4]);5 6$value = $collection->value('price');7 8// 200values()
values 方法返回一个新的集合，其中键已重置为连续整数。
1$collection = collect([ 2 10 => ['product' => 'Desk', 'price' => 200], 3 11 => ['product' => 'Desk', 'price' => 200], 4]); 5 6$values = $collection->values(); 7 8$values->all(); 9 10/*11 [12 0 => ['product' => 'Desk', 'price' => 200],13 1 => ['product' => 'Desk', 'price' => 200],14 ]15*/when()
当传递给该方法的第一个参数的计算结果为 true 时，when 方法将执行给定的回调函数。集合实例和传递给 when 方法的第一个参数将提供给闭包。
1$collection = collect([1, 2, 3]); 2 3$collection->when(true, function (Collection $collection, int $value) { 4 return $collection->push(4); 5}); 6 7$collection->when(false, function (Collection $collection, int $value) { 8 return $collection->push(5); 9});10 11$collection->all();12 13// [1, 2, 3, 4]可以将第二个回调函数传递给 when 方法。当传递给 when 方法的第一个参数的计算结果为 false 时，将执行第二个回调函数。
1$collection = collect([1, 2, 3]); 2 3$collection->when(false, function (Collection $collection, int $value) { 4 return $collection->push(4); 5}, function (Collection $collection) { 6 return $collection->push(5); 7}); 8 9$collection->all();10 11// [1, 2, 3, 5]对于 when 的逆操作，请参阅 unless 方法。
whenEmpty()
当集合为空时，whenEmpty 方法将执行给定的回调函数。
1$collection = collect(['Michael', 'Tom']); 2 3$collection->whenEmpty(function (Collection $collection) { 4 return $collection->push('Adam'); 5}); 6 7$collection->all(); 8 9// ['Michael', 'Tom']10 11$collection = collect();12 13$collection->whenEmpty(function (Collection $collection) {14 return $collection->push('Adam');15});16 17$collection->all();18 19// ['Adam']可以将第二个闭包传递给 whenEmpty 方法，该闭包将在集合不为空时执行。
1$collection = collect(['Michael', 'Tom']); 2 3$collection->whenEmpty(function (Collection $collection) { 4 return $collection->push('Adam'); 5}, function (Collection $collection) { 6 return $collection->push('Taylor'); 7}); 8 9$collection->all();10 11// ['Michael', 'Tom', 'Taylor']对于 whenEmpty 的逆操作，请参阅 whenNotEmpty 方法。
whenNotEmpty()
当集合不为空时，whenNotEmpty 方法将执行给定的回调函数。
1$collection = collect(['michael', 'tom']); 2 3$collection->whenNotEmpty(function (Collection $collection) { 4 return $collection->push('adam'); 5}); 6 7$collection->all(); 8 9// ['michael', 'tom', 'adam']10 11$collection = collect();12 13$collection->whenNotEmpty(function (Collection $collection) {14 return $collection->push('adam');15});16 17$collection->all();18 19// []可以将第二个闭包传递给 whenNotEmpty 方法，该闭包将在集合为空时执行。
1$collection = collect(); 2 3$collection->whenNotEmpty(function (Collection $collection) { 4 return $collection->push('adam'); 5}, function (Collection $collection) { 6 return $collection->push('taylor'); 7}); 8 9$collection->all();10 11// ['taylor']对于 whenNotEmpty 的逆操作，请参阅 whenEmpty 方法。
where()
where 方法按给定的键/值对过滤集合。
1$collection = collect([ 2 ['product' => 'Desk', 'price' => 200], 3 ['product' => 'Chair', 'price' => 100], 4 ['product' => 'Bookcase', 'price' => 150], 5 ['product' => 'Door', 'price' => 100], 6]); 7 8$filtered = $collection->where('price', 100); 9 10$filtered->all();11 12/*13 [14 ['product' => 'Chair', 'price' => 100],15 ['product' => 'Door', 'price' => 100],16 ]17*/当检查项目值时，where 方法使用“宽松”比较，这意味着具有整数值的字符串将被视为等于相同值的整数。使用 whereStrict 方法使用“严格”比较进行过滤。
您可以选择传递一个比较运算符作为第二个参数。支持的运算符包括：'===', '!==', '!=', '==', '=', '<>', '>', '<', '>=', 和 '<='
1$collection = collect([ 2 ['name' => 'Jim', 'deleted_at' => '2019-01-01 00:00:00'], 3 ['name' => 'Sally', 'deleted_at' => '2019-01-02 00:00:00'], 4 ['name' => 'Sue', 'deleted_at' => null], 5]); 6 7$filtered = $collection->where('deleted_at', '!=', null); 8 9$filtered->all();10 11/*12 [13 ['name' => 'Jim', 'deleted_at' => '2019-01-01 00:00:00'],14 ['name' => 'Sally', 'deleted_at' => '2019-01-02 00:00:00'],15 ]16*/whereStrict()
此方法具有与 where 方法相同的签名；但是，所有值都使用“严格”比较进行比较。
whereBetween()
whereBetween 方法通过确定指定的项目值是否在给定的范围内来过滤集合。
1$collection = collect([ 2 ['product' => 'Desk', 'price' => 200], 3 ['product' => 'Chair', 'price' => 80], 4 ['product' => 'Bookcase', 'price' => 150], 5 ['product' => 'Pencil', 'price' => 30], 6 ['product' => 'Door', 'price' => 100], 7]); 8 9$filtered = $collection->whereBetween('price', [100, 200]);10 11$filtered->all();12 13/*14 [15 ['product' => 'Desk', 'price' => 200],16 ['product' => 'Bookcase', 'price' => 150],17 ['product' => 'Door', 'price' => 100],18 ]19*/whereIn()
whereIn 方法从集合中移除不具有指定项目值的元素，该项目值未包含在给定的数组中。
1$collection = collect([ 2 ['product' => 'Desk', 'price' => 200], 3 ['product' => 'Chair', 'price' => 100], 4 ['product' => 'Bookcase', 'price' => 150], 5 ['product' => 'Door', 'price' => 100], 6]); 7 8$filtered = $collection->whereIn('price', [150, 200]); 9 10$filtered->all();11 12/*13 [14 ['product' => 'Desk', 'price' => 200],15 ['product' => 'Bookcase', 'price' => 150],16 ]17*/当检查项目值时，whereIn 方法使用“宽松”比较，这意味着具有整数值的字符串将被视为等于相同值的整数。使用 whereInStrict 方法使用“严格”比较进行过滤。
whereInStrict()
此方法具有与 whereIn 方法相同的签名；但是，所有值都使用“严格”比较进行比较。
whereInstanceOf()
whereInstanceOf 方法按给定的类类型过滤集合。
1use App\Models\User; 2use App\Models\Post; 3 4$collection = collect([ 5 new User, 6 new User, 7 new Post, 8]); 9 10$filtered = $collection->whereInstanceOf(User::class);11 12$filtered->all();13 14// [App\Models\User, App\Models\User]whereNotBetween()
whereNotBetween 方法通过确定指定的项目值是否在给定的范围之外来过滤集合。
1$collection = collect([ 2 ['product' => 'Desk', 'price' => 200], 3 ['product' => 'Chair', 'price' => 80], 4 ['product' => 'Bookcase', 'price' => 150], 5 ['product' => 'Pencil', 'price' => 30], 6 ['product' => 'Door', 'price' => 100], 7]); 8 9$filtered = $collection->whereNotBetween('price', [100, 200]);10 11$filtered->all();12 13/*14 [15 ['product' => 'Chair', 'price' => 80],16 ['product' => 'Pencil', 'price' => 30],17 ]18*/whereNotIn()
whereNotIn 方法从集合中移除具有指定项目值的元素，该项目值包含在给定的数组中。
1$collection = collect([ 2 ['product' => 'Desk', 'price' => 200], 3 ['product' => 'Chair', 'price' => 100], 4 ['product' => 'Bookcase', 'price' => 150], 5 ['product' => 'Door', 'price' => 100], 6]); 7 8$filtered = $collection->whereNotIn('price', [150, 200]); 9 10$filtered->all();11 12/*13 [14 ['product' => 'Chair', 'price' => 100],15 ['product' => 'Door', 'price' => 100],16 ]17*/当检查项目值时，whereNotIn 方法使用“宽松”比较，这意味着具有整数值的字符串将被视为等于相同值的整数。使用 whereNotInStrict 方法使用“严格”比较进行过滤。
whereNotInStrict()
此方法具有与 whereNotIn 方法相同的签名；但是，所有值都使用“严格”比较进行比较。
whereNotNull()
whereNotNull 方法从集合中返回给定键不为 null 的项目。
1$collection = collect([ 2 ['name' => 'Desk'], 3 ['name' => null], 4 ['name' => 'Bookcase'], 5]); 6 7$filtered = $collection->whereNotNull('name'); 8 9$filtered->all();10 11/*12 [13 ['name' => 'Desk'],14 ['name' => 'Bookcase'],15 ]16*/whereNull()
whereNull 方法从集合中返回给定键为 null 的项目。
1$collection = collect([ 2 ['name' => 'Desk'], 3 ['name' => null], 4 ['name' => 'Bookcase'], 5]); 6 7$filtered = $collection->whereNull('name'); 8 9$filtered->all();10 11/*12 [13 ['name' => null],14 ]15*/wrap()
静态 wrap 方法在适用时将给定的值包装在集合中。
1use Illuminate\Support\Collection; 2 3$collection = Collection::wrap('John Doe'); 4 5$collection->all(); 6 7// ['John Doe'] 8 9$collection = Collection::wrap(['John Doe']);10 11$collection->all();12 13// ['John Doe']14 15$collection = Collection::wrap(collect('John Doe'));16 17$collection->all();18 19// ['John Doe']zip()
zip 方法将给定数组的值与其对应索引处的原始集合的值合并在一起。
1$collection = collect(['Chair', 'Desk']);2 3$zipped = $collection->zip([100, 200]);4 5$zipped->all();6 7// [['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 高阶消息来调用集合中每个对象的方法。
1use App\Models\User;2 3$users = User::where('votes', '>', 500)->get();4 5$users->each->markAsVip();同样，我们可以使用 sum 高阶消息来收集用户集合的“votes”总数。
1$users = User::where('group', 'Development')->get();2 3return $users->sum->votes;惰性集合
简介
在进一步了解 Laravel 的惰性集合之前，请花一些时间熟悉 PHP 生成器。
为了补充已经强大的 Collection 类，LazyCollection 类利用 PHP 的 生成器，使您能够处理非常大的数据集，同时保持低内存使用率。
例如，假设您的应用程序需要处理一个多 GB 的日志文件，同时利用 Laravel 的集合方法来解析日志。惰性集合可以用来仅在给定时间将文件的一小部分保存在内存中，而不是一次将整个文件读入内存。
1use App\Models\LogEntry; 2use Illuminate\Support\LazyCollection; 3 4LazyCollection::make(function () { 5 $handle = fopen('log.txt', 'r'); 6 7 while (($line = fgets($handle)) !== false) { 8 yield $line; 9 }10})->chunk(4)->map(function (array $lines) {11 return LogEntry::fromLines($lines);12})->each(function (LogEntry $logEntry) {13 // Process the log entry...14});或者，假设您需要迭代 10,000 个 Eloquent 模型。当使用传统的 Laravel 集合时，所有 10,000 个 Eloquent 模型都必须同时加载到内存中。
1use App\Models\User;2 3$users = User::all()->filter(function (User $user) {4 return $user->id > 500;5});但是，查询构建器的 cursor 方法返回一个 LazyCollection 实例。这使您仍然只能对数据库运行单个查询，而且一次只将一个 Eloquent 模型加载到内存中。在此示例中，filter 回调函数直到我们实际迭代每个用户时才执行，从而大大减少了内存使用量。
1use App\Models\User;2 3$users = User::cursor()->filter(function (User $user) {4 return $user->id > 500;5});6 7foreach ($users as $user) {8 echo $user->id;9}创建惰性集合
要创建惰性集合实例，您应该将 PHP 生成器函数传递给集合的 make 方法。
1use Illuminate\Support\LazyCollection;2 3LazyCollection::make(function () {4 $handle = fopen('log.txt', 'r');5 6 while (($line = fgets($handle)) !== false) {7 yield $line;8 }9});Enumerable 契约
几乎所有在 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 方法返回一个新的惰性集合，该集合将枚举值直到指定的时间。在该时间之后，集合将停止枚举
1$lazyCollection = LazyCollection::times(INF) 2 ->takeUntilTimeout(now()->addMinute()); 3 4$lazyCollection->each(function (int $number) { 5 dump($number); 6 7 sleep(1); 8}); 9 10// 111// 212// ...13// 5814// 59为了说明此方法的使用，假设一个应用程序使用游标从数据库提交发票。您可以定义一个计划任务，该任务每 15 分钟运行一次，并且最多只处理 14 分钟的发票
1use App\Models\Invoice;2use Illuminate\Support\Carbon;3 4Invoice::pending()->cursor()5 ->takeUntilTimeout(6 Carbon::createFromTimestamp(LARAVEL_START)->add(14, 'minutes')7 )8 ->each(fn (Invoice $invoice) => $invoice->submit());tapEach()
虽然 each 方法会立即为集合中的每个项目调用给定的回调，但 tapEach 方法仅在逐个从列表中拉取项目时才调用给定的回调
1// Nothing has been dumped so far... 2$lazyCollection = LazyCollection::times(INF)->tapEach(function (int $value) { 3 dump($value); 4}); 5 6// Three items are dumped... 7$array = $lazyCollection->take(3)->all(); 8 9// 110// 211// 3throttle()
throttle 方法将限制惰性集合，以便在指定的秒数后返回每个值。此方法对于您可能与限制传入请求速率的外部 API 交互的情况尤其有用
1use App\Models\User;2 3User::where('vip', true)4 ->cursor()5 ->throttle(seconds: 1)6 ->each(function (User $user) {7 // Call external API...8 });remember()
remember 方法返回一个新的惰性集合，该集合将记住任何已被枚举的值，并且在后续集合枚举中不会再次检索它们
1// No query has been executed yet... 2$users = User::cursor()->remember(); 3 4// The query is executed... 5// The first 5 users are hydrated from the database... 6$users->take(5)->all(); 7 8// First 5 users come from the collection's cache... 9// The rest are hydrated from the database...10$users->take(20)->all();