Коллекция

класс Collection реализует ArrayAccess, CanBeEscapedWhenCastToString, Enumerable (Просмотреть исходный код)

Трейты

Свойства

protected bool	$escapeWhenCastingToString	Указывает, что строковое представление объекта должно быть экранировано при вызове __toString.	из EnumeratesValues
static protected string[]	$proxies	Методы, которые могут быть проксированы.	из EnumeratesValues
HigherOrderCollectionProxy только для чтения	$average		из EnumeratesValues
HigherOrderCollectionProxy только для чтения	$avg		из EnumeratesValues
HigherOrderCollectionProxy только для чтения	$contains		из EnumeratesValues
HigherOrderCollectionProxy только для чтения	$doesntContain		из EnumeratesValues
HigherOrderCollectionProxy только для чтения	$each		из EnumeratesValues
HigherOrderCollectionProxy только для чтения	$every		из EnumeratesValues
HigherOrderCollectionProxy только для чтения	$filter		из EnumeratesValues
HigherOrderCollectionProxy только для чтения	$first		из EnumeratesValues
HigherOrderCollectionProxy только для чтения	$flatMap		из EnumeratesValues
HigherOrderCollectionProxy только для чтения	$groupBy		из EnumeratesValues
HigherOrderCollectionProxy только для чтения	$keyBy		из EnumeratesValues
HigherOrderCollectionProxy только для чтения	$map		из EnumeratesValues
HigherOrderCollectionProxy только для чтения	$max		из EnumeratesValues
HigherOrderCollectionProxy только для чтения	$min		из EnumeratesValues
HigherOrderCollectionProxy только для чтения	$partition		из EnumeratesValues
HigherOrderCollectionProxy только для чтения	$reject		из EnumeratesValues
HigherOrderCollectionProxy только для чтения	$some		из EnumeratesValues
HigherOrderCollectionProxy только для чтения	$sortBy		из EnumeratesValues
HigherOrderCollectionProxy только для чтения	$sortByDesc		из EnumeratesValues
HigherOrderCollectionProxy только для чтения	$skipUntil		из EnumeratesValues
HigherOrderCollectionProxy только для чтения	$skipWhile		из EnumeratesValues
HigherOrderCollectionProxy только для чтения	$sum		из EnumeratesValues
HigherOrderCollectionProxy только для чтения	$takeUntil		из EnumeratesValues
HigherOrderCollectionProxy только для чтения	$takeWhile		из EnumeratesValues
HigherOrderCollectionProxy только для чтения	$unique		из EnumeratesValues
HigherOrderCollectionProxy только для чтения	$until		из EnumeratesValues

static protected array	$macros	Зарегистрированные строковые макросы.	from Macroable
protected array	$items	Элементы, содержащиеся в коллекции.

Методы

