无子级迭代器类

构造函数。您可以提供数组或任何可遍历对象

参数

抛出

返回一个数组，可用于描述此对象的内部状态。

返回值

返回一个数组，用于序列化此对象。

返回值

重建 Collection 实例。

参数

返回值

返回一个可调用函数，该函数接收一个值并返回该值是否满足特定条件。

参数

返回值

从 $data 中返回一个列，可以通过迭代 $path 中包含的列名来提取该列。它将为用 {*} 表示的元素返回数组

参数

返回值

返回一个可调用函数，可用于根据点分隔的路径从数组或对象中提取属性或列。

参数

返回值

从 $data 中返回一个列，可以通过迭代 $path 中包含的列名来提取该列

参数

返回值

返回一个新集合，它是将此集合中的元素列表与传递的元素列表连接的结果

参数

返回值

附加一个单一项目，创建一个新的集合。

参数

返回值

返回使用 $path 提取的所有值的平均值或此集合的平均值。

示例

$items = [
 ['invoice' => ['total' => 100]],
 ['invoice' => ['total' => 200]]
];

$total = (new Collection($items))->avg('invoice.total');

// Total: 150

$total = (new Collection([1, 2, 3]))->avg();
// Total: 2

空集或 0 行的平均值为 null。包含 null 值的集合不被视为为空。

参数

返回值

返回一个新的集合，其中包含此集合执行的操作。无论新的集合迭代多少次，这些操作都只会执行一次。

这也可以用于使任何不可回绕的迭代器可回绕。

返回值

创建一个新的集合，它是当前集合的笛卡尔积

为了创建笛卡尔积，集合必须包含一个维度的数据。

示例

$collection = new Collection([['A', 'B', 'C'], [1, 2, 3]]);
$result = $collection->cartesianProduct()->toArray();
$expected = [
    ['A', 1],
    ['A', 2],
    ['A', 3],
    ['B', 1],
    ['B', 2],
    ['B', 3],
    ['C', 1],
    ['C', 2],
    ['C', 3],
];

参数

返回值

抛出

将集合分成更小的数组，每个数组的大小为给定大小。

示例

$items [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11];
$chunked = (new Collection($items))->chunk(3)->toList();
// Returns [[1, 2, 3], [4, 5, 6], [7, 8, 9], [10, 11]]

参数

返回值

将集合分成更小的数组，每个数组的大小为给定大小。

示例

$items ['a' => 1, 'b' => 2, 'c' => 3, 'd' => 4, 'e' => 5, 'f' => 6];
$chunked = (new Collection($items))->chunkWithKeys(3)->toList();
// Returns [['a' => 1, 'b' => 2, 'c' => 3], ['d' => 4, 'e' => 5, 'f' => 6]]

参数

返回值

返回一个新的集合，其中包含基于值路径提取的值，然后按键路径索引。可选地，此方法可以根据分组属性路径生成父分组。

示例

$items = [
 ['id' => 1, 'name' => 'foo', 'parent' => 'a'],
 ['id' => 2, 'name' => 'bar', 'parent' => 'b'],
 ['id' => 3, 'name' => 'baz', 'parent' => 'a'],
];

$combined = (new Collection($items))->combine('id', 'name');

// Result will look like this when converted to array
[
 1 => 'foo',
 2 => 'bar',
 3 => 'baz',
];

$combined = (new Collection($items))->combine('id', 'name', 'parent');

// Result will look like this when converted to array
[
 'a' => [1 => 'foo', 3 => 'baz'],
 'b' => [2 => 'bar'],
];

参数

返回值

遍历此集合中的所有元素一次，并对它们执行所有堆叠操作，最后返回一个包含结果的新集合。这对于将不可回绕的内部迭代器转换为可以回绕并多次使用的集合非常有用。

一个常见的用例是为计算不同的数据而重用同一个变量。在这些情况下，首先编译一个集合，然后对其应用更多操作可能会有帮助，并且效率更高。

示例

$collection->map($mapper)->sortBy('age')->extract('name');
$compiled = $collection->compile();
$isJohnHere = $compiled->some($johnMatcher);
$allButJohn = $compiled->filter($johnMatcher);

在上面的示例中，如果在获取 $isJohnHere 和 $allButJohn 之前未编译集合，则 map、sortBy 和 extract 的迭代将执行两次：一次用于获取 $isJohnHere，一次用于获取 $allButJohn

您可以将此方法视为在集合中创建复杂计算的保存点的方法。

参数

返回值

如果 $value 出现在此集合中，则返回 true。比较是通过值和类型进行的。

