Enumerable

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

Методы

toArray() Нет описания
string	toJson(int $options = 0) Получить коллекцию элементов в формате JSON.
static	make($items = []) Нет описания
static Enumerable	times(int $number, callable\|null $callback = null) Создать новый экземпляр, вызвав обратный вызов заданное количество раз.
static Enumerable	range(int $from, int $to) Создать коллекцию с заданным диапазоном.
static	wrap($value) Нет описания
static	unwrap($value) Нет описания
static Enumerable	empty() Создать новый экземпляр без элементов.
array	all() Получить все элементы в перечисляемом объекте.
float\|int\|null	average($callback = null) Псевдоним для метода "avg".
float\|int\|null	median(string\|array<array-key,string>\|null $key = null) Получить медиану заданного ключа.
array<int,float\|int>\|null	mode(string\|array<array-key,string>\|null $key = null) Получить моду заданного ключа.
collapse() Нет описания
bool	some($key, mixed $operator = null, mixed $value = null) Псевдоним для метода "contains".
bool	containsStrict($key, TValue\|null $value = null) Определить, существует ли элемент, используя строгое сравнение.
float\|int\|null	avg($callback = null) Получить среднее значение заданного ключа.
bool	contains($key, mixed $operator = null, mixed $value = null) Определить, существует ли элемент в перечисляемом объекте.
bool	doesntContain(mixed $key, mixed $operator = null, mixed $value = null) Определить, не содержится ли элемент в коллекции.
crossJoin(...$lists) Нет описания
never	dd(mixed ...$args) Вывести коллекцию и завершить скрипт.
$this	dump(mixed ...$args) Вывести коллекцию.
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) Выполнить обратный вызов для каждого вложенного фрагмента элементов.
bool	every($key, mixed $operator = null, mixed $value = null) Определить, проходят ли все элементы заданный тест истинности.
Enumerable	except(TKey>\|TKey> $keys) Получить все элементы, кроме тех, у которых указанные ключи.
Enumerable	filter(callable\|null $callback = null) Запустить фильтр для каждого из элементов.
$this\|TWhenReturnType	when(bool $value, callable\|null $callback = null, callable\|null $default = null) Применить обратный вызов, если данное "значение" истинно (или разрешается как истинное).
$this\|TWhenEmptyReturnType	whenEmpty(callable $callback, callable\|null $default = null) Применить обратный вызов, если коллекция пуста.
$this\|TWhenNotEmptyReturnType	whenNotEmpty(callable $callback, callable\|null $default = null) Применить обратный вызов, если коллекция не пуста.
$this\|TUnlessReturnType	unless(bool $value, callable $callback, callable\|null $default = null) Применить обратный вызов, если данное "значение" истинно (или разрешается как истинное).
$this\|TUnlessEmptyReturnType	unlessEmpty(callable $callback, callable\|null $default = null) Применить обратный вызов, если коллекция не пуста.
$this\|TUnlessNotEmptyReturnType	unlessNotEmpty(callable $callback, callable\|null $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, Arrayable\|iterable $values, bool $strict = false) Фильтровать элементы по заданной паре ключ-значение.
Enumerable	whereInStrict(string $key, Arrayable\|iterable $values) Фильтровать элементы по заданной паре ключ-значение, используя строгое сравнение.
Enumerable	whereBetween(string $key, Arrayable\|iterable $values) Фильтровать элементы таким образом, чтобы значение заданного ключа находилось между заданными значениями.
Enumerable	whereNotBetween(string $key, Arrayable\|iterable $values) Фильтровать элементы таким образом, чтобы значение заданного ключа не находилось между заданными значениями.
Enumerable	whereNotIn(string $key, Arrayable\|iterable $values, bool $strict = false) Фильтровать элементы по заданной паре ключ-значение.
Enumerable	whereNotInStrict(string $key, Arrayable\|iterable $values) Фильтровать элементы по заданной паре ключ-значение, используя строгое сравнение.
whereInstanceOf($type) Без описания
first(callable\|null $callback = null, $default = null) Без описания
TValue\|null	firstWhere(string $key, mixed $operator = null, mixed $value = null) Получить первый элемент по заданной паре ключ-значение.
Enumerable	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) Объединить значения заданного ключа в строку.
Enumerable	intersect(TValue>\|TValue> $items) Пересечь коллекцию с заданными элементами.
Enumerable	intersectUsing(TValue>\|TValue> $items, callable $callback) Пересечь коллекцию с заданными элементами, используя обратный вызов.
Enumerable	intersectAssoc(TValue>\|TValue> $items) Пересечь коллекцию с заданными элементами с дополнительной проверкой индекса.
Enumerable	intersectAssocUsing(TValue>\|TValue> $items, callable $callback) Пересечь коллекцию с заданными элементами с дополнительной проверкой индекса, используя обратный вызов.
Enumerable	intersectByKeys(TValue>\|TValue> $items) Пересечь коллекцию с заданными элементами по ключу.
bool	isEmpty() Определить, пуста ли коллекция.
bool	isNotEmpty() Определить, не пуста ли коллекция.
bool	containsOneItem() Определить, содержит ли коллекция один элемент.
string	join(string $glue, string $finalGlue = '') Объединить все элементы коллекции с помощью строки. Для конечных элементов можно использовать отдельную строку склеивания.
keys() Без описания
last(callable\|null $callback = null, $default = null) Без описания
map(callable $callback) Без описания
Enumerable	mapSpread(callable $callback) Выполнить отображение над каждым вложенным фрагментом элементов.
mapToDictionary(callable $callback) Без описания
mapToGroups(callable $callback) Без описания
mapWithKeys(callable $callback) Без описания
flatMap(callable $callback) Без описания
mapInto($class) Без описания
Enumerable	merge(TValue>\|TValue> $items) Объединить коллекцию с заданными элементами.
mergeRecursive($items) Без описания
combine($values) Без описания
Enumerable	union(TValue>\|TValue> $items) Объединить коллекцию с заданными элементами.
mixed	min($callback = null) Получить минимальное значение заданного ключа.
mixed	max($callback = null) Получить максимальное значение заданного ключа.
Enumerable	nth(int $step, int $offset = 0) Создать новую коллекцию, состоящую из каждого n-го элемента.
Enumerable	only(TKey>\|TKey>\|string $keys) Получить элементы с указанными ключами.