static EnumeratesValues	make(mixed $items = []) Создать новый экземпляр коллекции, если значение не является коллекцией.	from EnumeratesValues
static EnumeratesValues	wrap(mixed $value) Оборачивает данное значение в коллекцию, если применимо.	from EnumeratesValues
static array	unwrap(array\|EnumeratesValues $value) Получить базовые элементы из заданной коллекции, если применимо.	from EnumeratesValues
static EnumeratesValues	empty() Создать новый экземпляр без элементов.	from EnumeratesValues
static EnumeratesValues	times(int $number, callable $callback = null) Создать новую коллекцию, вызвав обратный вызов заданное количество раз.	from EnumeratesValues
mixed	average(callable\|string\|null $callback = null) Псевдоним для метода "avg".	from EnumeratesValues
bool	some(mixed $key, mixed $operator = null, mixed $value = null) Псевдоним для метода "contains".	from EnumeratesValues
bool	containsStrict(mixed $key, mixed $value = null) Определить, существует ли элемент, используя строгое сравнение.	from EnumeratesValues
void	dd(mixed ...$args) Вывести элементы и завершить сценарий.	from EnumeratesValues
$this	dump() Вывести элементы.	from EnumeratesValues
$this	each(callable $callback) Выполнить обратный вызов над каждым элементом.	from EnumeratesValues
EnumeratesValues	eachSpread(callable $callback) Выполнить обратный вызов над каждым вложенным фрагментом элементов.	from EnumeratesValues
bool	every(string\|callable $key, mixed $operator = null, mixed $value = null) Определить, удовлетворяют ли все элементы заданному истинностному тесту.	from EnumeratesValues
mixed	firstWhere(string $key, mixed $operator = null, mixed $value = null) Получить первый элемент по заданной паре ключ-значение.	from EnumeratesValues
bool	isNotEmpty() Определить, не пуста ли коллекция.	from EnumeratesValues
EnumeratesValues	mapSpread(callable $callback) Применить отображение к каждому вложенному фрагменту элементов.	from EnumeratesValues
EnumeratesValues	mapToGroups(callable $callback) Применить групповое отображение к элементам.	from EnumeratesValues
EnumeratesValues	flatMap(callable $callback) Применить отображение к коллекции и уплостить результат на один уровень.	from EnumeratesValues
EnumeratesValues	mapInto(string $class) Применить отображение значений в новый класс.	from EnumeratesValues
mixed	min(callable\|string\|null $callback = null) Получить минимальное значение заданного ключа.	from EnumeratesValues
mixed	max(callable\|string\|null $callback = null) Получить максимальное значение заданного ключа.	from EnumeratesValues
EnumeratesValues	forPage(int $page, int $perPage) "Разбить на страницы" коллекцию, разделив её на меньшие коллекции.	from EnumeratesValues
EnumeratesValues	partition(callable\|string $key, mixed $operator = null, mixed $value = null) Разделить коллекцию на два массива с помощью заданного обратного вызова или ключа.	from EnumeratesValues
mixed	sum(callable\|string\|null $callback = null) Получить сумму заданных значений.	from EnumeratesValues
EnumeratesValues\|mixed	when(bool\|mixed $value, callable $callback = null, callable $default = null) Применить обратный вызов, если значение истинно.	from EnumeratesValues
EnumeratesValues\|mixed	whenEmpty(callable $callback, callable $default = null) Применить обратный вызов, если коллекция пуста.	from EnumeratesValues
EnumeratesValues\|mixed	whenNotEmpty(callable $callback, callable $default = null) Применить обратный вызов, если коллекция не пуста.	from EnumeratesValues

EnumeratesValues\|mixed	unless(bool $value, callable $callback, callable $default = null) Применить обратный вызов, если значение ложно.	из EnumeratesValues
EnumeratesValues\|mixed	unlessEmpty(callable $callback, callable $default = null) Применить обратный вызов, если коллекция не пуста.	из EnumeratesValues
EnumeratesValues\|mixed	unlessNotEmpty(callable $callback, callable $default = null) Применить обратный вызов, если коллекция не пуста.	из EnumeratesValues
EnumeratesValues	where(string $key, mixed $operator = null, mixed $value = null) Фильтровать элементы по заданной паре ключ-значение.	из EnumeratesValues
EnumeratesValues	whereNull(string\|null $key = null) Фильтровать элементы, где значение для заданного ключа равно null.	из EnumeratesValues
EnumeratesValues	whereNotNull(string\|null $key = null) Фильтровать элементы, где значение для заданного ключа не равно null.	из EnumeratesValues
EnumeratesValues	whereStrict(string $key, mixed $value) Фильтровать элементы по заданной паре ключ-значение, используя строгое сравнение.	из EnumeratesValues
EnumeratesValues	whereIn(string $key, mixed $values, bool $strict = false) Фильтровать элементы по заданной паре ключ-значение.	из EnumeratesValues
EnumeratesValues	whereInStrict(string $key, mixed $values) Фильтровать элементы по заданной паре ключ-значение, используя строгое сравнение.	из EnumeratesValues
EnumeratesValues	whereBetween(string $key, array $values) Фильтровать элементы так, чтобы значение заданного ключа находилось между заданными значениями.	из EnumeratesValues
EnumeratesValues	whereNotBetween(string $key, array $values) Фильтровать элементы так, чтобы значение заданного ключа не находилось между заданными значениями.	из EnumeratesValues
EnumeratesValues	whereNotIn(string $key, mixed $values, bool $strict = false) Фильтровать элементы по заданной паре ключ-значение.	из EnumeratesValues
EnumeratesValues	whereNotInStrict(string $key, mixed $values) Фильтровать элементы по заданной паре ключ-значение, используя строгое сравнение.	из EnumeratesValues
EnumeratesValues	whereInstanceOf(string\|string[] $type) Фильтровать элементы, удаляя все элементы, которые не соответствуют заданному типу (типам).	из EnumeratesValues
mixed	pipe(callable $callback) Передать коллекцию в заданный обратный вызов и вернуть результат.	из EnumeratesValues
mixed	pipeInto(string $class) Передать коллекцию в новый класс.	из EnumeratesValues
mixed	pipeThrough(callable[] $pipes) Пропустить коллекцию через серию вызываемых каналов и вернуть результат.	из EnumeratesValues
$this	tap(callable $callback) Передать коллекцию в заданный обратный вызов, а затем вернуть её.	из EnumeratesValues
mixed	reduce(callable $callback, mixed $initial = null) Свести коллекцию к одному значению.	из EnumeratesValues
array	reduceMany(callable $callback, mixed ...$initial) deprecated Свести коллекцию к нескольким агрегированным значениям.	из EnumeratesValues
array	reduceSpread(callable $callback, mixed ...$initial) Свести коллекцию к нескольким агрегированным значениям.	из EnumeratesValues
mixed	reduceWithKeys(callable $callback, mixed $initial = null) Свести ассоциативную коллекцию к одному значению.	из EnumeratesValues
EnumeratesValues	reject(callable\|mixed $callback = true) Создать коллекцию всех элементов, которые не проходят заданный тест истинности.	из EnumeratesValues
EnumeratesValues	uniqueStrict(string\|callable\|null $key = null) Возвращает только уникальные элементы из массива коллекции, используя строгое сравнение.	из EnumeratesValues
Collection	collect() Собрать значения в коллекцию.	из EnumeratesValues