参数

返回值

返回集合中的元素数量。

警告

将更改迭代器的当前位置

在您迭代这些集合的同时调用此方法（例如在 foreach 中）会导致未定义的行为。避免这样做。

消耗所有 NoRewindIterator 集合的元素

对于某些类型的集合，调用此方法可能会导致其在之后无法使用。也就是说，你可能无法再从它获取元素或遍历它。

具体来说，任何包装了 Generator（包含 yield 语句的函数）或未缓冲数据库游标的集合，在调用 `count()` 后将不再接受任何其他函数调用。

使用 `buffered()` 方法创建新的集合以解决此问题。

可能报告的元素数量多于唯一键的数量

任何通过将集合追加在一起或通过内部迭代器返回重复键而构造的集合，在使用此函数报告的元素数量会比将集合转换为键值数组后的最终元素数量多。这是因为重复的键最终会在数组中合并为一个，而此计数方法只关心将其转换为纯列表后的元素数量。

如果你需要在考虑键的情况下（唯一键的计数）的元素计数，你可以调用 `countKeys()`

返回值

将列表按组排序并返回每个组中元素数量的计数。类似于 groupBy，但不是返回值列表，而是返回该组中值的计数。

当 `$callback` 是一个字符串时，它应该是一个要提取的属性名称，或者是一个用于获取路径中最后一个属性的点分隔路径。

示例

$items = [
 ['id' => 1, 'name' => 'foo', 'parent_id' => 10],
 ['id' => 2, 'name' => 'bar', 'parent_id' => 11],
 ['id' => 3, 'name' => 'baz', 'parent_id' => 10],
];

$group = (new Collection($items))->countBy('parent_id');

// Or
$group = (new Collection($items))->countBy(function ($e) {
 return $e['parent_id'];
});

// Result will look like this when converted to array
[
 10 => 2,
 11 => 1
];

参数

返回值

返回此迭代器中唯一键的数量。这与调用 toArray() 后集合将包含的元素数量相同

此方法有一些注意事项。请参考 `CollectionInterface::count()` 获取详细信息。

返回值

将回调应用于此集合中的元素。

示例

$collection = (new Collection($items))->each(function ($value, $key) {
 echo "Element $key: $value";
});

参数

返回值

如果此集合中的所有值都通过回调提供的真值测试，则返回 true。

回调函数会传入正在测试的元素的值和键，如果测试通过，则应该返回 true。

示例

$overTwentyOne = (new Collection([24, 45, 60, 15]))->every(function ($value, $key) {
 return $value > 21;
});

空集合始终返回 true。

参数

返回值

返回一个新的集合，其中包含在每个元素中找到的列或属性值。

匹配器可以是一个包含要提取的属性名称的字符串，或者是一个用于获取路径中最后一个属性的点分隔路径。

如果在集合中找不到特定元素的列或属性，则该位置将填充为 null。

示例

提取数组中所有评论的用户名

