Класс ResultSetDecorator

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

Параметры

Исключения

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

Возвращает

Возвращает массив для сериализации этого объекта.

Возвращает

Восстанавливает экземпляр 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);

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

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

Параметры

Возвращает

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

Параметры

Возвращает

Делает этот объект счётным.

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

Возвращает

Сортирует список в группы и возвращает количество элементов в каждой группе. Аналогично 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.

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

Возвратить все элементы снизу вверх можно, используя обход в ширину (Breadth First Search), передав параметр $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']]
]

Параметры

Возвращаемое значение

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

Примеры:

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

Параметры

Возвращаемое значение

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

Примеры:

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

Параметры

Возвращаемое значение

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

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

Параметры

Возвращаемое значение

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

Возвращаемое значение

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

Параметры

Возвращает

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

Параметры

Возвращает

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

Параметры

Возвращает

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

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

Пример:

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

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

Параметры

Возвращает

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

Параметры

Возвращает

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

Возвращает

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

Возвращает

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

Параметры

Возвращает

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

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

Пример:

$hasYoungPeople = (new Collection([24, 45, 15]))->some(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;
}

Параметры

Возвращает

Создает новую коллекцию, которая при итерации прекратит выдавать результаты, если предоставленное условие принимает значение 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

Параметры

Возвращает

Возвращает новую коллекцию с максимальным количеством $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();
});

Параметры

Возвращает

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

Параметры

Возвращает

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

Параметры

Возвращает