массив	toArray() Получить коллекцию элементов в виде простого массива.	из EnumeratesValues
массив	jsonSerialize() Преобразовать объект в сериализуемый в JSON формат.	из EnumeratesValues
строка	toJson(int $options = 0) Получить коллекцию элементов в формате JSON.	из EnumeratesValues
CachingIterator	getCachingIterator(int $flags = CachingIterator::CALL_TOSTRING) Получить экземпляр CachingIterator.	из EnumeratesValues
строка	__toString() Преобразовать коллекцию в строковое представление.	из EnumeratesValues
$this	escapeWhenCastingToString(bool $escape = true) Указать, что строковое представление модели должно быть экранировано при вызове __toString.	из EnumeratesValues
статический void	proxy(string $method) Добавить метод в список прокси-методов.	из EnumeratesValues
смешанный тип	__get(string $key) Динамический доступ к прокси коллекций.	из EnumeratesValues
массив	getArrayableItems(mixed $items) Массив результатов элементов из Collection или Arrayable.	из EnumeratesValues
Closure	operatorForWhere(string $key, string\|null $operator = null, mixed $value = null) Получить обратный вызов для проверки оператора.	из EnumeratesValues
bool	useAsCallable(mixed $value) Определить, является ли данное значение вызываемым, но не строкой.	из EnumeratesValues
вызываемый объект	valueRetriever(callable\|string\|null $value) Получить обратный вызов для извлечения значения.	из EnumeratesValues
Closure	equality(mixed $value) Создать функцию для проверки равенства элемента.	из EnumeratesValues
Closure	negate(Closure $callback) Создать функцию, используя другую функцию, инвертируя её результат.	из EnumeratesValues
Closure	identity() Создать функцию, возвращающую переданное ей значение.	из EnumeratesValues
статический void	macro(string $name, object\|callable $macro) Зарегистрировать пользовательское макро.	из Macroable
статический void	mixin(object $mixin, bool $replace = true) Смешать другой объект в класс.	из Macroable
статический bool	hasMacro(string $name) Проверяет, зарегистрировано ли макро.	из Macroable
статический void	flushMacros() Очистить существующие макросы.	из Macroable
статический смешанный тип	__callStatic(string $method, array $parameters) Динамически обрабатывать вызовы к классу.	из Macroable
смешанный тип	__call(string $method, array $parameters) Динамически обрабатывать вызовы к классу.	из Macroable
void	__construct(mixed $items = []) Создать новую коллекцию.
статический Enumerable	range(int $from, int $to) Создать коллекцию с заданным диапазоном.
массив	all() Получить все элементы в коллекции.
LazyCollection	lazy() Получить ленивую коллекцию для элементов в этой коллекции.
смешанный тип	avg(callable\|string\|null $callback = null) Получить среднее значение заданного ключа.
смешанный тип	median(string\|array\|null $key = null) Получить медиану заданного ключа.
массив\|null	mode(string\|array\|null $key = null) Получить моду заданного ключа.
Enumerable	collapse() Свести коллекцию элементов в один массив.
bool	contains(mixed $key, mixed $operator = null, mixed $value = null) Определить, существует ли элемент в коллекции.
bool	doesntContain(mixed $key, mixed $operator = null, mixed $value = null) Определить, не содержится ли элемент в коллекции.
Enumerable	crossJoin(mixed ...$lists) Перекрестное объединение с заданными списками, возвращая все возможные перестановки.
Enumerable	diff(mixed $items) Получить элементы в коллекции, которых нет в заданных элементах.
Enumerable	diffUsing(mixed $items, callable $callback) Получить элементы в коллекции, которых нет в заданных элементах, используя обратный вызов.