$items = [
 ['comment' => ['body' => 'cool', 'user' => ['name' => 'Mark']],
 ['comment' => ['body' => 'very cool', 'user' => ['name' => 'Renan']]
];
$extracted = (new Collection($items))->extract('comment.user.name');

// Result will look like this when converted to array
['Mark', 'Renan']

也可以从嵌套属性中提取扁平化的集合

 $items = [
     ['comment' => ['votes' => [['value' => 1], ['value' => 2], ['value' => 3]]],
     ['comment' => ['votes' => [['value' => 4]]
];
$extracted = (new Collection($items))->extract('comment.votes.{*}.value');

// Result will contain
[1, 2, 3, 4]

参数

返回值

遍历集合中的每个值，并返回另一个集合，其中包含所有通过真值测试的值。只有回调返回 true 的值才会出现在结果集合中。

每次执行回调函数时，它都会按顺序接收当前迭代中元素的值、元素的键以及此集合作为参数。

示例

过滤数组中的奇数，最终只保留值 2 在结果集合中

$collection = (new Collection([1, 2, 3]))->filter(function ($value, $key) {
 return $value % 2 === 0;
});

参数

返回值

返回此集合中的第一个结果

返回值

返回与条件中列出的所有键值对匹配的第一个结果。

参数

返回值

返回一个不包含任何元素的自实例。

返回值

将集合分成集合，按将每个值通过回调运行的结果分组。如果 $callback 是字符串而不是可调用对象，则按每个值上由 $callback 命名的属性分组。

当 `$callback` 是一个字符串时，它应该是一个要提取的属性名称，或者是一个用于获取路径中最后一个属性的点分隔路径。

示例

$items = [
 ['id' => 1, 'name' => 'foo', 'parent_id' => 10],
 ['id' => 2, 'name' => 'bar', 'parent_id' => 11],
 ['id' => 3, 'name' => 'baz', 'parent_id' => 10],
];

$group = (new Collection($items))->groupBy('parent_id');

// Or
$group = (new Collection($items))->groupBy(function ($e) {
 return $e['parent_id'];
});

// Result will look like this when converted to array
[
 10 => [
     ['id' => 1, 'name' => 'foo', 'parent_id' => 10],
     ['id' => 3, 'name' => 'baz', 'parent_id' => 10],
 ],
 11 => [
     ['id' => 2, 'name' => 'bar', 'parent_id' => 11],
 ]
];

参数

返回值

返回 false，因为此集合中没有子级迭代器

返回值

给定一个列表和一个回调函数，该函数为列表中的每个元素返回一个键（或属性名称），返回一个包含每个项目索引的对象。就像 groupBy 一样，但适用于您知道键是唯一的时。

当 `$callback` 是一个字符串时，它应该是一个要提取的属性名称，或者是一个用于获取路径中最后一个属性的点分隔路径。

示例

$items = [
 ['id' => 1, 'name' => 'foo'],
 ['id' => 2, 'name' => 'bar'],
 ['id' => 3, 'name' => 'baz'],
];

$indexed = (new Collection($items))->indexBy('id');

// Or
$indexed = (new Collection($items))->indexBy(function ($e) {
 return $e['id'];
});

// Result will look like this when converted to array
[
 1 => ['id' => 1, 'name' => 'foo'],
 3 => ['id' => 3, 'name' => 'baz'],
 2 => ['id' => 2, 'name' => 'bar'],
];

参数

返回值

返回一个新的集合，其中包含在 $values 中找到的每个元素作为此集合中相应元素的属性。插入值的属性由 $path 参数描述。

`$path` 可以是一个包含属性名称的字符串，或者是一个用于获取路径中最后一个属性的点分隔路径。

如果在集合中找不到特定元素的列或属性（作为路径的一部分），则该元素将保持不变。

示例

将年龄插入包含用户的集合中

$items = [
 ['comment' => ['body' => 'cool', 'user' => ['name' => 'Mark']],
 ['comment' => ['body' => 'awesome', 'user' => ['name' => 'Renan']]
];
$ages = [25, 28];
$inserted = (new Collection($items))->insert('comment.user.age', $ages);

// Result will look like this when converted to array
[
 ['comment' => ['body' => 'cool', 'user' => ['name' => 'Mark', 'age' => 25]],
 ['comment' => ['body' => 'awesome', 'user' => ['name' => 'Renan', 'age' => 28]]
];

参数

返回值

返回此集合中是否存在元素

示例

$items [1, 2, 3];
(new Collection($items))->isEmpty(); // false

(new Collection([]))->isEmpty(); // true

返回值

返回可以转换为 JSON 的数据。这与 toArray() 返回相同的数据，其中只包含唯一键。

JsonSerializable 接口的一部分。

返回值

返回此集合中的最后一个结果

返回值

返回一个新的集合，其中在它之后链接的任何操作都保证以延迟方式运行。也就是说，元素将一次产生一个。

延迟集合只能遍历一次。第二次尝试会导致错误。

返回值

返回一个新的集合，其中包含此集合中的每个元素，在展平树结构之后。树结构是通过将元素嵌套在具有已知名称的键下定义的。可以使用 '$nestingKey' 参数指定此名称。

默认情况下，将返回树中遵循深度优先搜索的所有元素，即从每个分支的顶层父节点到叶子节点的元素。

通过将 `$dir` 参数设置为 `asc`，可以返回从底部到顶部的所有元素。也就是说，它将首先返回同一树深度的所有元素，然后从底部到顶部。

最后，你可以指定只获取树结构中叶子节点的集合。你可以通过在第一个参数中传递 `leaves` 来实现。

第一个参数的可能值是以下常量的别名，你可以传递这些常量而不是别名

• desc: RecursiveIteratorIterator::SELF_FIRST
• asc: RecursiveIteratorIterator::CHILD_FIRST
• leaves: RecursiveIteratorIterator::LEAVES_ONLY

示例

$collection = new Collection([
 ['id' => 1, 'children' => [['id' => 2, 'children' => [['id' => 3]]]]],
 ['id' => 4, 'children' => [['id' => 5]]]
]);
$flattenedIds = $collection->listNested()->extract('id'); // Yields [1, 2, 3, 4, 5]

参数

返回值

在使用提供的可调用对象修改此集合中的每个值后，返回另一个集合。

每次执行回调函数时，它都会按顺序接收当前迭代中元素的值、元素的键以及此集合作为参数。

示例

获取一个布尔值集合，其中 true 表示一个人是女性

$collection = (new Collection($people))->map(function ($person, $key) {
 return $person->gender === 'female';
});

参数

返回值

遍历列表中的每个值，返回一个包含所有包含 $conditions 中列出的所有键值对的值的集合。

示例

$items = [
 ['comment' => ['body' => 'cool', 'user' => ['name' => 'Mark']],
 ['comment' => ['body' => 'very cool', 'user' => ['name' => 'Renan']],
];

$extracted = (new Collection($items))->match(['user.name' => 'Renan']);

// Result will look like this when converted to array
[
 ['comment' => ['body' => 'very cool', 'user' => ['name' => 'Renan']]]
]

参数

返回值

返回此集合中按属性排序后的最高元素。有关回调和 $sort 参数的信息，请查看 sortBy 方法

示例

// For a collection of employees
$max = $collection->max('age');
$max = $collection->max('user.salary');
$max = $collection->max(function ($e) {
 return $e->get('user')->get('salary');
});

// Display employee name
echo $max->name;

参数

返回值

返回使用 $path 提取的所有值的中间值或此集合的中间值。

示例

$items = [
 ['invoice' => ['total' => 400]],
 ['invoice' => ['total' => 500]]
 ['invoice' => ['total' => 100]]
 ['invoice' => ['total' => 333]]
 ['invoice' => ['total' => 200]]
];

$total = (new Collection($items))->median('invoice.total');

// Total: 333

$total = (new Collection([1, 2, 3, 4]))->median();
// Total: 2.5

空集合或 0 行的中位数为 `null`。包含 `null` 值的集合不被视为空。

参数

返回值

返回此集合中按属性排序后的最低元素。有关回调和 $sort 参数的信息，请查看 sortBy 方法

示例

// For a collection of employees
$min = $collection->min('age');
$min = $collection->min('user.salary');
$min = $collection->min(function ($e) {
 return $e->get('user')->get('salary');
});

// Display employee name
echo $min->name;

参数

返回值

返回一个新的集合，其中值根据 id 属性路径和父 id 属性路径嵌套在树状结构中。

参数

返回值

返回一个新的集合。

允许使用此特性的类确定其自己的返回集合接口类型

参数

返回值

解开此迭代器并返回最简单的可遍历对象，该对象可用于获取数据

返回值

将一组项目添加到集合前面，创建一个新的集合

参数

返回值

在集合前面添加一个单个项目，创建一个新的集合。

参数

返回值

将此集合中的值折叠为一个值，作为将回调函数应用于所有元素的结果。$initial 是归约的初始状态，并且每个后续步骤都应由回调函数返回。如果省略 $initial，则将使用集合的第一个值作为其替代，并且归约将从第二个项目开始。

参数

返回值

遍历集合中的每个值，并返回另一个集合，其中包含所有不通过真值测试的值。这是 filter 的反面。

每次执行回调函数时，它都会按顺序接收当前迭代中元素的值、元素的键以及此集合作为参数。

示例

过滤数组中的偶数，最终结果集合中只包含值 1 和 3。

$collection = (new Collection([1, 2, 3]))->reject(function ($value, $key) {
 return $value % 2 === 0;
});

参数

返回值

返回一个新的集合，其中包含从此集合中随机选择的最多 $length 个元素

参数

返回值

返回一个新的集合，其中元素以随机顺序排列，此函数不会保留集合中的原始键。

返回值

返回一个新的集合，它将跳过迭代开始处的指定数量的元素。

参数

返回值

如果此集合中的任何值通过回调中提供的真值测试，则返回 true。

回调函数会传入正在测试的元素的值和键，如果测试通过，则应该返回 true。

示例

$hasYoungPeople = (new Collection([24, 45, 15]))->some(function ($value, $key) {
 return $value < 21;
});

参数

返回值

根据将回调函数应用于每个值的返回值，返回一个来自此集合中元素的排序迭代器。参数 $path 也可以是表示列或属性名称的字符串。

回调函数将接收 $items 中每个元素作为第一个参数，回调函数返回的值将用作对该元素进行排序的值。请注意，回调函数可能会对每个元素调用多次。

示例

$items = $collection->sortBy(function ($user) {
 return $user->age;
});

// alternatively
$items = $collection->sortBy('age');

// or use a property path
$items = $collection->sortBy('department.name');

// output all user name order by their age in descending order
foreach ($items as $user) {
 echo $user->name;
}

参数

返回值

创建一个新的集合，当迭代时，如果提供的条件计算结果为 true，则将停止产生结果。

这对于处理无限迭代器或任何可能在某个点开始返回无效元素的生成器非常有用。例如，当从文件流中读取行时，您可能希望在达到某个特定值后停止迭代。

示例

获取 CSV 文件中行的数组，直到时间戳列小于某个日期。

$lines = (new Collection($fileLines))->stopWhen(function ($value, $key) {
 return (new DateTime($value))->format('Y') < 2012;
})
->toArray();

获取元素，直到找到第一个未批准的消息。

$comments = (new Collection($comments))->stopWhen(['is_approved' => false]);

参数

返回值

返回使用 $matcher 或此集合提取的所有值的总和。

示例

$items = [
 ['invoice' => ['total' => 100]],
 ['invoice' => ['total' => 200]],
];

$total = (new Collection($items))->sumOf('invoice.total');

// Total: 300

$total = (new Collection([1, 2, 3]))->sumOf();
// Total: 6

参数

返回值

返回一个新的集合，其中包含此集合创建的内部顺序中的最大 $length 个元素。如果传递了第二个参数，它将确定从哪个位置开始获取元素。

参数

返回值

返回集合的最后 N 个元素

示例

$items = [1, 2, 3, 4, 5];

$last = (new Collection($items))->takeLast(3);

// Result will look like this when converted to array
[3, 4, 5];

参数

返回值

将此集合传递给一个可调用对象作为其第一个参数。这对于使用另一个对象来装饰整个集合很有用。

示例

$items = [1, 2, 3];
$decorated = (new Collection($items))->through(function ($collection) {
     return new MyCustomCollection($collection);
});

参数

返回值

返回结果的数组表示。

参数

返回值

返回结果的数字索引数组表示。这等效于调用 toArray(false)

返回值

将行和列转置为列和行

示例

$items = [
      ['Products', '2012', '2013', '2014'],
      ['Product A', '200', '100', '50'],
      ['Product B', '300', '200', '100'],
      ['Product C', '400', '300', '200'],
]

$transpose = (new Collection($items))->transpose()->toList();

// Returns
// [
//     ['Products', 'Product A', 'Product B', 'Product C'],
//     ['2012', '200', '300', '400'],
//     ['2013', '100', '200', '300'],
//     ['2014', '50', '100', '200'],
// ]

返回值

抛出

创建一个新的集合，其中项目是通过将转换函数应用于原始集合中的每个项目而生成的项目列表的串联。

转换器函数将按顺序接收集合中每个项目的 value 和 key，它必须返回一个数组或一个可遍历对象，该对象可以连接到最终结果。

如果没有传递转换器函数，将使用一个“身份”函数。当源集合中的每个元素都是要一个接一个地追加的项目列表时，这很有用。

示例

$items [[1, 2, 3], [4, 5]];
$unfold = (new Collection($items))->unfold(); // Returns [1, 2, 3, 4, 5]

使用转换器

$items [1, 2, 3];
$allItems = (new Collection($items))->unfold(function ($page) {
 return $service->fetchPage($page)->toArray();
});

参数

返回值

遍历集合中的每个值，并返回一个新的集合，该集合仅包含基于 callback 返回的值的唯一值。

回调函数将 value 作为第一个参数，将 key 作为第二个参数传递。

参数

返回值

返回可以安全遍历而不会丢失任何可能转换的最接近的嵌套迭代器。这主要用于删除只能减慢迭代过程的空 IteratorIterator 包装器。

返回值

使用其位置索引作为参考，将此集合的元素与传递的可迭代对象的每个元素组合在一起。

示例

$collection = new Collection([1, 2]);
$collection->zip([3, 4], [5, 6])->toList(); // returns [[1, 3, 5], [2, 4, 6]]

参数

返回值

使用其位置索引作为参考，将此集合的元素与传递的可迭代对象的每个元素组合在一起。

结果元素将是 $callable 函数的返回值。

示例

$collection = new Collection([1, 2]);
$zipped = $collection->zipWith([3, 4], [5, 6], function (...$args) {
  return array_sum($args);
});
$zipped->toList(); // returns [9, 12]; [(1 + 3 + 5), (2 + 4 + 6)]

参数

返回值