Enumerable
интерфейс Enumerable реализует 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|null $glue = null) Объединить значения заданного ключа в строку. | |
| Enumerable | intersect(mixed $items) Пересечь коллекцию с заданными элементами. | |
| Enumerable | intersectByKeys(mixed $items) Пересечь коллекцию с заданными элементами по ключам. | |
| bool | isEmpty() Определить, пуста ли коллекция. | |
| bool | isNotEmpty() Определить, не пуста ли коллекция. | |
| string | join(string $glue, string $finalGlue = '') Объединить все элементы из коллекции с использованием строки. Для конечных элементов можно использовать отдельную строку разделителя. | |
| Enumerable | keys() Получить ключи элементов коллекции. | |
| mixed | last(callable $callback = null, mixed $default = null) Получить последний элемент из коллекции. | |
| Enumerable | map(callable $callback) Применить функцию к каждому элементу. | |
| Enumerable | mapSpread(callable $callback) Применить функцию к каждому вложенному набору элементов. | |
| Enumerable | mapToDictionary(callable $callback) Применить функцию для создания словаря из элементов. | |
| Enumerable | mapToGroups(callable $callback) Применить функцию для группировки элементов. | |
| Enumerable | mapWithKeys(callable $callback) Применить ассоциативную функцию к каждому элементу. | |
| Enumerable | flatMap(callable $callback) Применить функцию к коллекции и уплостить результат на один уровень. | |
| Enumerable | mapInto(string $class) Преобразовать значения в новый класс. | |
| Enumerable | merge(mixed $items) Объединить коллекцию с заданными элементами. | |
| Enumerable | mergeRecursive(mixed $items) Рекурсивно объединить коллекцию с заданными элементами. | |
| Enumerable | combine(mixed $values) Создать коллекцию, используя эту коллекцию в качестве ключей и другую в качестве значений. | |
| Enumerable | union(mixed $items) Объединить коллекцию с заданными элементами. | |
| mixed | min(callable|string|null $callback = null) Получить минимальное значение заданного ключа. | |
| mixed | max(callable|string|null $callback = null) Получить максимальное значение заданного ключа. | |
| Enumerable | nth(int $step, int $offset = 0) Создать новую коллекцию, состоящую из каждого n-го элемента. | |
| Enumerable | only(mixed $keys) Получить элементы с указанными ключами. | |
| Enumerable | forPage(int $page, int $perPage) «Разбить» коллекцию на страницы, разбивая её на меньшие коллекции. | |
| Enumerable | partition(callable|string $key, mixed $operator = null, mixed $value = null) Разделить коллекцию на два массива, используя заданный обратный вызов или ключ. | |
| Enumerable | concat(iterable $source) Добавить все заданные элементы в коллекцию. | |
| Enumerable|mixed | random(int|null $number = null) Случайно получить один или указанное количество элементов из коллекции. | |
| mixed | reduce(callable $callback, mixed $initial = null) Свести коллекцию к одному значению. | |
| Enumerable | replace(mixed $items) Заменить элементы коллекции на заданные. |
| Enumerable | replaceRecursive(mixed $items)
Рекурсивно заменить элементы коллекции заданными элементами. | |
| Enumerable | reverse()
Изменить порядок элементов на обратный. | |
| mixed | search(mixed $value, bool $strict = false)
Найти в коллекции заданное значение и вернуть соответствующий ключ, если поиск успешен. | |
| Enumerable | shuffle(int|null $seed = null)
Перемешать элементы в коллекции. | |
| Enumerable | skip(int $count)
Пропустить первые {$count} элементов. | |
| Enumerable | slice(int $offset, int|null $length = null)
Получить фрагмент элементов из перечислимого. | |
| Enumerable | split(int $numberOfGroups)
Разделить коллекцию на определенное количество групп. | |
| Enumerable | chunk(int $size)
Разбить коллекцию на куски заданного размера. | |
| Enumerable | sort(callable|null|int $callback = null)
Сортировать каждый элемент с помощью обратного вызова. | |
| Enumerable | sortDesc(int $options = SORT_REGULAR)
Сортировать элементы в порядке убывания. | |
| Enumerable | sortBy(callable|string $callback, int $options = SORT_REGULAR, bool $descending = false)
Сортировать коллекцию с помощью заданного обратного вызова. | |
| Enumerable | sortByDesc(callable|string $callback, int $options = SORT_REGULAR)
Сортировать коллекцию в порядке убывания с использованием заданного обратного вызова. | |
| Enumerable | sortKeys(int $options = SORT_REGULAR, bool $descending = false)
Сортировать ключи коллекции. | |
| Enumerable | sortKeysDesc(int $options = SORT_REGULAR)
Сортировать ключи коллекции в порядке убывания. | |
| mixed | sum(callable|string|null $callback = null)
Получить сумму заданных значений. | |
| Enumerable | take(int $limit)
Взять первые или последние {$limit} элементов. | |
| $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()
Получить экземпляр в виде массива.
string toJson(int $options = 0)
Преобразовать объект в его представление JSON.
static Enumerable make(mixed $items = [])
Создать новый экземпляр коллекции, если значение не является коллекцией.
static Enumerable times(int $number, callable $callback = null)
Создать новый экземпляр, вызвав обратный вызов заданное количество раз.
static Enumerable wrap(mixed $value)
Оборачивает заданное значение в коллекцию, если это возможно.
static array unwrap(array|Enumerable $value)
Получить базовые элементы из заданного набора, если применимо.
array all()
Получить все элементы в перечислимом наборе.
mixed average(callable|string|null $callback = null)
Псевдоним для метода "avg".
mixed median(string|array|null $key = null)
Получить медиану заданного ключа.
array|null mode(string|array|null $key = null)
Получить моду заданного ключа.
Enumerable collapse()
Свести элементы в один перечислимый набор.
bool some(mixed $key, mixed $operator = null, mixed $value = null)
Псевдоним для метода "contains".
bool containsStrict(mixed $key, mixed $value = null)
Определить, существует ли элемент, используя строгое сравнение.
mixed avg(callable|string|null $callback = null)
Получить среднее значение заданного ключа.
bool 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)
Выполнить обратный вызов для каждого вложенного фрагмента элементов.
bool every(string|callable $key, mixed $operator = null, mixed $value = null)
Определить, проходят ли все элементы заданный тест истинности.
Enumerable except(mixed $keys)
Получить все элементы, кроме тех, у которых указаны ключи.
Enumerable filter(callable $callback = null)
Применить фильтр к каждому элементу.
Enumerable|mixed when(bool $value, callable $callback, callable $default = null)
Применить обратный вызов, если значение истинно.
Enumerable|mixed whenEmpty(callable $callback, callable $default = null)
Применить обратный вызов, если коллекция пустая.
Enumerable|mixed whenNotEmpty(callable $callback, callable $default = null)
Применить обратный вызов, если коллекция не пустая.
Enumerable|mixed unless(bool $value, callable $callback, callable $default = null)
Применить обратный вызов, если значение ложно.
Enumerable|mixed unlessEmpty(callable $callback, callable $default = null)
Применить обратный вызов, если коллекция не пустая.
Enumerable|mixed 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|null $glue = null)
Соединить значения заданного ключа в строку.
Enumerable intersect(mixed $items)
Пересечение коллекции с заданными элементами.
Enumerable intersectByKeys(mixed $items)
Пересечение коллекции с заданными элементами по ключам.
bool isEmpty()
Определяет, пуста ли коллекция.
bool isNotEmpty()
Определяет, не пуста ли коллекция.
string join(string $glue, string $finalGlue = '')
Соединить все элементы из коллекции с помощью строки. Для конечных элементов можно использовать отдельную строку разделителя.
Enumerable keys()
Получить ключи элементов коллекции.
mixed last(callable $callback = null, mixed $default = null)
Получить последний элемент из коллекции.
Enumerable map(callable $callback)
Применить функцию к каждому элементу.
Enumerable mapSpread(callable $callback)
Применить функцию к каждому вложенному фрагменту элементов.
Enumerable mapToDictionary(callable $callback)
Выполнить отображение словаря над элементами.
Обратный вызов должен вернуть ассоциативный массив с одной парой ключ/значение.
Enumerable mapToGroups(callable $callback)
Выполнить отображение группирования над элементами.
Обратный вызов должен вернуть ассоциативный массив с одной парой ключ/значение.
Enumerable mapWithKeys(callable $callback)
Выполнить отображение с ключами над каждым из элементов.
Обратный вызов должен вернуть ассоциативный массив с одной парой ключ/значение.
Enumerable flatMap(callable $callback)
Отобразить коллекцию и уплостить результат на один уровень.
Enumerable mapInto(string $class)
Отобразить значения в новый класс.
Enumerable merge(mixed $items)
Объединить коллекцию с заданными элементами.
Enumerable mergeRecursive(mixed $items)
Рекурсивно объединить коллекцию с заданными элементами.
Enumerable combine(mixed $values)
Создать коллекцию, используя эту коллекцию для ключей и другую для ее значений.
Enumerable union(mixed $items)
Объединить коллекцию с заданными элементами.
mixed min(callable|string|null $callback = null)
Получить минимальное значение заданного ключа.
mixed max(callable|string|null $callback = null)
Получить максимальное значение заданного ключа.
Enumerable nth(int $step, int $offset = 0)
Создать новую коллекцию, состоящую из каждого n-го элемента.
Enumerable only(mixed $keys)
Получить элементы с указанными ключами.
Enumerable forPage(int $page, int $perPage)
«Разбить» коллекцию, разбив ее на более мелкие коллекции.
Enumerable partition(callable|string $key, mixed $operator = null, mixed $value = null)
Разделить коллекцию на два массива, используя заданный обратный вызов или ключ.
Enumerable concat(iterable $source)
Добавить все заданные элементы в коллекцию.
Enumerable|mixed random(int|null $number = null)
Получить один или указанное количество случайных элементов из коллекции.
mixed reduce(callable $callback, mixed $initial = null)
Свести коллекцию к одному значению.
Enumerable replace(mixed $items)
Заменить элементы коллекции на заданные.
Enumerable replaceRecursive(mixed $items)
Рекурсивно заменить элементы коллекции на заданные.
Enumerable reverse()
Изменить порядок элементов на обратный.
mixed search(mixed $value, bool $strict = false)
Найти в коллекции заданное значение и вернуть соответствующий ключ, если поиск успешен.
Enumerable shuffle(int|null $seed = null)
Перемешать элементы в коллекции.
Enumerable skip(int $count)
Пропустить первые {$count} элементов.
Enumerable slice(int $offset, int|null $length = null)
Получить срез элементов из перечисляемого объекта.
Enumerable split(int $numberOfGroups)
Разбить коллекцию на определенное количество групп.
Enumerable chunk(int $size)
Разбить коллекцию на куски заданного размера.
Enumerable sort(callable|null|int $callback = null)
Отсортировать элементы с помощью обратного вызова.
Enumerable sortDesc(int $options = SORT_REGULAR)
Отсортировать элементы в порядке убывания.
Enumerable sortBy(callable|string $callback, int $options = SORT_REGULAR, bool $descending = false)
Отсортировать коллекцию с использованием заданного обратного вызова.
Enumerable sortByDesc(callable|string $callback, int $options = SORT_REGULAR)
Отсортировать коллекцию в порядке убывания с использованием заданного обратного вызова.
Enumerable sortKeys(int $options = SORT_REGULAR, bool $descending = false)
Отсортировать ключи коллекции.
Enumerable sortKeysDesc(int $options = SORT_REGULAR)
Отсортировать ключи коллекции в порядке убывания.
mixed sum(callable|string|null $callback = null)
Получить сумму заданных значений.
Enumerable take(int $limit)
Взять первые или последние {$limit} элементов.
$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)
Динамический доступ к проксированию коллекции.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/7.x/Illuminate/Support/Enumerable.html
