Enumerable

интерфейс Enumerable реализует Arrayable, Countable, IteratorAggregate, Jsonable, JsonSerializable (View source)

Методы

toArray() Без описания
строка	toJson(int $options = 0) Получить коллекцию элементов в формате JSON.
статический	make($items = []) Без описания
статический Enumerable	times(int $number, callable $callback = null) Создать новый экземпляр, вызвав обратный вызов заданное количество раз.
статический Enumerable	range(int $from, int $to) Создать коллекцию с заданным диапазоном.
статический	wrap($value) Без описания
статический	unwrap($value) Без описания
статический Enumerable	empty() Создать новый экземпляр без элементов.
массив	all() Получить все элементы в перечислимом объекте.
число с плавающей точкой\|целое число\|null	average($callback = null) Псевдоним для метода "avg".
число с плавающей точкой\|целое число\|null	median(string\|array<array-key,string>\|null $key = null) Получить медиану для заданного ключа.
массив<int,число с плавающей точкой\|целое число>\|null	mode(string\|array<array-key,string>\|null $key = null) Получить моду для заданного ключа.
collapse() Без описания
логическое значение	some($key, mixed $operator = null, mixed $value = null) Псевдоним для метода "contains".
логическое значение	containsStrict($key, TValue\|null $value = null) Определить, существует ли элемент, используя строгое сравнение.
число с плавающей точкой\|целое число\|null	avg($callback = null) Получить среднее значение для заданного ключа.
логическое значение	contains($key, mixed $operator = null, mixed $value = null) Определить, существует ли элемент в перечислимом объекте.
логическое значение	doesntContain(mixed $key, mixed $operator = null, mixed $value = null) Определить, не содержит ли коллекция элемент.
crossJoin(...$lists) Без описания
never	dd(mixed ...$args) Вывести коллекцию и завершить скрипт.
$this	dump() Вывести коллекцию.
Enumerable	diff(TValue>\|TValue> $items) Получить элементы, отсутствующие в заданных элементах.
Enumerable	diffUsing(TValue>\|TValue> $items, callable $callback) Получить элементы, отсутствующие в заданных элементах, используя обратный вызов.
Enumerable	diffAssoc(TValue>\|TValue> $items) Получить элементы, у которых ключи и значения отсутствуют в заданных элементах.
Enumerable	diffAssocUsing(TValue>\|TValue> $items, callable $callback) Получить элементы, у которых ключи и значения отсутствуют в заданных элементах, используя обратный вызов.
Enumerable	diffKeys(TValue>\|TValue> $items) Получить элементы, у которых ключи отсутствуют в заданных элементах.
Enumerable	diffKeysUsing(TValue>\|TValue> $items, callable $callback) Получить элементы, у которых ключи отсутствуют в заданных элементах, используя обратный вызов.
Enumerable	duplicates($callback = null, bool $strict = false) Получить дублируемые элементы.
Enumerable	duplicatesStrict($callback = null) Получить дублируемые элементы, используя строгое сравнение.
$this	each(callable $callback) Выполнить обратный вызов над каждым элементом.
Enumerable	eachSpread(callable $callback) Выполнить обратный вызов над каждым вложенным блоком элементов.
логическое значение	every($key, mixed $operator = null, mixed $value = null) Определить, удовлетворяют ли все элементы заданному условию истинности.
Enumerable	except(TKey>\|TKey> $keys) Получить все элементы, за исключением тех, у которых указаны ключи.
Enumerable	filter(callable $callback = null) Применить фильтр к каждому элементу.
$this\|TWhenReturnType	when(bool $value, callable $callback = null, callable $default = null) Применить обратный вызов, если заданное «значение» истинно.
$this\|TWhenEmptyReturnType	whenEmpty(callable $callback, callable $default = null) Применить обратный вызов, если коллекция пуста.
$this\|TWhenNotEmptyReturnType	whenNotEmpty(callable $callback, callable $default = null) Применить обратный вызов, если коллекция не пуста.
$this\|TUnlessReturnType	unless(bool $value, callable $callback, callable $default = null) Применить обратный вызов, если заданное «значение» истинно.
$this\|TUnlessEmptyReturnType	unlessEmpty(callable $callback, callable $default = null) Применить обратный вызов, если коллекция не пуста.
$this\|TUnlessNotEmptyReturnType	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.

