Перечислимый

интерфейс Перечислимый реализует Arrayable, Countable, IteratorAggregate, Jsonable, JsonSerializable (Просмотреть исходный код)

Методы

массив	toArray() Получить экземпляр в виде массива.	из Arrayable
строка	toJson(int $options = 0) Преобразовать объект в его JSON-представление.	из Jsonable
статический Enumerable	make(mixed $items = []) Создать новый экземпляр коллекции, если значение не является коллекцией.
статический Enumerable	times(int $number, callable $callback = null) Создать новый экземпляр, вызвав заданную функцию заданное количество раз.
статический Enumerable	range(int $from, int $to) Создать коллекцию с заданным диапазоном.
статический Enumerable	wrap(mixed $value) Оборачивает данное значение в коллекцию, если это возможно.
статический массив	unwrap(array\|Enumerable $value) Получить базовые элементы из заданной коллекции, если это возможно.
статический Enumerable	empty() Создать новый экземпляр без элементов.
массив	all() Получить все элементы в перечислимом объекте.
смешанный тип	average(callable\|string\|null $callback = null) Псевдоним для метода "avg".
смешанный тип	median(string\|array\|null $key = null) Получить медиану по заданному ключу.
массив\|null	mode(string\|array\|null $key = null) Получить моду по заданному ключу.
Enumerable	collapse() Сжать элементы в одну коллекцию.
логическое значение	some(mixed $key, mixed $operator = null, mixed $value = null) Псевдоним для метода "contains".
логическое значение	containsStrict(mixed $key, mixed $value = null) Определяет, существует ли элемент, используя строгое сравнение.
смешанный тип	avg(callable\|string\|null $callback = null) Получить среднее значение по заданному ключу.
логическое значение	contains(mixed $key, mixed $operator = null, mixed $value = null) Определяет, существует ли элемент в перечислимом объекте.
Enumerable	crossJoin(mixed ...$lists) Перекрестное соединение с заданными списками, возвращающее все возможные перестановки.
void	dd(mixed ...$args) Вывести коллекцию и завершить сценарий.
$this	dump() Вывести коллекцию.
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) Получить дублируемые элементы, используя строгое сравнение.
$this	each(callable $callback) Выполнить функцию обратного вызова над каждым элементом.
Enumerable	eachSpread(callable $callback) Выполнить функцию обратного вызова над каждым вложенным фрагментом элементов.
логическое значение	every(string\|callable $key, mixed $operator = null, mixed $value = null) Определить, проходят ли все элементы заданный тест истинности.
Enumerable	except(mixed $keys) Получить все элементы, кроме тех, у которых указаны ключи.
Enumerable	filter(callable $callback = null) Применить фильтр к каждому из элементов.
Enumerable\|смешанный тип	when(bool $value, callable $callback, callable $default = null) Применить функцию обратного вызова, если значение истинно.
Enumerable\|смешанный тип	whenEmpty(callable $callback, callable $default = null) Применить функцию обратного вызова, если коллекция пуста.
Enumerable\|смешанный тип	whenNotEmpty(callable $callback, callable $default = null) Применить функцию обратного вызова, если коллекция не пуста.
Enumerable\|смешанный тип	unless(bool $value, callable $callback, callable $default = null) Применить функцию обратного вызова, если значение ложно.
Enumerable\|смешанный тип	unlessEmpty(callable $callback, callable $default = null) Применить функцию обратного вызова, если коллекция не пуста.
Enumerable\|смешанный тип	unlessNotEmpty(callable $callback, callable $default = null) Применить функцию обратного вызова, если коллекция пуста.
Enumerable	where(string $key, mixed $operator = null, mixed $value = null) Отфильтровать элементы по заданной паре ключ-значение.