Enumerable	forPage(int $page, int $perPage) "Paginate" the collection by slicing it into a smaller collection.
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) Поиск значения в коллекции и возврат соответствующего ключа, если поиск успешен.
TValue\|null	before($value, bool $strict = false) Получить элемент, предшествующий заданному элементу.
TValue\|null	after($value, bool $strict = false) Получить элемент, следующий после заданного элемента.
Enumerable	shuffle() Перемешать элементы в коллекции.
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.
string	__toString() Преобразовать коллекцию в строковое представление.
$this	escapeWhenCastingToString(bool $escape = true) Указать, что строковое представление модели должно быть экранировано при вызове __toString.
static void	proxy(string $method) Добавить метод в список проксируемых методов.
mixed	__get(string $key) Динамичный доступ к проксиям коллекции.

Подробности

toArray()

Без описания

string toJson(int $options = 0)

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

Параметры

int

$options

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

string

static make($items = [])

Без описания

Параметры

$items

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

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

Параметры

int	$number
callable\|null	$callback

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

Enumerable

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

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

Параметры

int	$from
int	$to

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

Enumerable

static wrap($value)

Без описания

Параметры

$value

static unwrap($value)

Без описания

Параметры

$value

static Enumerable empty()

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

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

Enumerable

array all()

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

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

array

float|int|null average($callback = null)

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

Параметры

$callback

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

float|int|null

float|int|null median(string|array<array-key,string>|null $key = null)

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

Параметры

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

$key

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

float|int|null

array<int,float|int>|null mode(string|array<array-key,string>|null $key = null)

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

Параметры

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

$key

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

array<int,float|int>|null

collapse()

Без описания

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

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

Параметры

	$key
mixed	$operator
mixed	$value

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

bool

bool containsStrict($key, TValue|null $value = null)

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

Параметры

	$key
TValue\|null	$value

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

bool

float|int|null avg($callback = null)

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

Параметры

$callback

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

float|int|null

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

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

Параметры

	$key
mixed	$operator
mixed	$value

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

bool

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

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

Параметры

mixed	$key
mixed	$operator
mixed	$value

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

bool

crossJoin(...$lists)

Без описания

Параметры

...$lists

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

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

Параметры

mixed

...$args

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

никогда

$this dump(mixed ...$args)

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

Параметры

mixed

...$args

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

$this

Enumerable diff(TValue>|TValue> $items)

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

Параметры

TValue>|TValue>

$items

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

Enumerable

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

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

Параметры

TValue>\|TValue>	$items
callable	$callback

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

Enumerable

Enumerable diffAssoc(TValue>|TValue> $items)

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

Параметры

TValue>|TValue>

$items

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

Enumerable

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

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

Параметры

TValue>\|TValue>	$items
callable	$callback

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

Enumerable

Enumerable diffKeys(TValue>|TValue> $items)

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

Параметры

TValue>|TValue>

$items

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

Enumerable

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

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

Параметры

TValue>\|TValue>	$items
callable	$callback

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

Enumerable

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

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

Параметры

	$callback
bool	$strict

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

Enumerable

Enumerable duplicatesStrict($callback = null)

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

Параметры

$callback

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

Enumerable

$this each(callable $callback)

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

Параметры

callable

$callback

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

$this

Enumerable eachSpread(callable $callback)

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

Параметры

callable

$callback

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

Enumerable

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

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

Параметры

	$key
mixed	$operator
mixed	$value

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

bool

Enumerable except(TKey>|TKey> $keys)

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

Параметры

TKey>|TKey>

$keys

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

Enumerable

Enumerable filter(callable|null $callback = null)

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