Перечисляемый	whereStrict(string $key, mixed $value) Фильтрация элементов по заданной паре ключ-значение с использованием строгого сравнения.
Перечисляемый	whereIn(string $key, Массивный\|iterable $values, bool $strict = false) Фильтрация элементов по заданной паре ключ-значение.
Перечисляемый	whereInStrict(string $key, Массивный\|iterable $values) Фильтрация элементов по заданной паре ключ-значение с использованием строгого сравнения.
Перечисляемый	whereBetween(string $key, Массивный\|iterable $values) Фильтрация элементов таким образом, чтобы значение заданного ключа находилось между заданными значениями.
Перечисляемый	whereNotBetween(string $key, Массивный\|iterable $values) Фильтрация элементов таким образом, чтобы значение заданного ключа не находилось между заданными значениями.
Перечисляемый	whereNotIn(string $key, Массивный\|iterable $values, bool $strict = false) Фильтрация элементов по заданной паре ключ-значение.
Перечисляемый	whereNotInStrict(string $key, Массивный\|iterable $values) Фильтрация элементов по заданной паре ключ-значение с использованием строгого сравнения.
whereInstanceOf($type) Без описания
first(callable $callback = null, $default = null) Без описания
TValue\|null	firstWhere(string $key, mixed $operator = null, mixed $value = null) Получение первого элемента по заданной паре ключ-значение.
Перечисляемый	flatten(int $depth = INF) Получение плоского массива элементов коллекции.
flip() Без описания
get($key, $default = null) Без описания
groupBy($groupBy, $preserveKeys = false) Без описания
keyBy($keyBy) Без описания
bool	has(TKey\|TKey> $key) Определение наличия элемента в коллекции по ключу.
bool	hasAny(mixed $key) Определение наличия любого из ключей в коллекции.
string	implode(callable\|string $value, string\|null $glue = null) Конкатенация значений заданного ключа в строку.
Перечисляемый	intersect(TValue>\|TValue> $items) Пересечение коллекции с заданными элементами.
Перечисляемый	intersectByKeys(TValue>\|TValue> $items) Пересечение коллекции с заданными элементами по ключу.
bool	isEmpty() Определение пустоты коллекции.
bool	isNotEmpty() Определение непустоты коллекции.
bool	containsOneItem() Определение наличия в коллекции одного элемента.
string	join(string $glue, string $finalGlue = '') Объединение всех элементов коллекции с помощью строки. Для последних элементов можно использовать отдельную строку-разделитель.
keys() Без описания
last(callable $callback = null, $default = null) Без описания
map(callable $callback) Без описания
Перечисляемый	mapSpread(callable $callback) Применение отображения к каждому вложенному блоку элементов.
mapToDictionary(callable $callback) Без описания
mapToGroups(callable $callback) Без описания
mapWithKeys(callable $callback) Без описания
flatMap(callable $callback) Без описания
mapInto($class) Без описания
Перечисляемый	merge(TValue>\|TValue> $items) Объединение коллекции с заданными элементами.
mergeRecursive($items) Без описания
combine($values) Без описания
Перечисляемый	union(TValue>\|TValue> $items) Объединение коллекции с заданными элементами.
mixed	min($callback = null) Получение минимального значения заданного ключа.
mixed	max($callback = null) Получение максимального значения заданного ключа.
Перечисляемый	nth(int $step, int $offset = 0) Создание новой коллекции, содержащей каждый n-ый элемент.
Перечисляемый	only(TKey>\|TKey>\|string $keys) Получение элементов со списком ключей.
Перечисляемый	forPage(int $page, int $perPage) «Пагинация» коллекции путем разбиения на более мелкие подколлекции.
partition($key, $operator = null, $value = null) Без описания
concat($source) Без описания
random($number = null) Без описания
TReduceReturnType	reduce(callable $callback, TReduceInitial $initial = null) Сведение коллекции к одному значению.