Enumerable	diffAssoc(mixed $items) Получить элементы в коллекции, ключи и значения которых отсутствуют в заданных элементах.
Enumerable	diffAssocUsing(mixed $items, callable $callback) Получить элементы в коллекции, ключи и значения которых отсутствуют в заданных элементах, используя обратный вызов.
Enumerable	diffKeys(mixed $items) Получить элементы в коллекции, ключи которых отсутствуют в заданных элементах.
Enumerable	diffKeysUsing(mixed $items, callable $callback) Получить элементы в коллекции, ключи которых отсутствуют в заданных элементах, используя обратный вызов.
Enumerable	duplicates(callable\|string\|null $callback = null, bool $strict = false) Получить дублирующиеся элементы из коллекции.
Enumerable	duplicatesStrict(callable\|string\|null $callback = null) Получить дублирующиеся элементы из коллекции, используя строгое сравнение.
Closure	duplicateComparator(bool $strict) Получить функцию сравнения для обнаружения дубликатов.
Enumerable	except(mixed $keys) Получить все элементы, кроме тех, которые имеют указанные ключи.
Enumerable	filter(callable $callback = null) Применить фильтр к каждому из элементов.
mixed	first(callable $callback = null, mixed $default = null) Получить первый элемент из коллекции, удовлетворяющий заданному условию.
Enumerable	flatten(int $depth = INF) Получить сплющенную массив элементов из коллекции.
Enumerable	flip() Поменять местами ключи и значения в коллекции.
$this	forget(string\|int\|array $keys) Удалить элемент из коллекции по ключу.
mixed	get(mixed $key, mixed $default = null) Получить элемент из коллекции по ключу.
mixed	getOrPut(mixed $key, mixed $value) Получить элемент из коллекции по ключу или добавить его в коллекцию, если он не существует.
Enumerable	groupBy(array\|callable\|string $groupBy, bool $preserveKeys = false) Сгруппировать ассоциативный массив по полю или с помощью обратного вызова.
Enumerable	keyBy(callable\|string $keyBy) Присвоить ключи ассоциативному массиву по полю или с помощью обратного вызова.
bool	has(mixed $key) Определить, существует ли элемент в коллекции по ключу.
bool	hasAny(mixed $key) Определить, существуют ли какие-либо ключи в коллекции.
string	implode(string $value, string\|null $glue = null) Конкатенировать значения заданного ключа в строку.
Enumerable	intersect(mixed $items) Пересечь коллекцию с заданными элементами.
Enumerable	intersectByKeys(mixed $items) Пересечь коллекцию с заданными элементами по ключу.
bool	isEmpty() Определить, пуста ли коллекция.
bool	containsOneItem() Определить, содержит ли коллекция один элемент.
string	join(string $glue, string $finalGlue = '') Объединить все элементы из коллекции с помощью строки. Для последних элементов можно использовать отдельную строку склейки.
Enumerable	keys() Получить ключи элементов коллекции.
mixed	last(callable $callback = null, mixed $default = null) Получить последний элемент из коллекции.
Enumerable	pluck(string\|array $value, string\|null $key = null) Получить значения заданного ключа.
Enumerable	map(callable $callback) Применить отображение к каждому из элементов.
Enumerable	mapToDictionary(callable $callback) Применить отображение словаря к элементам.
Enumerable	mapWithKeys(callable $callback) Применить ассоциативное отображение к каждому из элементов.
Enumerable	merge(mixed $items) Объединить коллекцию с заданными элементами.
Enumerable	mergeRecursive(mixed $items) Рекурсивно объединить коллекцию с заданными элементами.
Enumerable	combine(mixed $values) Создать коллекцию, используя эту коллекцию для ключей и другую для значений.
Enumerable	union(mixed $items) Объединить коллекцию с заданными элементами.
Enumerable	nth(int $step, int $offset = 0) Создать новую коллекцию, содержащую каждый n-й элемент.
Enumerable	only(mixed $keys) Получить элементы с указанными ключами.
mixed	pop(int $count = 1) Получить и удалить последние N элементов из коллекции.
$this	prepend(mixed $value, mixed $key = null) Добавить элемент в начало коллекции.
$this	push(mixed ...$values) Добавить один или несколько элементов в конец коллекции.
Enumerable	concat(iterable $source) Добавить все заданные элементы в коллекцию.

