Class ResultSetDecorator

Конструктор. Вы можете предоставить массив или любой объект, который можно пройти итерацией.

Parameters

Throws

Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.

Returns

Возвращает вызываемый объект, который получает значение и возвращает, соответствует ли оно определенному условию.

Parameters

Returns

Возвращает столбец из $data, который может быть извлечен путем итерации по именам столбцов, содержащимся в $path. Он будет возвращать массивы для элементов, представленных с помощью {*}

Parameters

Returns

Возвращает вызываемый объект, который можно использовать для извлечения свойства или столбца из массива или объекта на основе пути, разделенного точками.

Parameters

Returns

Возвращает столбец из $data, который может быть извлечен путем итерации по именам столбцов, содержащимся в $path

Parameters

Returns

Возвращает новую коллекцию как результат конкатенации списка элементов в этой коллекции со списком переданных элементов.

Parameters

Returns

Добавляет один элемент, создавая новую коллекцию.

Parameters

Returns

Возвращает среднее значение всех значений, извлеченных с помощью $path или из этой коллекции.

Example:

$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 значениями не считаются пустыми.

Parameters

Returns

Возвращает новую коллекцию, в которой выполняются операции, выполняемые этой коллекцией. Независимо от того, сколько раз итерируется новая коллекция, эти операции будут выполняться только один раз.

Это также можно использовать для того, чтобы любой неперемотаемый итератор можно было перемотать.

Returns

Создает новую коллекцию, которая является декартовым произведением текущей коллекции.

Для создания декартова произведения коллекция должна содержать одно измерение данных.

Example

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

Parameters

Returns

Разбивает коллекцию на меньшие массивы заданного размера.

Example:

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

Parameters

Returns

Разбивает коллекцию на меньшие массивы заданного размера.

Example:

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

Parameters

Returns

Возвращает новую коллекцию, где значения извлекаются на основе пути к значению, а затем индексируются по пути к ключу. Дополнительно этот метод может создавать родительские группы на основе пути к свойству группы.

Examples:

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

Parameters

Returns

Итерирует один раз все элементы в этой коллекции и выполняет все накопленные операции над ними, наконец, возвращает новую коллекцию с результатом. Это полезно для преобразования неперемотаемых внутренних итераторов в коллекцию, которую можно перемотать и использовать несколько раз.

Распространенный случай использования — повторное использование одной и той же переменной для вычисления различных данных. В таких случаях может быть полезно и эффективнее сначала скомпилировать коллекцию, а затем применить к ней дополнительные операции.

Example:

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

В приведенном выше примере, если бы коллекция не была скомпилирована ранее, итерации для map, sortBy и extract были бы выполнены дважды: один раз для получения $isJohnHere и один раз для $allButJohn

Вы можете рассматривать этот метод как способ создания контрольных точек для сложных вычислений в коллекции.

Parameters

Returns

Возвращает true, если $value присутствует в этой коллекции. Сравнения выполняются как по значению, так и по типу.

Parameters

Returns

Сделать этот объект подсчитываемым.

Часть интерфейса Countable. Вызов этого метода преобразует основной траверсабельный объект в массив и получит количество основных данных.

Returns

Сортирует список в группы и возвращает количество элементов в каждой группе. Аналогично groupBy, но вместо возврата списка значений возвращает количество значений в этой группе.

Когда $callback является строкой, это должно быть имя свойства для извлечения или путь, разделенный точками, свойств, которые должны быть пройдены, чтобы получить последний в пути.

Example:

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

Parameters

Returns

Возвращает количество уникальных ключей в этом итераторе. Это то же самое, что и количество элементов, которые будет содержать коллекция после вызова toArray()

Этот метод имеет ряд предостережений. Подробности см. в CollectionInterface::count()

Returns

See Also

Применяет обратный вызов к элементам в этой коллекции.

Example:

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

Parameters

Returns

Возвращает true, если все значения в этой коллекции проходят проверку истинности, указанную в обратном вызове.

Каждый раз, когда выполняется обратный вызов, он будет получать значение элемента в текущей итерации и ключ элемента в качестве аргументов в указанном порядке.

Example:

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

Пустые коллекции всегда возвращают true, потому что это пустая истина.

Parameters

Returns

Возвращает новую коллекцию, содержащую значение столбца или свойства, найденное в каждом из элементов.

Сопоставитель может быть строкой с именем свойства для извлечения или путем, разделенным точками, свойств, которые должны быть пройдены, чтобы получить последний в пути.