array	reduceSpread(callable $callback, mixed ...$initial) Свести коллекцию к нескольким агрегированным значениям.
Enumerable	replace(TValue>\|TValue> $items) Заменить элементы коллекции заданными элементами.
Enumerable	replaceRecursive(TValue>\|TValue> $items) Рекурсивно заменить элементы коллекции заданными элементами.
Enumerable	reverse() Изменить порядок элементов на обратный.
TKey\|bool	search($value, bool $strict = false) Найти в коллекции заданное значение и вернуть соответствующий ключ, если поиск успешен.
Enumerable	shuffle(int\|null $seed = null) Перемешать элементы в коллекции.
sliding($size = 2, $step = 1) Без описания
Enumerable	skip(int $count) Пропустить первые {$count} элементов.
Enumerable	skipUntil($value) Пропустить элементы в коллекции до тех пор, пока не будет выполнено заданное условие.
Enumerable	skipWhile($value) Пропустить элементы в коллекции, пока выполняется заданное условие.
Enumerable	slice(int $offset, int\|null $length = null) Получить срез элементов из перечислимого объекта.
split($numberOfGroups) Без описания
TValue	sole($key = null, mixed $operator = null, mixed $value = null) Получить первый элемент в коллекции, но только если элементов ровно один. В противном случае выбросить исключение.
TValue	firstOrFail($key = null, mixed $operator = null, mixed $value = null) Получить первый элемент в коллекции, но выбросить исключение, если соответствующие элементы отсутствуют.
chunk($size) Без описания
chunkWhile(callable $callback) Без описания
splitIn($numberOfGroups) Без описания
Enumerable	sort($callback = null) Сортировать элементы с помощью обратного вызова.
Enumerable	sortDesc(int $options = SORT_REGULAR) Сортировать элементы в порядке убывания.
Enumerable	sortBy($callback, int $options = SORT_REGULAR, bool $descending = false) Сортировать коллекцию с помощью заданного обратного вызова.
Enumerable	sortByDesc($callback, int $options = SORT_REGULAR) Сортировать коллекцию в порядке убывания с использованием заданного обратного вызова.
Enumerable	sortKeys(int $options = SORT_REGULAR, bool $descending = false) Сортировать ключи коллекции.
Enumerable	sortKeysDesc(int $options = SORT_REGULAR) Сортировать ключи коллекции в порядке убывания.
Enumerable	sortKeysUsing(callable $callback) Сортировать ключи коллекции с помощью обратного вызова.
mixed	sum($callback = null) Получить сумму заданных значений.
Enumerable	take(int $limit) Взять первые или последние {$limit} элементов.
Enumerable	takeUntil($value) Взять элементы в коллекции до тех пор, пока не будет выполнено заданное условие.
Enumerable	takeWhile($value) Взять элементы в коллекции, пока выполняется заданное условие.
$this	tap(callable $callback) Передать коллекцию в заданный обратный вызов, а затем вернуть ее.
TPipeReturnType	pipe(callable $callback) Передать перечислимый объект в заданный обратный вызов и вернуть результат.
TPipeIntoValue	pipeInto(TPipeIntoValue> $class) Передать коллекцию в новый класс.
mixed	pipeThrough(callable[] $pipes) Передать коллекцию через серию вызовов обратных функций и вернуть результат.
pluck($value, $key = null) Без описания
Enumerable	reject($callback = true) Создать коллекцию всех элементов, которые не удовлетворяют заданному логическому тесту.
Enumerable	undot() Преобразовать плоский массив с нотацией «точка» в расширенный массив.
Enumerable	unique($key = null, bool $strict = false) Возвратить только уникальные элементы из массива коллекции.
Enumerable	uniqueStrict($key = null) Возвратить только уникальные элементы из массива коллекции с использованием строгого сравнения.
values() Без описания
pad($size, $value) Без описания
Traversable	getIterator() Получить итератор значений.
int	count() Подсчитать количество элементов в коллекции.
countBy($countBy = null) Без описания
zip($items) Без описания
TValue>	collect() Собрать значения в коллекцию.
mixed	jsonSerialize() Преобразовать объект в сериализуемый JSON.