mixed	pull(mixed $key, mixed $default = null) Получить и удалить элемент из коллекции.
$this	put(mixed $key, mixed $value) Поместить элемент в коллекцию по ключу.
Enumerable\|mixed	random(int\|null $number = null) Получить один или заданное количество элементов случайным образом из коллекции.
Enumerable	replace(mixed $items) Заменить элементы коллекции на заданные элементы.
Enumerable	replaceRecursive(mixed $items) Рекурсивно заменить элементы коллекции на заданные элементы.
Enumerable	reverse() Перевернуть порядок элементов.
mixed	search(mixed $value, bool $strict = false) Поиск значения в коллекции и возврат соответствующего ключа, если поиск успешен.
mixed	shift(int $count = 1) Получить и удалить первые N элементов из коллекции.
Enumerable	shuffle(int\|null $seed = null) Перемешать элементы в коллекции.
Collection	sliding(int $size = 2, int $step = 1) Создать куски, представляющие «скользящее окно» вида элементов в коллекции.
Enumerable	skip(int $count) Пропустить первые {$count} элементов.
Enumerable	skipUntil(mixed $value) Пропустить элементы в коллекции до тех пор, пока не будет выполнено заданное условие.
Enumerable	skipWhile(mixed $value) Пропустить элементы в коллекции, пока выполняется заданное условие.
Enumerable	slice(int $offset, int\|null $length = null) Выделить подмассив коллекции.
Enumerable	split(int $numberOfGroups) Разделить коллекцию на определенное количество групп.
Collection	splitIn(int $numberOfGroups) Разделить коллекцию на определенное количество групп, и заполнить первые группы полностью.
mixed	sole(mixed $key = null, mixed $operator = null, mixed $value = null) Получить первый элемент в коллекции, только если элементов ровно один. В противном случае выбросить исключение.
mixed	firstOrFail(mixed $key = null, mixed $operator = null, mixed $value = null) Получить первый элемент в коллекции, но выбросить исключение, если соответствующих элементов нет.
Enumerable	chunk(int $size) Разбить коллекцию на куски заданного размера.
Enumerable	chunkWhile(callable $callback) Разбить коллекцию на куски с помощью обратного вызова.
Enumerable	sort(callable\|null\|int $callback = null) Отсортировать каждый элемент с помощью обратного вызова.
Enumerable	sortDesc(int $options = SORT_REGULAR) Отсортировать элементы в порядке убывания.
Enumerable	sortBy(callable\|string $callback, int $options = SORT_REGULAR, bool $descending = false) Отсортировать коллекцию с помощью заданного обратного вызова.
Collection	sortByMany(array $comparisons = []) Отсортировать коллекцию с помощью множественных сравнений.
Enumerable	sortByDesc(callable\|string $callback, int $options = SORT_REGULAR) Отсортировать коллекцию в порядке убывания с помощью заданного обратного вызова.
Enumerable	sortKeys(int $options = SORT_REGULAR, bool $descending = false) Отсортировать ключи коллекции.
Enumerable	sortKeysDesc(int $options = SORT_REGULAR) Отсортировать ключи коллекции в порядке убывания.
Collection	sortKeysUsing(callable $callback) Отсортировать ключи коллекции с помощью обратного вызова.
Collection	splice(int $offset, int\|null $length = null, mixed $replacement = []) Вставить/удалить часть массива коллекции.
Enumerable	take(int $limit) Взять первые или последние {$limit} элементов.
Enumerable	takeUntil(mixed $value) Взять элементы из коллекции до тех пор, пока не выполняется заданное условие.
Enumerable	takeWhile(mixed $value) Взять элементы из коллекции, пока выполняется заданное условие.
$this	transform(callable $callback) Преобразовать каждый элемент в коллекции с помощью обратного вызова.
Collection	undot() Преобразовать массив с «точечной» нотацией в развернутый массив.
Enumerable	unique(string\|callable\|null $key = null, bool $strict = false) Возвратить только уникальные элементы из коллекции.
Enumerable	values() Сбросить ключи в базовом массиве.
Enumerable	zip(mixed $items) Скомпоновать коллекцию вместе с одним или несколькими массивами.
Enumerable	pad(int $size, mixed $value) Заполнить коллекцию до указанной длины значением.
ArrayIterator	getIterator() Получить итератор для элементов.
int	count() Подсчитать количество элементов в коллекции.