Enumerable	whereNull(string\|null $key = null) Фильтрует элементы, где значение для заданного ключа равно null.
Enumerable	whereNotNull(string\|null $key = null) Фильтрует элементы, где значение для заданного ключа не равно null.
Enumerable	whereStrict(string $key, mixed $value) Фильтрует элементы по заданной паре ключ-значение с использованием строгого сравнения.
Enumerable	whereIn(string $key, mixed $values, bool $strict = false) Фильтрует элементы по заданной паре ключ-значение.
Enumerable	whereInStrict(string $key, mixed $values) Фильтрует элементы по заданной паре ключ-значение с использованием строгого сравнения.
Enumerable	whereBetween(string $key, array $values) Фильтрует элементы, где значение заданного ключа находится между заданными значениями.
Enumerable	whereNotBetween(string $key, array $values) Фильтрует элементы, где значение заданного ключа не находится между заданными значениями.
Enumerable	whereNotIn(string $key, mixed $values, bool $strict = false) Фильтрует элементы по заданной паре ключ-значение.
Enumerable	whereNotInStrict(string $key, mixed $values) Фильтрует элементы по заданной паре ключ-значение с использованием строгого сравнения.
Enumerable	whereInstanceOf(string\|string[] $type) Фильтрует элементы, удаляя все элементы, которые не соответствуют заданному типу(ам).
mixed	first(callable $callback = null, mixed $default = null) Получить первый элемент из Enumerable, удовлетворяющий заданному условию.
mixed	firstWhere(string $key, mixed $operator = null, mixed $value = null) Получить первый элемент по заданной паре ключ-значение.
Enumerable	flatten(int $depth = INF) Получить сплющенную массив из элементов коллекции.
Enumerable	flip() Поменять местами ключи и значения.
mixed	get(mixed $key, mixed $default = null) Получить элемент из коллекции по ключу.
Enumerable	groupBy(array\|callable\|string $groupBy, bool $preserveKeys = false) Группировать ассоциативный массив по полю или с помощью обратного вызова.
Enumerable	keyBy(callable\|string $keyBy) Установить ключ для ассоциативного массива по полю или с помощью обратного вызова.
bool	has(mixed $key) Определить, существует ли элемент в коллекции по ключу.
string	implode(string $value, string\|null $glue = null) Объединить значения заданного ключа в строку.
Enumerable	intersect(mixed $items) Пересечь коллекцию с заданными элементами.
Enumerable	intersectByKeys(mixed $items) Пересечь коллекцию с заданными элементами по ключу.
bool	isEmpty() Определить, является ли коллекция пустой.
bool	isNotEmpty() Определить, не является ли коллекция пустой.
string	join(string $glue, string $finalGlue = '') Объединить все элементы из коллекции, используя строку. Для последних элементов можно использовать отдельную строку-разделитель.
Enumerable	keys() Получить ключи элементов коллекции.
mixed	last(callable $callback = null, mixed $default = null) Получить последний элемент из коллекции.
Enumerable	map(callable $callback) Применить функцию к каждому элементу.
Enumerable	mapSpread(callable $callback) Применить функцию к каждому вложенному куску элементов.
Enumerable	mapToDictionary(callable $callback) Применить функцию для создания словаря из элементов.
Enumerable	mapToGroups(callable $callback) Применить функцию для группировки элементов.
Enumerable	mapWithKeys(callable $callback) Применить ассоциативное преобразование к каждому элементу.
Enumerable	flatMap(callable $callback) Применить функцию к коллекции и сплющить результат на один уровень.
Enumerable	mapInto(string $class) Применить преобразование к значениям, создавая объекты нового класса.
Enumerable	merge(mixed $items) Объединить коллекцию с заданными элементами.
Enumerable	mergeRecursive(mixed $items) Рекурсивно объединить коллекцию с заданными элементами.
Enumerable	combine(mixed $values) Создать коллекцию, используя текущую коллекцию для ключей и другую для значений.
Enumerable	union(mixed $items) Объединить коллекцию с заданными элементами.
mixed	min(callable\|string\|null $callback = null) Получить минимальное значение по заданному ключу.
mixed	max(callable\|string\|null $callback = null) Получить максимальное значение по заданному ключу.
Enumerable	nth(int $step, int $offset = 0) Создать новую коллекцию, состоящую из каждого n-го элемента.