CachingIterator	getCachingIterator(int $flags = CachingIterator::CALL_TOSTRING) Получить экземпляр CachingIterator.
строка	__toString() Преобразовать коллекцию в строковое представление.
$this	escapeWhenCastingToString(bool $escape = true) Указать, что строковое представление модели должно быть экранировано при вызове __toString.
статический void	proxy(string $method) Добавить метод в список проксируемых методов.
смешанный тип	__get(string $key) Динамичный доступ к прокси коллекций.

Подробности

toArray()

Без описания

строка toJson(int $options = 0)

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

Параметры

int

$options

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

строка

статический make($items = [])

Без описания

Параметры

$items

статический Enumerable times(int $number, callable $callback = null)

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

Параметры

int	$number
callable	$callback

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

Enumerable

статический Enumerable range(int $from, int $to)

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

Параметры

int	$from
int	$to

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

Enumerable

статический wrap($value)

Без описания

Параметры

$value

статический unwrap($value)

Без описания

Параметры

$value

статический Enumerable empty()

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

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

Enumerable

массив all()

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

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

массив

число с плавающей точкой|целое число|null average($callback = null)

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

Параметры

$callback

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

число с плавающей точкой|целое число|null

число с плавающей точкой|целое число|null median(string|array<array-key,string>|null $key = null)

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

Параметры

string|array<array-key,string>|null

$key

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

число с плавающей точкой|целое число|null

массив<int,число с плавающей точкой|целое число>|null mode(string|array<array-key,string>|null $key = null)

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

Параметры

string|array<array-key,string>|null

$key

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

массив<int,число с плавающей точкой|целое число>|null

collapse()

Без описания

логическое значение some($key, mixed $operator = null, mixed $value = null)

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

Параметры

	$key
смешанный тип	$operator
смешанный тип	$value

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

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

логическое значение containsStrict($key, TValue|null $value = null)

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

Параметры

	$key
TValue\|null	$value

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

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

число с плавающей точкой|целое число|null avg($callback = null)

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

Параметры

$callback

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

число с плавающей точкой|целое число|null

логическое значение contains($key, mixed $operator = null, mixed $value = null)

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

Параметры

	$key
смешанный тип	$operator
смешанный тип	$value

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

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

логическое значение doesntContain(mixed $key, mixed $operator = null, mixed $value = null)

Определить, не содержит ли коллекция элемент.

Параметры

смешанный тип	$key
смешанный тип	$operator
смешанный тип	$value

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

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

crossJoin(...$lists)

Без описания

Параметры

...$lists

никогда dd(mixed ...$args)

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

Параметры

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

...$args

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

никогда

$this dump()

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

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

$this

Enumerable diff(TValue>|TValue> $items)

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

Parameters

TValue>|TValue>

$items

Return Value

Enumerable

Enumerable diffUsing(TValue>|TValue> $items, callable $callback)

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

Parameters

TValue>\|TValue>	$items
callable	$callback

Return Value

Enumerable

Enumerable diffAssoc(TValue>|TValue> $items)

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

Parameters

TValue>|TValue>

$items

Return Value

Enumerable

Enumerable diffAssocUsing(TValue>|TValue> $items, callable $callback)

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

Parameters

TValue>\|TValue>	$items
callable	$callback

Return Value