Перечисляемый	countBy(callable\|string $countBy = null) Подсчитать количество элементов в коллекции по полю или с помощью обратного вызова.
$this	add(mixed $item) Добавить элемент в коллекцию.
Коллекция	toBase() Получить базовый экземпляр коллекции Support из этой коллекции.
bool	offsetExists(mixed $key) Определить, существует ли элемент по указанному смещению.
mixed	offsetGet(mixed $key) Получить элемент по указанному смещению.
void	offsetSet(mixed $key, mixed $value) Установить элемент по указанному смещению.
void	offsetUnset(mixed $key) Удалить элемент по указанному смещению.

Подробности

static EnumeratesValues make(mixed $items = [])

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

Параметры

mixed

$items

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

EnumeratesValues

static EnumeratesValues wrap(mixed $value)

Оборачивает заданное значение в коллекцию, если применимо.

Параметры

mixed

$value

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

EnumeratesValues

static array unwrap(array|EnumeratesValues $value)

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

Параметры

array|EnumeratesValues

$value

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

array

static EnumeratesValues empty()

Создать новый экземпляр без элементов.

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

EnumeratesValues

static EnumeratesValues times(int $number, callable $callback = null)

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

Параметры

int	$number
callable	$callback

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

EnumeratesValues

mixed average(callable|string|null $callback = null)

Псевдоним для метода "avg".

Параметры

callable|string|null

$callback

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

mixed

bool some(mixed $key, mixed $operator = null, mixed $value = null)

Псевдоним для метода "contains".

Параметры

mixed	$key
mixed	$operator
mixed	$value

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

bool

bool containsStrict(mixed $key, mixed $value = null)

Определяет, существует ли элемент, используя строгое сравнение.

Параметры

mixed	$key
mixed	$value

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

bool

void dd(mixed ...$args)

Вывести элементы и завершить скрипт.

Параметры

mixed

...$args

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

void

$this dump()

Вывести элементы.

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

$this

$this each(callable $callback)

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

Параметры

callable

$callback

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

$this

EnumeratesValues eachSpread(callable $callback)

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

Параметры

callable

$callback

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

EnumeratesValues

bool every(string|callable $key, mixed $operator = null, mixed $value = null)

Определить, проходят ли все элементы заданный тест истинности.

Параметры

string\|callable	$key
mixed	$operator
mixed	$value

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

bool

mixed firstWhere(string $key, mixed $operator = null, mixed $value = null)

Получить первый элемент по заданной паре ключ-значение.

Параметры

string	$key
mixed	$operator
mixed	$value

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

mixed

bool isNotEmpty()

Определить, не пуста ли коллекция.

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

bool

EnumeratesValues mapSpread(callable $callback)

Применить map ко всем вложенным фрагментам элементов.

Параметры

callable

$callback

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

EnumeratesValues

END_OF_DOCUMENT_MARKER

EnumeratesValues mapToGroups(callable $callback)

Выполнить группировку элементов по заданному правилу.

Обратный вызов должен вернуть ассоциативный массив с единственной парой ключ/значение.

Parameters

callable

$callback

Return Value

EnumeratesValues

EnumeratesValues flatMap(callable $callback)

Применить функцию-преобразователь к коллекции и уплостить результат на один уровень.

Parameters

callable

$callback

Return Value

EnumeratesValues

EnumeratesValues mapInto(string $class)

Преобразовать значения в новый класс.

Parameters

string

$class

Return Value

EnumeratesValues

mixed min(callable|string|null $callback = null)

Получить минимальное значение по заданному ключу.

Parameters

callable|string|null

$callback

Return Value

mixed

mixed max(callable|string|null $callback = null)

Получить максимальное значение по заданному ключу.

Parameters

callable|string|null

$callback

Return Value

mixed

EnumeratesValues forPage(int $page, int $perPage)

Разбить коллекцию на страницы, отсекая части коллекции.

Parameters

int	$page
int	$perPage

Return Value

EnumeratesValues

EnumeratesValues partition(callable|string $key, mixed $operator = null, mixed $value = null)

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

Parameters

callable\|string	$key
mixed	$operator
mixed	$value

Return Value