Enumerable	only(mixed $keys) Получить элементы с указанными ключами.
Enumerable	forPage(int $page, int $perPage) «Разбить на страницы» коллекцию, разделив её на более мелкие коллекции.
Enumerable	partition(callable\|string $key, mixed $operator = null, mixed $value = null) Разделить коллекцию на два массива с помощью заданного обратного вызова или ключа.
Enumerable	concat(iterable $source) Добавить все заданные элементы в коллекцию.
Enumerable\|mixed	random(int\|null $number = null) Получить один или указанное количество элементов случайным образом из коллекции.
mixed	reduce(callable $callback, mixed $initial = null) Свести коллекцию к одному значению.
Enumerable	replace(mixed $items) Заменить элементы коллекции на заданные элементы.
Enumerable	replaceRecursive(mixed $items) Рекурсивно заменить элементы коллекции на заданные элементы.
Enumerable	reverse() Инвертировать порядок элементов.
mixed	search(mixed $value, bool $strict = false) Искать значение в коллекции и возвращать соответствующий ключ, если поиск успешен.
Enumerable	shuffle(int\|null $seed = null) Перемешать элементы в коллекции.
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) Разбить коллекцию на определенное количество групп.
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) Отсортировать коллекцию с помощью заданного обратного вызова.
Enumerable	sortByDesc(callable\|string $callback, int $options = SORT_REGULAR) Отсортировать коллекцию в порядке убывания с помощью заданного обратного вызова.
Enumerable	sortKeys(int $options = SORT_REGULAR, bool $descending = false) Отсортировать ключи коллекции.
Enumerable	sortKeysDesc(int $options = SORT_REGULAR) Отсортировать ключи коллекции в порядке убывания.
mixed	sum(callable\|string\|null $callback = null) Получить сумму заданных значений.
Enumerable	take(int $limit) Взять первые или последние {$limit} элементов.
Enumerable	takeUntil(mixed $value) Взять элементы в коллекции до тех пор, пока не будет выполнено заданное условие.
Enumerable	takeWhile(mixed $value) Взять элементы в коллекции, пока выполняется заданное условие.
$this	tap(callable $callback) Передать коллекцию в заданный обратный вызов, а затем вернуть её.
mixed	pipe(callable $callback) Передать перечислимое в заданный обратный вызов и вернуть результат.
Enumerable	pluck(string\|array $value, string\|null $key = null) Получить значения заданного ключа.
Enumerable	reject(callable\|mixed $callback = true) Создать коллекцию всех элементов, которые не проходят заданную проверку истинности.
Enumerable	unique(string\|callable\|null $key = null, bool $strict = false) Возвратить только уникальные элементы из массива коллекции.
Enumerable	uniqueStrict(string\|callable\|null $key = null) Возвратить только уникальные элементы из массива коллекции, используя строгое сравнение.
Enumerable	values() Сбросить ключи в базовом массиве.
Enumerable	pad(int $size, mixed $value) Заполнить коллекцию до указанной длины значением.
Enumerable	countBy(callable\|null $callback = null) Подсчитать количество элементов в коллекции, используя заданную проверку истинности.
Enumerable	zip(mixed $items) Сжать коллекцию вместе с одним или несколькими массивами.
Collection	collect() Собрать значения в коллекцию.

string	__toString() Преобразовать коллекцию в строковое представление.
static void	proxy(string $method) Добавить метод в список проксируемых методов.
mixed	__get(string $key) Динамический доступ к прокси коллекций.

Подробности

array toArray()

Получить экземпляр в виде массива.

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

array

string toJson(int $options = 0)

Преобразовать объект в его JSON-представление.

Параметры

int

$options

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

string

static Enumerable make(mixed $items = [])

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

Параметры

mixed

$items

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

Enumerable

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

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

Параметры

int	$number
callable	$callback

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

Enumerable

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

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

Параметры

int	$from
int	$to

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

Enumerable

static Enumerable wrap(mixed $value)

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

Параметры

mixed

$value

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

Enumerable

static array unwrap(array|Enumerable $value)

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

Параметры

array|Enumerable

$value

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

array

static Enumerable empty()

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

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

Enumerable

array all()

Получить все элементы в перечислимом.

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

array

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

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

Параметры

callable|string|null

$callback

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

mixed

mixed median(string|array|null $key = null)

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

Параметры

string|array|null

$key

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

mixed

array|null mode(string|array|null $key = null)

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

Параметры

string|array|null

$key

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

array|null

Enumerable collapse()

Свести элементы в единую коллекцию.

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

Enumerable

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

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

Получить среднее значение для заданного ключа.

Параметры

callable|string|null

$callback

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

mixed

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

Определить наличие элемента в перечислимом.

Параметры

mixed	$key
mixed	$operator
mixed	$value

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

bool

Enumerable crossJoin(mixed ...$lists)

Произвести полное соединение с заданными списками, возвращая все возможные перестановки.

Параметры

mixed

...$lists

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

Enumerable

void dd(mixed ...$args)

Вывести коллекцию и завершить выполнение скрипта.

Параметры

mixed

...$args

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

void

$this dump()

Вывести коллекцию.

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

$this

Enumerable diff(mixed $items)

