Enumerable

interface Enumerable implements Arrayable, Countable, IteratorAggregate, Jsonable, JsonSerializable (View source)

Методы

массив	toArray() Получить экземпляр в виде массива.	из Arrayable
строка	toJson(int $options = 0) Преобразовать объект в его представление JSON.	из Jsonable
статический Enumerable	make(mixed $items = []) Создать новый экземпляр коллекции, если значение не является коллекцией.
статический Enumerable	times(int $number, callable $callback = null) Создать новый экземпляр, вызвав обратный вызов заданное количество раз.
статический Enumerable	wrap(mixed $value) Обернуть заданное значение в коллекцию, если применимо.
статический массив	unwrap(array\|Enumerable $value) Получить базовые элементы из заданной коллекции, если применимо.
массив	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) Определить, существует ли элемент в перечислимой коллекции.
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\|null $callback = null, bool $strict = false) Получить дублируемые элементы.
Enumerable	duplicatesStrict(callable\|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	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 $type) Фильтровать элементы, удаляя все элементы, которые не соответствуют заданному типу.
mixed	first(callable $callback = null, mixed $default = null) Получить первый элемент из перечисляемого, проходящий заданный тест на истинность.
mixed	firstWhere(string $key, mixed $operator = null, mixed $value = null) Получить первый элемент по заданной паре ключ-значение.
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 $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) Выполнить map для каждого из элементов.
Enumerable	mapSpread(callable $callback) Выполнить map для каждого вложенного фрагмента элементов.
Enumerable	mapToDictionary(callable $callback) Выполнить map словаря для элементов.
Enumerable	mapToGroups(callable $callback) Выполнить группирующий map для элементов.
Enumerable	mapWithKeys(callable $callback) Выполнить ассоциативный map для каждого из элементов.
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 $seed = null) Перемешать элементы в коллекции.
Enumerable	skip(int $count) Пропустить первые {$count} элементов.
Enumerable	slice(int $offset, int $length = null) Получить срез элементов из перечислимой коллекции.
Enumerable	split(int $numberOfGroups) Разбить коллекцию на определённое количество групп.
Enumerable	chunk(int $size) Разбить коллекцию на части заданного размера.
Enumerable	sort(callable $callback = null) Сортировка каждого элемента с помощью обратного вызова.
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} элементов.
$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) Подсчитать количество элементов в коллекции с помощью заданной проверки истинности.
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 wrap(mixed $value)

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

Параметры

mixed

$value

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

Enumerable

static array unwrap(array|Enumerable $value)

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

Параметры

array|Enumerable

$value

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

array

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

void dd(mixed ...$args)

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

Параметры

mixed

...$args

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

void

$this dump()

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

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

$this

Enumerable diff(mixed $items)

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

Параметры

mixed

$items

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

Enumerable

Enumerable diffUsing(mixed $items, callable $callback)

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

Параметры

mixed	$items
callable	$callback

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

Enumerable

Enumerable diffAssoc(mixed $items)

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

Параметры

mixed

$items

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

Enumerable

Enumerable diffAssocUsing(mixed $items, callable $callback)

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

Параметры

mixed	$items
callable	$callback

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

Enumerable

Enumerable diffKeys(mixed $items)

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

Параметры

mixed

$items

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

Enumerable

Enumerable diffKeysUsing(mixed $items, callable $callback)

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

Параметры

mixed	$items
callable	$callback

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

Enumerable

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

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

Параметры

callable\|null	$callback
bool	$strict

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

Enumerable

Enumerable duplicatesStrict(callable|null $callback = null)

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

Параметры

callable|null

$callback

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

Enumerable

$this each(callable $callback)

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

Параметры

callable

$callback

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

$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

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

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

Parameters

callable	$callback
callable	$default

Return Value

Enumerable|mixed

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

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

Parameters

callable	$callback
callable	$default

Return Value

Enumerable|mixed

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

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

Parameters

string	$key
mixed	$operator
mixed	$value

Return Value

Enumerable

Enumerable whereStrict(string $key, mixed $value)

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

Parameters

string	$key
mixed	$value

Return Value

Enumerable

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

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