EnumeratesValues

mixed sum(callable|string|null $callback = null)

Получить сумму значений.

Parameters

callable|string|null

$callback

Return Value

mixed

EnumeratesValues|mixed when(bool|mixed $value, callable $callback = null, callable $default = null)

Применить обратный вызов, если значение истинно.

Parameters

bool\|mixed	$value
callable	$callback
callable	$default

Return Value

EnumeratesValues|mixed

EnumeratesValues|mixed whenEmpty(callable $callback, callable $default = null)

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

Parameters

callable	$callback
callable	$default

Return Value

EnumeratesValues|mixed

EnumeratesValues|mixed whenNotEmpty(callable $callback, callable $default = null)

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

Parameters

callable	$callback
callable	$default

Return Value

EnumeratesValues|mixed

EnumeratesValues|mixed unless(bool $value, callable $callback, callable $default = null)

Применить обратный вызов, если значение ложно.

Parameters

bool	$value
callable	$callback
callable	$default

Return Value

EnumeratesValues|mixed

EnumeratesValues|mixed unlessEmpty(callable $callback, callable $default = null)

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

Parameters

callable	$callback
callable	$default

Return Value

EnumeratesValues|mixed

EnumeratesValues|mixed unlessNotEmpty(callable $callback, callable $default = null)

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

Parameters

callable	$callback
callable	$default

Return Value

EnumeratesValues|mixed

EnumeratesValues where(string $key, mixed $operator = null, mixed $value = null)

Фильтровать элементы по заданной паре ключ-значение.

Parameters

string	$key
mixed	$operator
mixed	$value

Return Value

EnumeratesValues

EnumeratesValues whereNull(string|null $key = null)

Фильтровать элементы, где значение для заданного ключа равно null.

Parameters

string|null

$key

Return Value

EnumeratesValues

EnumeratesValues whereNotNull(string|null $key = null)

Фильтрует элементы, где значение для заданного ключа не равно null.

Параметры

string|null

$key

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

EnumeratesValues

EnumeratesValues whereStrict(string $key, mixed $value)

Фильтрует элементы по заданной паре ключ-значение с использованием строгого сравнения.

Параметры

string	$key
mixed	$value

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

EnumeratesValues

EnumeratesValues whereIn(string $key, mixed $values, bool $strict = false)

Фильтрует элементы по заданной паре ключ-значение.

Параметры

string	$key
mixed	$values
bool	$strict

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

EnumeratesValues

EnumeratesValues whereInStrict(string $key, mixed $values)

Фильтрует элементы по заданной паре ключ-значение с использованием строгого сравнения.

Параметры

string	$key
mixed	$values

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

EnumeratesValues

EnumeratesValues whereBetween(string $key, array $values)

Фильтрует элементы, где значение заданного ключа находится между заданными значениями.

Параметры

string	$key
array	$values

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

EnumeratesValues

EnumeratesValues whereNotBetween(string $key, array $values)

Фильтрует элементы, где значение заданного ключа не находится между заданными значениями.

Параметры

string	$key
array	$values

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

EnumeratesValues

EnumeratesValues whereNotIn(string $key, mixed $values, bool $strict = false)

Фильтрует элементы по заданной паре ключ-значение.

Параметры

string	$key
mixed	$values
bool	$strict

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

EnumeratesValues

EnumeratesValues whereNotInStrict(string $key, mixed $values)

Фильтрует элементы по заданной паре ключ-значение с использованием строгого сравнения.

Параметры

string	$key
mixed	$values

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

EnumeratesValues

EnumeratesValues whereInstanceOf(string|string[] $type)

Фильтрует элементы, удаляя те, которые не соответствуют заданному типу(ам).

Параметры

string|string[]

$type

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

EnumeratesValues

mixed pipe(callable $callback)

Передает коллекцию в заданный обратный вызов и возвращает результат.

Параметры

callable

$callback

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

mixed

mixed pipeInto(string $class)

Передает коллекцию в новый класс.

Параметры

string

$class

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

mixed

mixed pipeThrough(callable[] $pipes)

Передает коллекцию через серию вызываемых функций-фильтров и возвращает результат.

Параметры

callable[]

$pipes

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

mixed

$this tap(callable $callback)

Передает коллекцию в заданный обратный вызов, а затем возвращает ее.

Параметры

callable

$callback

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

$this

mixed reduce(callable $callback, mixed $initial = null)

Сводит коллекцию к одному значению.

Параметры