Enumerable

Enumerable diffKeys(TValue>|TValue> $items)

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

Parameters

TValue>|TValue>

$items

Return Value

Enumerable

Enumerable diffKeysUsing(TValue>|TValue> $items, callable $callback)

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

Parameters

TValue>\|TValue>	$items
callable	$callback

Return Value

Enumerable

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

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

Parameters

	$callback
bool	$strict

Return Value

Enumerable

Enumerable duplicatesStrict($callback = null)

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

Parameters

$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($key, mixed $operator = null, mixed $value = null)

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

Parameters

	$key
mixed	$operator
mixed	$value

Return Value

bool

Enumerable except(TKey>|TKey> $keys)

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

Parameters

TKey>|TKey>

$keys

Return Value

Enumerable

Enumerable filter(callable $callback = null)

Запустить фильтр над каждым из элементов.

Parameters

callable

$callback

Return Value

Enumerable

$this|TWhenReturnType when(bool $value, callable $callback = null, callable $default = null)

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

Parameters

bool	$value
callable	$callback
callable	$default

Return Value

$this|TWhenReturnType

$this|TWhenEmptyReturnType whenEmpty(callable $callback, callable $default = null)

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

Parameters

callable	$callback
callable	$default

Return Value

$this|TWhenEmptyReturnType

$this|TWhenNotEmptyReturnType whenNotEmpty(callable $callback, callable $default = null)

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

Parameters

callable	$callback
callable	$default

Return Value

$this|TWhenNotEmptyReturnType

$this|TUnlessReturnType unless(bool $value, callable $callback, callable $default = null)

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

Parameters

bool	$value
callable	$callback
callable	$default

Return Value

$this|TUnlessReturnType

$this|TUnlessEmptyReturnType unlessEmpty(callable $callback, callable $default = null)

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

Parameters

callable	$callback
callable	$default

Return Value

$this|TUnlessEmptyReturnType

END_OF_DOCUMENT_MARKER

$this|TUnlessNotEmptyReturnType unlessNotEmpty(callable $callback, callable $default = null)

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

Параметры

callable	$callback
callable	$default

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

$this|TUnlessNotEmptyReturnType

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

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

Параметры

string	$key
mixed	$operator
mixed	$value

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

Enumerable

Enumerable whereNull(string|null $key = null)

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

Параметры

string|null

$key

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

Enumerable

Enumerable whereNotNull(string|null $key = null)

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

Параметры

string|null

$key

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

Enumerable

Enumerable whereStrict(string $key, mixed $value)

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

Параметры

string	$key
mixed	$value

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

Enumerable

Enumerable whereIn(string $key, Arrayable|iterable $values, bool $strict = false)

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

Параметры

string	$key
Arrayable\|iterable	$values
bool	$strict

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

Enumerable

Enumerable whereInStrict(string $key, Arrayable|iterable $values)

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

Параметры

string	$key
Arrayable\|iterable	$values

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

Enumerable

Enumerable whereBetween(string $key, Arrayable|iterable $values)

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

Параметры

string	$key
Arrayable\|iterable	$values

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

Enumerable

Enumerable whereNotBetween(string $key, Arrayable|iterable $values)

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

Параметры

string	$key
Arrayable\|iterable	$values

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

Enumerable

Enumerable whereNotIn(string $key, Arrayable|iterable $values, bool $strict = false)

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

Параметры

string	$key
Arrayable\|iterable	$values
bool	$strict

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

Enumerable

Enumerable whereNotInStrict(string $key, Arrayable|iterable $values)

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

Параметры

string	$key
Arrayable\|iterable	$values

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

Enumerable

whereInstanceOf($type)

Описание отсутствует

Параметры

$type

first(callable $callback = null, $default = null)

Описание отсутствует

Параметры

callable	$callback
	$default

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

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

Параметры

string	$key
mixed	$operator
mixed	$value

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

TValue|null