Если столбец или свойство не могут быть найдены для конкретного элемента в коллекции, эта позиция заполняется значением null.

Example:

Извлечь имя пользователя для всех комментариев в массиве:

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

Parameters

Returns

Просматривает каждое значение в коллекции и возвращает другую коллекцию со всеми значениями, которые проходят проверку истинности. Только значения, для которых обратный вызов возвращает true, будут присутствовать в результирующей коллекции.

Каждый раз, когда выполняется обратный вызов, он будет получать значение элемента в текущей итерации, ключ элемента и эту коллекцию в качестве аргументов в указанном порядке.

Example:

Фильтрация нечетных чисел в массиве, в конце только значение 2 будет присутствовать в результирующей коллекции:

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

Parameters

Returns

Возвращает первый результат в этой коллекции

Returns

Возвращает первый результат, соответствующий всем парам «ключ-значение», перечисленным в условиях.

Parameters

Returns

See Also

Разделяет коллекцию на наборы, сгруппированные по результату выполнения каждого значения через обратный вызов. Если $callback является строкой, а не вызываемым объектом, группирует по свойству, названному $callback, для каждого из значений.

Когда $callback является строкой, это должно быть имя свойства для извлечения или путь, разделенный точками, свойств, которые должны быть пройдены, чтобы получить последний в пути.

Example:

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

Parameters

Returns

Учитывая список и функцию обратного вызова, которая возвращает ключ для каждого элемента в списке (или имя свойства), возвращает объект с индексом каждого элемента. Как и groupBy, но для случаев, когда вы знаете, что ваши ключи уникальны.

Когда $callback является строкой, это должно быть имя свойства для извлечения или путь, разделенный точками, свойств, которые должны быть пройдены, чтобы получить последний в пути.

Example:

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

Parameters

Returns

Возвращает новую коллекцию, содержащую каждый из элементов, найденных в $values, как свойство внутри соответствующих элементов в этой коллекции. Свойство, в которое будут вставлены значения, описывается параметром $path.

$path может быть строкой с именем свойства или путем, разделенным точками, свойств, которые должны быть пройдены, чтобы получить последний в пути.

Если столбец или свойство не могут быть найдены для конкретного элемента в коллекции как часть пути, элемент останется неизменным.

Example:

Вставить возраст в коллекцию, содержащую пользователей:

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

Parameters

Returns

Возвращает, есть ли элементы в этой коллекции

Example:

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

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

Returns

Возвращает данные, которые могут быть преобразованы в JSON. Возвращает те же данные, что и toArray(), которые содержат только уникальные ключи.

Часть интерфейса JsonSerializable.

Returns

Возвращает последний результат в этой коллекции

Returns

Возвращает новую коллекцию, в которой все операции, присоединенные после неё, гарантированно выполняются лениво. То есть, элементы будут выводиться по одному.

Ленивую коллекцию можно итерировать только один раз. Вторая попытка приводит к ошибке.

Returns

Возвращает новую коллекцию с каждым из элементов этой коллекции после сглаживания древовидной структуры. Древовидная структура определяется вложенными элементами под ключом с известным именем. Можно указать такое имя, используя параметр '$nestingKey'.

По умолчанию будут возвращены все элементы в дереве, следующие за поиском в глубину, то есть элементы от верхнего родителя до листьев для каждой ветви.

Можно вернуть все элементы снизу вверх, используя подход поиска в ширину, передав параметр '$dir' со значением 'asc'. То есть, он вернет все элементы для одной и той же глубины дерева сначала, а затем снизу вверх.

Наконец, вы можете указать, чтобы получить только коллекцию с узлами-листьями в древовидной структуре. Для этого передайте 'leaves' в первом аргументе.

Возможные значения для первого аргумента являются псевдонимами для следующих констант, и можно передавать их вместо псевдонима:

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

Example:

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

Parameters

Returns

Возвращает другую коллекцию после изменения каждого из значений в этой коллекции с помощью предоставленного вызываемого объекта.

Каждый раз при выполнении обратного вызова он будет получать значение элемента в текущей итерации, ключ элемента и эту коллекцию в качестве аргументов в указанном порядке.

Example:

Получение коллекции булевых значений, где true указывает, является ли человек женщиной:

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

Parameters

Returns

Просматривает каждое значение в списке, возвращая коллекцию всех значений, которые содержат все пары ключ-значение, перечисленные в $conditions.

Example:

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

Parameters

Returns

Возвращает верхний элемент в этой коллекции после сортировки по свойству. Проверьте метод sortBy для получения информации о параметрах обратного вызова и $sort