callable	$callback
mixed	$initial

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

mixed

array reduceMany(callable $callback, mixed ...$initial) deprecated

deprecated

Используйте "reduceSpread" вместо этого

Сводит коллекцию к нескольким агрегированным значениям.

Параметры

callable	$callback
mixed	...$initial

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

array

Исключения

UnexpectedValueException

array reduceSpread(callable $callback, mixed ...$initial)

Сводит коллекцию к нескольким агрегированным значениям.

Параметры

callable	$callback
mixed	...$initial

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

array

Исключения

UnexpectedValueException

смешанный тип reduceWithKeys(вызываемый метод $callback, смешанный тип $initial = null)

Свести ассоциативную коллекцию к одному значению.

Параметры

вызываемый метод	$callback
смешанный тип	$initial

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

смешанный тип

EnumeratesValues reject(вызываемый метод|смешанный тип $callback = true)

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

Параметры

вызываемый метод|смешанный тип

$callback

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

EnumeratesValues

EnumeratesValues uniqueStrict(строка|вызываемый метод|null $key = null)

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

Параметры

строка|вызываемый метод|null

$key

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

EnumeratesValues

Collection collect()

Собрать значения в коллекцию.

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

Collection

массив toArray()

Получить коллекцию элементов как обычный массив.

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

массив

массив jsonSerialize()

Преобразовать объект в сериализуемый в JSON.

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

массив

строка toJson(целое число $options = 0)

Получить коллекцию элементов в формате JSON.

Параметры

целое число

$options

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

строка

CachingIterator getCachingIterator(целое число $flags = CachingIterator::CALL_TOSTRING)

Получить экземпляр CachingIterator.

Параметры

целое число

$flags

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

CachingIterator

строка __toString()

Преобразовать коллекцию в строковое представление.

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

строка

$this escapeWhenCastingToString(логическое значение $escape = true)

Указать, что строковое представление модели должно быть экранировано при вызове __toString.

Параметры

логическое значение

$escape

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

$this

статический void proxy(строка $method)

Добавить метод в список проксированных методов.

Параметры

строка

$method

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

void

смешанный тип __get(строка $key)

Динамический доступ к прокси коллекций.

Параметры

строка

$key

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

смешанный тип

Исключения

Исключение

защищённый массив getArrayableItems(смешанный тип $items)

Результат массива элементов из Collection или Arrayable.

Параметры

смешанный тип

$items

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

массив

защищённый Замыкание operatorForWhere(строка $key, строка|null $operator = null, смешанный тип $value = null)

Получить обратный вызов проверки оператора.

Параметры

строка	$key
строка\|null	$operator
смешанный тип	$value

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

Замыкание

защищённый логическое значение useAsCallable(смешанный тип $value)

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

Параметры

смешанный тип

$value

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

логическое значение

защищённый вызываемый метод valueRetriever(вызываемый метод|строка|null $value)

Получить обратный вызов для извлечения значения.

Параметры

вызываемый метод|строка|null

$value

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

вызываемый метод

защищённый Замыкание equality(смешанный тип $value)

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

Параметры

смешанный тип

$value

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

Замыкание

защищённый Замыкание negate(Замыкание $callback)

Создать функцию, используя другую функцию, инвертируя её результат.

Параметры

Замыкание

$callback

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

Замыкание

защищённый Замыкание identity()

Создать функцию, которая возвращает то, что ей передано.

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

Замыкание

статический void macro(строка $name, объект|вызываемый метод $macro)

Зарегистрировать пользовательское макро.

Параметры

строка	$name
объект\|вызываемый метод	$macro

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

void

static void mixin(object $mixin, bool $replace = true)

Смешать другой объект в класс.

Параметры

object	$mixin
bool	$replace

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

void

Исключения

ReflectionException

static bool hasMacro(string $name)

Проверяет, зарегистрирован ли макрос.

Параметры

string

$name

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

bool

static void flushMacros()

Очистить существующие макросы.

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

void

static mixed __callStatic(string $method, array $parameters)

Динамически обработать вызовы к классу.

Параметры

string	$method
array	$parameters

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

mixed

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

Динамически обработать вызовы к классу.

Параметры

string	$method
array	$parameters

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

mixed

Исключения

BadMethodCallException

void __construct(mixed $items = [])

Создать новую коллекцию.

Параметры

mixed

$items

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

void

static Enumerable range(int $from, int $to)

Создать коллекцию с заданным диапазоном.

Параметры

int	$from
int	$to