Enumerable flatten(int $depth = INF)

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

Параметры

int

$depth

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

Enumerable

flip()

Описание отсутствует

get($key, $default = null)

Описание отсутствует

Параметры

	$key
	$default

groupBy($groupBy, $preserveKeys = false)

Без описания

Параметры

	$groupBy
	$preserveKeys

keyBy($keyBy)

Без описания

Параметры

$keyBy

bool has(TKey|TKey> $key)

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

Параметры

TKey|TKey>

$key

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

bool

bool hasAny(mixed $key)

Определить, существуют ли какие-либо ключи в коллекции.

Параметры

mixed

$key

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

bool

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

Конкатенация значений заданного ключа в строку.

Параметры

callable\|string	$value
string\|null	$glue

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

string

Enumerable intersect(TValue>|TValue> $items)

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

Параметры

TValue>|TValue>

$items

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

Enumerable

Enumerable intersectByKeys(TValue>|TValue> $items)

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

Параметры

TValue>|TValue>

$items

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

Enumerable

bool isEmpty()

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

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

bool

bool isNotEmpty()

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

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

bool

bool containsOneItem()

Определить, содержит ли коллекция один элемент.

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

bool

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

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

Параметры

string	$glue
string	$finalGlue

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

string

keys()

Без описания

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

Без описания

Параметры

callable	$callback
	$default

map(callable $callback)

Без описания

Параметры

callable

$callback

Enumerable mapSpread(callable $callback)

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

Параметры

callable

$callback

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

Enumerable

mapToDictionary(callable $callback)

Без описания

Параметры

callable

$callback

mapToGroups(callable $callback)

Без описания

Параметры

callable

$callback

mapWithKeys(callable $callback)

Без описания

Параметры

callable

$callback

flatMap(callable $callback)

Без описания

Параметры

callable

$callback

mapInto($class)

Без описания

Параметры

$class

Enumerable merge(TValue>|TValue> $items)

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

Параметры

TValue>|TValue>

$items

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

Enumerable

mergeRecursive($items)

Без описания

Параметры

$items

combine($values)

Без описания

Параметры

$values

Enumerable union(TValue>|TValue> $items)

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

Параметры

TValue>|TValue>

$items

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

Enumerable

mixed min($callback = null)

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

Параметры

$callback

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

mixed

mixed max($callback = null)

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

Parameters

$callback

Return Value

mixed

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

Создать новый набор, состоящий из каждого n-го элемента.

Parameters

int	$step
int	$offset

Return Value

Enumerable

Enumerable only(TKey>|TKey>|string $keys)

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

Parameters

TKey>|TKey>|string

$keys

Return Value

Enumerable

Enumerable forPage(int $page, int $perPage)

Разбить коллекцию на меньшие подколлекции, как бы "странируя" её.

Parameters

int	$page
int	$perPage

Return Value

Enumerable

partition($key, $operator = null, $value = null)

Без описания

Parameters

	$key
	$operator
	$value

concat($source)

Без описания

Parameters

$source

random($number = null)

Без описания

Parameters

$number

TReduceReturnType reduce(callable $callback, TReduceInitial $initial = null)

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

Parameters

callable	$callback
TReduceInitial	$initial

Return Value

TReduceReturnType

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

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

Parameters

callable	$callback
mixed	...$initial

Return Value

array

Exceptions

UnexpectedValueException

Enumerable replace(TValue>|TValue> $items)

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

Parameters

TValue>|TValue>

$items

Return Value

Enumerable

Enumerable replaceRecursive(TValue>|TValue> $items)

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

Parameters

TValue>|TValue>

$items

Return Value

Enumerable

Enumerable reverse()

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

Return Value

Enumerable

TKey|bool search($value, bool $strict = false)

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

Parameters

	$value
bool	$strict

Return Value

TKey|bool

Enumerable shuffle(int|null $seed = null)

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

Parameters

int|null

$seed

Return Value

Enumerable