Parameters

string	$key
mixed	$values
bool	$strict

Return Value

Enumerable

Enumerable whereInStrict(string $key, mixed $values)

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

Parameters

string	$key
mixed	$values

Return Value

Enumerable

Enumerable whereBetween(string $key, array $values)

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

Parameters

string	$key
array	$values

Return Value

Enumerable

Enumerable whereNotBetween(string $key, array $values)

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

Parameters

string	$key
array	$values

Return Value

Enumerable

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

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

Параметры

string	$key
mixed	$values
bool	$strict

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

Enumerable

Enumerable whereNotInStrict(string $key, mixed $values)

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

Параметры

string	$key
mixed	$values

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

Enumerable

Enumerable whereInstanceOf(string $type)

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

Параметры

string

$type

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

Enumerable

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

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

Параметры

callable	$callback
mixed	$default

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

mixed

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

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

Параметры

string	$key
mixed	$operator
mixed	$value

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

mixed

Enumerable flip()

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

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

Enumerable

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

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

Параметры

mixed	$key
mixed	$default

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

mixed

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

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

Параметры

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

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

Enumerable

Enumerable keyBy(callable|string $keyBy)

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

Параметры

callable|string

$keyBy

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

Enumerable

bool has(mixed $key)

Определение наличия элемента в коллекции по ключу.

Параметры

mixed

$key

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

bool

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

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

Параметры

string	$value
string	$glue

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

string

Enumerable intersect(mixed $items)

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

Параметры

mixed

$items

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

Enumerable

Enumerable intersectByKeys(mixed $items)

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

Параметры

mixed

$items

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

Enumerable

bool isEmpty()

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

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

bool

bool isNotEmpty()

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

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

bool

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

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

Параметры

string	$glue
string	$finalGlue

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

string

Enumerable keys()

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

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

Enumerable

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

Получение последнего элемента коллекции.

Параметры

callable	$callback
mixed	$default

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

mixed

Enumerable map(callable $callback)

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

Параметры

callable

$callback

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

Enumerable

Enumerable mapSpread(callable $callback)

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

Параметры

callable

$callback

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

Enumerable

Enumerable mapToDictionary(callable $callback)

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

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

Параметры

callable

$callback

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

Enumerable

Enumerable mapToGroups(callable $callback)

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

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

Параметры

callable

$callback

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

Enumerable

Enumerable mapWithKeys(callable $callback)

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

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

Параметры

callable

$callback

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

Enumerable

Enumerable flatMap(callable $callback)

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

Параметры

callable

$callback

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

Enumerable

Enumerable mapInto(string $class)

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

Параметры

string

$class

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

Enumerable

Enumerable merge(mixed $items)

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

Параметры

mixed

$items

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

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)

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

Parameters

mixed

$items

Return Value

Enumerable

Enumerable replaceRecursive(mixed $items)

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

Parameters

mixed

$items

Return Value

Enumerable

Enumerable reverse()

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

Return Value

Enumerable

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

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

Parameters

mixed	$value
bool	$strict

Return Value

mixed

Enumerable shuffle(int $seed = null)

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

Parameters

int

$seed

Return Value

Enumerable

Enumerable skip(int $count)

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

Parameters

int

$count

Return Value

Enumerable

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

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

Parameters

int	$offset
int	$length

Return Value

Enumerable

Enumerable split(int $numberOfGroups)

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

Parameters

int

$numberOfGroups

Return Value

Enumerable

Enumerable chunk(int $size)

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

Parameters

int

$size

Return Value

Enumerable

Enumerable sort(callable $callback = null)

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

Parameters

callable

$callback

Return Value

Enumerable

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

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

Parameters

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

Return Value

Enumerable

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

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

Parameters

callable\|string	$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

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

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

Parameters

callable|string|null

$callback

Return Value

mixed

Enumerable take(int $limit)

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

Parameters

int

$limit

Return Value

Enumerable

$this tap(callable $callback)

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

Parameters

callable

$callback

Return Value

$this

mixed pipe(callable $callback)

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

Parameters

callable

$callback

Return Value

mixed

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

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

Parameters

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

Return Value

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

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