Получить элементы, отсутствующие в заданных элементах.

Parameters

mixed

$items

Return Value

Enumerable

Enumerable diffUsing(mixed $items, callable $callback)

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

Parameters

mixed	$items
callable	$callback

Return Value

Enumerable

Enumerable diffAssoc(mixed $items)

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

Parameters

mixed

$items

Return Value

Enumerable

Enumerable diffAssocUsing(mixed $items, callable $callback)

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

Parameters

mixed	$items
callable	$callback

Return Value

Enumerable

Enumerable diffKeys(mixed $items)

Получить элементы, ключи которых отсутствуют в заданных элементах.

Parameters

mixed

$items

Return Value

Enumerable

Enumerable diffKeysUsing(mixed $items, callable $callback)

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

Parameters

mixed	$items
callable	$callback

Return Value

Enumerable

Enumerable duplicates(callable|string|null $callback = null, bool $strict = false)

Получить дублируемые элементы.

Parameters

callable\|string\|null	$callback
bool	$strict

Return Value

Enumerable

Enumerable duplicatesStrict(callable|string|null $callback = null)

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

Parameters

callable|string|null

$callback

Return Value

Enumerable

$this each(callable $callback)

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

Parameters

callable

$callback

Return Value

$this

Enumerable eachSpread(callable $callback)

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

Parameters

callable

$callback

Return Value

Enumerable

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

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

Parameters

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

Return Value

bool

Enumerable except(mixed $keys)

Получить все элементы, кроме тех, у которых указаны ключи.

Parameters

mixed

$keys

Return Value

Enumerable

Enumerable filter(callable $callback = null)

Применить фильтр к каждому из элементов.

Parameters

callable

$callback

Return Value

Enumerable

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

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

Parameters

bool	$value
callable	$callback
callable	$default

Return Value

Enumerable|mixed

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

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

Parameters

callable	$callback
callable	$default

Return Value

Enumerable|mixed

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

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

Parameters

callable	$callback
callable	$default

Return Value

Enumerable|mixed

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

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

Parameters

bool	$value
callable	$callback
callable	$default

Return Value

Enumerable|mixed

END_OF_DOCUMENT_MARKER

Enumerable|смешанный unlessEmpty(callable $callback, callable $default = null)

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

Параметры

callable	$callback
callable	$default

Значение возврата

Enumerable|смешанный

Enumerable|смешанный unlessNotEmpty(callable $callback, callable $default = null)

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

Параметры

callable	$callback
callable	$default

Значение возврата

Enumerable|смешанный

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

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

Параметры

строка	$key
смешанный	$operator
смешанный	$value

Значение возврата

Enumerable

Enumerable whereNull(string|null $key = null)

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

Параметры

строка|null

$key

Значение возврата

Enumerable

Enumerable whereNotNull(string|null $key = null)

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

Параметры

строка|null

$key

Значение возврата

Enumerable

Enumerable whereStrict(string $key, mixed $value)

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

Параметры

строка	$key
смешанный	$value

Значение возврата

Enumerable

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

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

Параметры

строка	$key
смешанный	$values
bool	$strict

Значение возврата

Enumerable

Enumerable whereInStrict(string $key, mixed $values)

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

Параметры

строка	$key
смешанный	$values

Значение возврата

Enumerable

Enumerable whereBetween(string $key, array $values)

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

Параметры

строка	$key
массив	$values

Значение возврата

Enumerable

Enumerable whereNotBetween(string $key, array $values)

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

Параметры

строка	$key
массив	$values

Значение возврата

Enumerable

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

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

Параметры

строка	$key
смешанный	$values
bool	$strict

Значение возврата

Enumerable

Enumerable whereNotInStrict(string $key, mixed $values)

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

Параметры

строка	$key
смешанный	$values

Значение возврата

Enumerable

Enumerable whereInstanceOf(string|string[] $type)

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

Параметры

строка|массив строк

$type

Значение возврата

Enumerable

смешанный first(callable $callback = null, mixed $default = null)

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

Параметры

callable	$callback
смешанный	$default

Значение возврата

смешанный

смешанный firstWhere(string $key, mixed $operator = null, mixed $value = null)

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

Параметры

строка	$key
смешанный	$operator
смешанный	$value

Значение возврата

смешанный

Enumerable flatten(int $depth = INF)

Получить уплощенную массив элементов в коллекции.

Параметры

целое

$depth

Значение возврата