Параметры

callable|null

$callback

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

Enumerable

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

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

Параметры

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

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

$this|TWhenReturnType

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

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

Параметры

callable	$callback
callable\|null	$default

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

$this|TWhenEmptyReturnType

END_OF_DOCUMENT_MARKER

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

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

Параметры

callable	$callback
callable\|null	$default

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

$this|TWhenNotEmptyReturnType

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

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

Параметры

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

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

$this|TUnlessReturnType

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

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

Параметры

callable	$callback
callable\|null	$default

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

$this|TUnlessEmptyReturnType

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

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

Параметры

callable	$callback
callable\|null	$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|null $callback = null, $default = null)

Нет описания

Параметры

callable\|null	$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 intersectUsing(TValue>|TValue> $items, callable $callback)

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

Параметры

TValue>\|TValue>	$items
callable	$callback

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

Enumerable

Enumerable intersectAssoc(TValue>|TValue> $items)

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

Параметры

TValue>|TValue>

$items

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

Enumerable

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

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

Параметры

TValue>\|TValue>	$items
callable	$callback

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

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|null $callback = null, $default = null)

Без описания

Параметры

callable\|null	$callback
	$default

map(callable $callback)

Без описания

Параметры

callable

$callback

Enumerable mapSpread(callable $callback)

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

Параметры

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)

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

Параметры

$callback

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

mixed

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

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

Параметры

int	$step
int	$offset

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

Enumerable

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

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

Параметры

TKey>|TKey>|string

$keys

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

Enumerable

Enumerable forPage(int $page, int $perPage)

«Разбить» коллекцию на части, «странировать».

Параметры

int	$page
int	$perPage

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

Enumerable

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

Без описания

Параметры

	$key
	$operator
	$value

concat($source)

Без описания

Параметры

$source

random($number = null)

Без описания

Параметры

$number

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

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

Параметры

callable	$callback
TReduceInitial	$initial

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

TReduceReturnType

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

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

Параметры

callable	$callback
mixed	...$initial

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

array

Исключения

UnexpectedValueException

Enumerable replace(TValue>|TValue> $items)

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

Параметры

TValue>|TValue>

$items

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

Enumerable

Enumerable replaceRecursive(TValue>|TValue> $items)

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

Параметры

TValue>|TValue>

$items

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

Enumerable

Enumerable reverse()

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

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

Enumerable

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

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

Параметры

	$value
bool	$strict

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

TKey|bool

TValue|null before($value, bool $strict = false)

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

Parameters

	$value
bool	$strict

Return Value

TValue|null

TValue|null after($value, bool $strict = false)

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

Parameters

	$value
bool	$strict

Return Value

TValue|null

Enumerable shuffle()

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

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)

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

Parameters

	$key
mixed	$operator
mixed	$value

Return Value

TValue

Exceptions

ItemNotFoundException
MultipleItemsFoundException

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

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

Parameters

	$key
mixed	$operator
mixed	$value

Return Value

TValue

Exceptions

ItemNotFoundException

chunk($size)

Нет описания

Parameters

$size

chunkWhile(callable $callback)

Нет описания

Parameters

callable

$callback

splitIn($numberOfGroups)

Нет описания

Parameters

$numberOfGroups

Enumerable sort($callback = null)

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

Parameters

$callback

Return Value

Enumerable

Enumerable sortDesc(int $options = SORT_REGULAR)

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

Parameters

int

$options

Return Value

Enumerable

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

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

Parameters

	$callback
int	$options
bool	$descending

Return Value

Enumerable

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

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

Parameters

	$callback
int	$options

Return Value

Enumerable

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

Сортировка ключей коллекции.

Parameters

int	$options
bool	$descending

Return Value

Enumerable

Enumerable sortKeysDesc(int $options = SORT_REGULAR)

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

Parameters

int

$options

Return Value

Enumerable

Enumerable sortKeysUsing(callable $callback)

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

Parameters

callable

$callback

Return Value

Enumerable

mixed sum($callback = null)

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

Parameters

$callback

Return Value

mixed

Enumerable take(int $limit)

Получение первых или последних {$limit} элементов.

Parameters

int

$limit

Return Value

Enumerable

Enumerable takeUntil($value)

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

Parameters

$value

Return Value

Enumerable

Enumerable takeWhile($value)

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

Parameters

$value

Return Value

Enumerable

$this tap(callable $callback)

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

Parameters

callable

$callback

Return Value

$this

TPipeReturnType pipe(callable $callback)

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

Parameters

callable

$callback

Return Value

TPipeReturnType

TPipeIntoValue pipeInto(TPipeIntoValue> $class)

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

Parameters

TPipeIntoValue>

$class

Return Value

TPipeIntoValue

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.

Параметры

int

$flags

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

CachingIterator

string __toString()

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

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

string

$this escapeWhenCastingToString(bool $escape = true)

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

Параметры

bool

$escape

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

$this

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/11.x/Illuminate/Support/Enumerable.html