类 FilterIterator

使用回调创建一个过滤后的迭代器，用于确定哪些项目被接受或拒绝。

每次执行回调时，它都会按顺序接收当前迭代中元素的值、元素的键以及传递的 $items 迭代器作为参数。

参数

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

返回值

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

返回值

重建集合实例。

参数

返回值

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

参数

返回值

从 $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);

在上面的示例中，如果在之前没有编译集合，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],
 ]
];

参数

返回值

给定一个列表和一个返回列表中每个元素的键（或属性名）的回调函数，返回一个包含每个项目的索引的对象。就像 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'],
// ]

返回值

抛出

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

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

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

示例

$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 返回的值的唯一值。

回调函数将值作为第一个参数，键作为第二个参数。

参数

返回值

返回最接近的嵌套迭代器，可以安全遍历而不会丢失任何可能的转换。这主要用于删除只能减慢迭代过程的空 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)]

参数

返回值