Enumerable

Enumerable flip()

Перевернуть значения с их ключами.

Значение возврата

Enumerable

mixed get(mixed $key, mixed $default = null)

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

Parameters

mixed	$key
mixed	$default

Return Value

mixed

Enumerable groupBy(array|callable|string $groupBy, bool $preserveKeys = false)

Сгруппировать ассоциативный массив по полю или с помощью обратного вызова.

Parameters

array\|callable\|string	$groupBy
bool	$preserveKeys

Return Value

Enumerable

Enumerable keyBy(callable|string $keyBy)

Установить ключи ассоциативного массива по полю или с помощью обратного вызова.

Parameters

callable|string

$keyBy

Return Value

Enumerable

bool has(mixed $key)

Определить, существует ли элемент в коллекции по ключу.

Parameters

mixed

$key

Return Value

bool

string implode(string $value, string|null $glue = null)

Объединить значения заданного ключа в строку.

Parameters

string	$value
string\|null	$glue

Return Value

string

Enumerable intersect(mixed $items)

Пересечь коллекцию с заданными элементами.

Parameters

mixed

$items

Return Value

Enumerable

Enumerable intersectByKeys(mixed $items)

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

Parameters

mixed

$items

Return Value

Enumerable

bool isEmpty()

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

Return Value

bool

bool isNotEmpty()

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

Return Value

bool

string join(string $glue, string $finalGlue = '')

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

Parameters

string	$glue
string	$finalGlue

Return Value

string

Enumerable keys()

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

Return Value

Enumerable

mixed last(callable $callback = null, mixed $default = null)

Получить последний элемент из коллекции.

Parameters

callable	$callback
mixed	$default

Return Value

mixed

Enumerable map(callable $callback)

Применить отображение к каждому из элементов.

Parameters

callable

$callback

Return Value

Enumerable

Enumerable mapSpread(callable $callback)

Применить отображение к каждому вложенному фрагменту элементов.

Parameters

callable

$callback

Return Value

Enumerable

Enumerable mapToDictionary(callable $callback)

Применить отображение словаря к элементам.

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

Parameters

callable

$callback

Return Value

Enumerable

Enumerable mapToGroups(callable $callback)

Применить групповое отображение к элементам.

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

Parameters

callable

$callback

Return Value

Enumerable

Enumerable mapWithKeys(callable $callback)

Применить ассоциативное отображение к каждому элементу.

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

Parameters

callable

$callback

Return Value

Enumerable

Enumerable flatMap(callable $callback)

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

Parameters

callable

$callback

Return Value

Enumerable

Enumerable mapInto(string $class)

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

Parameters

string

$class

Return Value

Enumerable

Enumerable merge(mixed $items)

Объединить коллекцию с заданными элементами.

Parameters

mixed

$items

Return Value

Enumerable

Enumerable mergeRecursive(mixed $items)

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

Параметры

mixed

$items

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

Enumerable

Enumerable combine(mixed $values)

Создать коллекцию, используя эту коллекцию для ключей и другую для значений.

Параметры

mixed

$values

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

Enumerable

Enumerable union(mixed $items)

Объединить коллекцию с заданными элементами.

Параметры

mixed

$items

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

Enumerable

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

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

Параметры

callable|string|null

$callback

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

mixed

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

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

Параметры

callable|string|null

$callback

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

mixed

Enumerable nth(int $step, int $offset = 0)

Создать новую коллекцию, состоящую из каждого n-го элемента.

Параметры

int	$step
int	$offset

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

Enumerable

Enumerable only(mixed $keys)

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

Параметры

mixed

$keys

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

Enumerable

Enumerable forPage(int $page, int $perPage)

«Пейджировать» коллекцию, разделив её на меньшие коллекции.

Параметры

int	$page
int	$perPage

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

Enumerable

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

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

Параметры

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

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

Enumerable

Enumerable concat(iterable $source)

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

Параметры

iterable

$source

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

Enumerable

Enumerable|mixed random(int|null $number = null)

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

Параметры

int|null

$number

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

Enumerable|mixed

Исключения

InvalidArgumentException

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

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

Параметры

callable	$callback
mixed	$initial

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

mixed

Enumerable replace(mixed $items)

Заменить элементы коллекции на заданные.

Параметры

mixed

$items

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

Enumerable

Enumerable replaceRecursive(mixed $items)

Рекурсивно заменить элементы коллекции на заданные.

Параметры

mixed