sliding($size = 2, $step = 1)

Без описания

Parameters

	$size
	$step

Enumerable skip(int $count)

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

Parameters

int

$count

Return Value

Enumerable

Enumerable skipUntil($value)

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

Parameters

$value

Return Value

Enumerable

Enumerable skipWhile($value)

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

Parameters

$value

Return Value

Enumerable

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

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

Parameters

int	$offset
int\|null	$length

Return Value

Enumerable

split($numberOfGroups)

Без описания

Parameters

$numberOfGroups

TValue sole($key = null, mixed $operator = null, mixed $value = null)

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

Параметры

	$key
mixed	$operator
mixed	$value

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

TValue

Исключения

ItemNotFoundException
MultipleItemsFoundException

TValue firstOrFail($key = null, mixed $operator = null, mixed $value = null)

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

Параметры

	$key
mixed	$operator
mixed	$value

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

TValue

Исключения

ItemNotFoundException

chunk($size)

Без описания

Параметры

$size

chunkWhile(callable $callback)

Без описания

Параметры

callable

$callback

splitIn($numberOfGroups)

Без описания

Параметры

$numberOfGroups

Enumerable sort($callback = null)

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

Параметры

$callback

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

Enumerable

Enumerable sortDesc(int $options = SORT_REGULAR)

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

Параметры

int

$options

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

Enumerable

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

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

Параметры

	$callback
int	$options
bool	$descending

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

Enumerable

Enumerable sortByDesc($callback, int $options = SORT_REGULAR)

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

Параметры

	$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

Enumerable sortKeysUsing(callable $callback)

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

Параметры

callable

$callback

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

Enumerable

mixed sum($callback = null)

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

Параметры

$callback

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

mixed

Enumerable take(int $limit)

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

Параметры

int

$limit

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

Enumerable

Enumerable takeUntil($value)

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

Параметры

$value

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

Enumerable

Enumerable takeWhile($value)

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

Параметры

$value

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

Enumerable

$this tap(callable $callback)

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

Параметры

callable

$callback

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

$this

TPipeReturnType pipe(callable $callback)

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

Параметры

callable

$callback

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

TPipeReturnType

TPipeIntoValue pipeInto(TPipeIntoValue> $class)

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

Параметры

TPipeIntoValue>

$class

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

TPipeIntoValue

END_OF_DOCUMENT_MARKER

mixed pipeThrough(callable[] $pipes)

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

Parameters

callable[]

$pipes

Return Value

mixed

pluck($value, $key = null)

Описание отсутствует

Parameters

	$value
	$key

Enumerable reject($callback = true)

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

Parameters

$callback

Return Value

Enumerable

Enumerable undot()

Преобразовать массив с использованием нотации "точка" в расширенный массив.

Return Value

Enumerable

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

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

Parameters

	$key
bool	$strict

Return Value

Enumerable

Enumerable uniqueStrict($key = null)

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

Parameters

$key

Return Value

Enumerable

values()

Описание отсутствует

pad($size, $value)

Описание отсутствует

Parameters

	$size
	$value

Traversable getIterator()

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

Return Value

Traversable

int count()

Подсчитать количество элементов в коллекции.

Return Value

int

countBy($countBy = null)

Описание отсутствует

Parameters

$countBy

zip($items)

Описание отсутствует

Parameters

$items

TValue> collect()

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

Return Value

TValue>

mixed jsonSerialize()

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

Return Value

mixed

CachingIterator getCachingIterator(int $flags = CachingIterator::CALL_TOSTRING)

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

Parameters

int

$flags

Return Value

CachingIterator

string __toString()

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

Return Value

string

$this escapeWhenCastingToString(bool $escape = true)

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

Parameters

bool

$escape

Return Value

$this

static void proxy(string $method)

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

Parameters

string

$method

Return Value

void

mixed __get(string $key)

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

Parameters

string

$key

Return Value

mixed

Exceptions

Exception

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