Examples:

// 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;

Parameters

Returns

See Also

Возвращает медиану всех значений, извлеченных с помощью $path или из этой коллекции.

Example:

$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 не считаются пустыми.

Parameters

Returns

Возвращает нижний элемент в этой коллекции после сортировки по свойству. Проверьте метод sortBy для получения информации о параметрах обратного вызова и $sort

Examples:

// 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;

Parameters

Returns

See Also

Возвращает новую коллекцию, где значения вложены в древовидную структуру на основе пути к свойству id и пути к свойству родительского id.

Parameters

Returns

Возвращает новую коллекцию.

Позволяет классам, которые используют этот трейт, определять свой собственный тип возвращаемого интерфейса коллекции

Parameters

Returns

Разворачивает этот итератор и возвращает самый простой траверсабельный объект, который можно использовать для получения данных

Returns

Добавляет набор элементов в начало коллекции, создавая новую коллекцию

Parameters

Returns

Добавляет один элемент в начало, создавая новую коллекцию.

Parameters

Returns

Сворачивает значения в этой коллекции в одно значение, как результат применения функции обратного вызова ко всем элементам. $zero - это начальное состояние свертывания, и каждый последующий шаг должен возвращаться функцией обратного вызова. Если $zero опущено, первое значение коллекции будет использовано вместо него, и свертывание начнется со второго элемента.

Parameters

Returns

Проходит по каждому значению в коллекции и возвращает другую коллекцию со всеми значениями, которые не проходят проверку истинности. Это противоположность filter.

Каждый раз, когда выполняется обратный вызов, он будет получать значение элемента в текущей итерации, ключ элемента и эту коллекцию в качестве аргументов, в указанном порядке.

Пример:

Фильтрация четных чисел в массиве, в конце в результирующей коллекции будут присутствовать только значения 1 и 3:

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

Параметры

Возвращает

Возвращает новую коллекцию с максимальным количеством $size случайных элементов из этой коллекции

Параметры

Возвращает

Возвращает строковое представление этого объекта, которое может быть использовано для его реконструкции

Возвращает

Возвращает новую коллекцию с элементами, размещенными в случайном порядке, эта функция не сохраняет исходные ключи в коллекции.

Возвращает

Возвращает новую коллекцию, которая будет пропускать указанное количество элементов в начале итерации.

Параметры

Возвращает

Возвращает true, если любое из значений в этой коллекции проходит проверку истинности, указанную в обратном вызове.

Каждый раз, когда выполняется обратный вызов, он будет получать значение элемента в текущей итерации и ключ элемента в качестве аргументов, в указанном порядке.

Пример:

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

Параметры

Возвращает

Возвращает отсортированный итератор из элементов в этой коллекции, ранжированных в порядке возрастания по результатам прогона каждого значения через обратный вызов. $callback также может быть строкой, представляющей имя столбца или свойства.

Обратный вызов будет получать в качестве своего первого аргумента каждый из элементов в $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;
}

Параметры

Возвращает

Создает новую коллекцию, которая при итерации прекратит выдавать результаты, если предоставленное условие будет истинным.

Это удобно для работы с бесконечными итераторами или любым генератором, который может начать возвращать недействительные элементы в определенный момент. Например, при чтении строк из потока файла вы можете захотеть остановить итерацию после достижения определенного значения.

Пример:

Получить массив строк в 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

Параметры

Возвращает

Возвращает новую коллекцию с максимальным количеством $size элементов во внутреннем порядке, в котором была создана эта коллекция. Если передан второй параметр, он определит, с какой позиции начинать брать элементы.

Параметры

Возвращает

Возвращает последние 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'],
// ]

Возвращает

Создает новую коллекцию, элементы которой представляют собой конкатенацию списков элементов, генерируемых функцией преобразования, примененной к каждому элементу исходной коллекции.

Функция преобразования будет получать значение и ключ для каждого из элементов коллекции в указанном порядке, и она должна возвращать массив или объект Traversable, который может быть объединен с окончательным результатом.

Если функция преобразования не передана, будет использоваться функция "тождества". Это полезно, когда каждый из элементов исходной коллекции представляет собой список элементов, которые должны быть добавлены один за другим.

Пример:

$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();
});

Параметры

Возвращает

Расссериализует переданную строку и восстанавливает экземпляр коллекции

Параметры

Возвращает

Возвращает ближайший вложенный итератор, который можно безопасно пройти, не теряя каких-либо возможных преобразований. Это используется в основном для удаления пустых оболочек 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)]

Параметры

Возвращает