$items

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

Enumerable

Enumerable reverse()

Перевернуть порядок элементов.

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

Enumerable

mixed search(mixed $value, bool $strict = false)

Найти значение в коллекции и вернуть соответствующий ключ, если поиск успешен.

Параметры

mixed	$value
bool	$strict

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

mixed

Enumerable shuffle(int|null $seed = null)

Перемешать элементы в коллекции.

Параметры

int|null

$seed

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

Enumerable

Enumerable skip(int $count)

Пропустить первые {$count} элементов.

Параметры

int

$count

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

Enumerable

Enumerable skipUntil(mixed $value)

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

Параметры

mixed

$value

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

Enumerable

Enumerable skipWhile(mixed $value)

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

Параметры

mixed

$value

Значение результата

Enumerable

Enumerable slice(int $offset, int|null $length = null)

Получить фрагмент элементов из перечислимого набора.

Параметры

int	$offset
int\|null	$length

Значение результата

Enumerable

Enumerable split(int $numberOfGroups)

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

Параметры

int

$numberOfGroups

Значение результата

Enumerable

Enumerable chunk(int $size)

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

Параметры

int

$size

Значение результата

Enumerable

Enumerable chunkWhile(callable $callback)

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

Параметры

callable

$callback

Значение результата

Enumerable

Enumerable sort(callable|null|int $callback = null)

Отсортировать каждый элемент с помощью обратного вызова.

Параметры

callable|null|int

$callback

Значение результата

Enumerable

Enumerable sortDesc(int $options = SORT_REGULAR)

Отсортировать элементы в порядке убывания.

Параметры

int

$options

Значение результата

Enumerable

Enumerable sortBy(callable|string $callback, int $options = SORT_REGULAR, bool $descending = false)

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

Параметры

callable\|string	$callback
int	$options
bool	$descending

Значение результата

Enumerable

Enumerable sortByDesc(callable|string $callback, int $options = SORT_REGULAR)

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

Параметры

callable\|string	$callback
int	$options

Значение результата

Enumerable

Enumerable sortKeys(int $options = SORT_REGULAR, bool $descending = false)

Отсортировать ключи коллекции.

Параметры

int	$options
bool	$descending

Значение результата

Enumerable

Enumerable sortKeysDesc(int $options = SORT_REGULAR)

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

Параметры

int

$options

Значение результата

Enumerable

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

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

Параметры

callable|string|null

$callback

Значение результата

mixed

Enumerable take(int $limit)

Взять первые или последние {$limit} элементы.

Параметры

int

$limit

Значение результата

Enumerable

Enumerable takeUntil(mixed $value)

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

Параметры

mixed

$value

Значение результата

Enumerable

Enumerable takeWhile(mixed $value)

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

Параметры

mixed

$value

Значение результата

Enumerable

$this tap(callable $callback)

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

Параметры

callable

$callback

Значение результата

$this

mixed pipe(callable $callback)

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

Параметры

callable

$callback

Значение результата

mixed

Enumerable pluck(string|array $value, string|null $key = null)

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

Параметры

string\|array	$value
string\|null	$key

Значение результата

Enumerable

Enumerable reject(callable|mixed $callback = true)

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

Параметры

callable|mixed

$callback

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

Enumerable

Enumerable unique(string|callable|null $key = null, bool $strict = false)

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

Параметры

string\|callable\|null	$key
bool	$strict

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

Enumerable

Enumerable uniqueStrict(string|callable|null $key = null)

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

Параметры

string|callable|null

$key

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

Enumerable

Enumerable values()

Сбросить ключи в базовом массиве.

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

Enumerable

Enumerable pad(int $size, mixed $value)

Заполнить коллекцию до указанной длины заданным значением.

Параметры

int	$size
mixed	$value

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

Enumerable

Enumerable countBy(callable|null $callback = null)

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

Параметры

callable|null

$callback

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

Enumerable

Enumerable zip(mixed $items)

Объединить коллекцию с одним или несколькими массивами.

Например: new Collection([1, 2, 3])->zip([4, 5, 6]); => [[1, 4], [2, 5], [3, 6]]

Параметры

mixed

$items

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

Enumerable

Collection collect()

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

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

Collection

string __toString()

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

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

string

static void proxy(string $method)

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

Параметры

string

$method

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

void

mixed __get(string $key)

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

Параметры

string

$key

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

mixed

Исключения

Exception

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Support/Enumerable.html