Коллекция
класс Collection реализует ArrayAccess, CanBeEscapedWhenCastToString, Enumerable (View source)
Трейты
| EnumeratesValues | |
| Macroable | |
| Conditionable |
Свойства
| HigherOrderCollectionProxy только для чтения | $unless | из EnumeratesValues | |
| HigherOrderCollectionProxy только для чтения | $until | из EnumeratesValues | |
| HigherOrderCollectionProxy только для чтения | $when | из EnumeratesValues | |
| static protected массив | $macros | Зарегистрированные строковые макросы. | из Macroable |
| protected | $items |
Методы
| $this|TWhenReturnType | when($value = null, callable|null $callback = null, callable|null $default = null)
Применить обратный вызов, если заданное «значение» истинно. | из Conditionable |
| $this|TUnlessReturnType | unless($value = null, callable|null $callback = null, callable|null $default = null)
Применить обратный вызов, если заданное «значение» ложно. | из Conditionable |
| static | make($items = []) Описание отсутствует | из EnumeratesValues |
| static | wrap($value) Описание отсутствует | из EnumeratesValues |
| static | unwrap($value) Описание отсутствует | из EnumeratesValues |
| static EnumeratesValues | empty()
Создать новый экземпляр без элементов. | из EnumeratesValues |
| static | times($number, callable|null $callback = null) Описание отсутствует | из EnumeratesValues |
| float|int|null | avg($callback = null)
Получить среднее значение заданного ключа. | из EnumeratesValues |
| float|int|null | average($callback = null)
Псевдоним для метода «avg». | из EnumeratesValues |
| bool | some($key, mixed $operator = null, mixed $value = null)
Псевдоним для метода «contains». | из EnumeratesValues |
| never | dd(mixed ...$args)
Вывести заданные аргументы и завершить выполнение. | из EnumeratesValues |
| $this | dump(mixed ...$args)
Вывести элементы. | из EnumeratesValues |
| $this | each(callable $callback)
Выполнить обратный вызов для каждого элемента. | из EnumeratesValues |
| EnumeratesValues | eachSpread(callable $callback)
Выполнить обратный вызов для каждого вложенного фрагмента элементов. | из EnumeratesValues |
| bool | every($key, mixed $operator = null, mixed $value = null)
Определить, проходят ли все элементы заданный тест истинности. | из EnumeratesValues |
| TValue|null | firstWhere(callable|string $key, mixed $operator = null, mixed $value = null)
Получить первый элемент по заданной паре «ключ-значение». | из EnumeratesValues |
| value($key, $default = null) Описание отсутствует | из EnumeratesValues | |
| ensure($type) Описание отсутствует | из EnumeratesValues | |
| bool | isNotEmpty()
Определить, не пуста ли коллекция. | из EnumeratesValues |
| mapSpread(callable $callback) Описание отсутствует | из EnumeratesValues | |
| mapToGroups(callable $callback) Описание отсутствует | из EnumeratesValues | |
| flatMap(callable $callback) Описание отсутствует | из EnumeratesValues | |
| mapInto($class) Описание отсутствует | из EnumeratesValues | |
| mixed | min($callback = null)
Получить минимальное значение заданного ключа. | из EnumeratesValues |
| mixed | max($callback = null)
Получить максимальное значение заданного ключа. | из EnumeratesValues |
| EnumeratesValues | forPage(int $page, int $perPage)
«Разбить» коллекцию на более мелкие коллекции. | из EnumeratesValues |
| partition($key, $operator = null, $value = null) Описание отсутствует | из EnumeratesValues | |
| float|null | percentage(callable $callback, int $precision = 2)
Вычислить процент элементов, удовлетворяющих заданному условию истинности. | из EnumeratesValues |
| mixed | sum($callback = null)
Получить сумму заданных значений. | из EnumeratesValues |
| $this|TWhenEmptyReturnType | whenEmpty(callable $callback, callable|null $default = null)
Применить обратный вызов, если коллекция пуста. | из EnumeratesValues |
| $this|TWhenNotEmptyReturnType | whenNotEmpty(callable $callback, callable|null $default = null)
Применить обратный вызов, если коллекция не пуста. | из EnumeratesValues |
| $this|TUnlessEmptyReturnType | unlessEmpty(callable $callback, callable|null $default = null)
Применить обратный вызов, если коллекция пуста. | from EnumeratesValues |
| $this|TUnlessNotEmptyReturnType | unlessNotEmpty(callable $callback, callable|null $default = null)
Применить обратный вызов, если коллекция не пуста. | from EnumeratesValues |
| EnumeratesValues | where(callable|string $key, mixed $operator = null, mixed $value = null)
Фильтр элементов по заданной паре ключ-значение. | from EnumeratesValues |
| EnumeratesValues | whereNull(string|null $key = null)
Фильтровать элементы, где значение для заданного ключа равно null. | from EnumeratesValues |
| EnumeratesValues | whereNotNull(string|null $key = null)
Фильтровать элементы, где значение для заданного ключа не равно null. | from EnumeratesValues |
| EnumeratesValues | whereStrict(string $key, mixed $value)
Фильтр элементов по заданной паре ключ-значение с жёстким сравнением. | from EnumeratesValues |
| EnumeratesValues | whereIn(string $key, Arrayable|iterable $values, bool $strict = false)
Фильтр элементов по заданной паре ключ-значение. | from EnumeratesValues |
| EnumeratesValues | whereInStrict(string $key, Arrayable|iterable $values)
Фильтр элементов по заданной паре ключ-значение с жёстким сравнением. | from EnumeratesValues |
| EnumeratesValues | whereBetween(string $key, Arrayable|iterable $values)
Фильтровать элементы, где значение заданного ключа находится между заданными значениями. | from EnumeratesValues |
| EnumeratesValues | whereNotBetween(string $key, Arrayable|iterable $values)
Фильтровать элементы, где значение заданного ключа не находится между заданными значениями. | from EnumeratesValues |
| EnumeratesValues | whereNotIn(string $key, Arrayable|iterable $values, bool $strict = false)
Фильтр элементов по заданной паре ключ-значение. | from EnumeratesValues |
| EnumeratesValues | whereNotInStrict(string $key, Arrayable|iterable $values)
Фильтр элементов по заданной паре ключ-значение с жёстким сравнением. | from EnumeratesValues |
| whereInstanceOf($type) Без описания | from EnumeratesValues | |
| TPipeReturnType | pipe(callable $callback)
Передать коллекцию в заданный обратный вызов и вернуть результат. | from EnumeratesValues |
| TPipeIntoValue | pipeInto(TPipeIntoValue> $class)
Передать коллекцию в новый класс. | from EnumeratesValues |
| mixed | pipeThrough(callable[] $callbacks)
Передать коллекцию через серию вызовов обратных функций и вернуть результат. | from EnumeratesValues |
| TReduceReturnType | reduce(callable $callback, TReduceInitial $initial = null)
Свести коллекцию к одному значению. | from EnumeratesValues |
| array | reduceSpread(callable $callback, mixed ...$initial)
Свести коллекцию к нескольким агрегированным значениям. | from EnumeratesValues |
| TReduceWithKeysReturnType | reduceWithKeys(callable $callback, TReduceWithKeysInitial $initial = null)
Свести ассоциативную коллекцию к одному значению. | from EnumeratesValues |
| EnumeratesValues | reject($callback = true)
Создать коллекцию всех элементов, которые не проходят заданный тест истинности. | from EnumeratesValues |
| $this | tap(callable $callback)
Передать коллекцию в заданный обратный вызов, а затем вернуть её. | from EnumeratesValues |
| Enumerable | unique($key = null, bool $strict = false)
Возвратить только уникальные элементы из массива коллекции. | |
| EnumeratesValues | uniqueStrict($key = null)
Возвратить только уникальные элементы из массива коллекции, используя жёсткое сравнение. | from EnumeratesValues |
| TValue> | collect()
Собрать значения в коллекцию. | from EnumeratesValues |
| toArray() Без описания | from EnumeratesValues |
| array | jsonSerialize() Без описания | из EnumeratesValues |
| string | toJson(int $options = 0) Получить коллекцию элементов в формате JSON. | из EnumeratesValues |
| CachingIterator | getCachingIterator(int $flags = CachingIterator::CALL_TOSTRING) Получить экземпляр CachingIterator. | из EnumeratesValues |
| string | __toString() Преобразовать коллекцию в строковое представление. | из EnumeratesValues |
| $this | escapeWhenCastingToString(bool $escape = true) Указать, что строковое представление модели должно быть экранировано при вызове __toString. | из EnumeratesValues |
| static void | proxy(string $method) Добавить метод в список проксируемых методов. | из EnumeratesValues |
| mixed | __get(string $key) Динамический доступ к прокси коллекций. | из EnumeratesValues |
| getArrayableItems($items) Без описания | из EnumeratesValues | |
| Closure | operatorForWhere(callable|string $key, string|null $operator = null, mixed $value = null) Получить обратный вызов для проверки оператора. | из EnumeratesValues |
| bool | useAsCallable(mixed $value) Определить, является ли заданное значение вызываемым, но не строкой. | из EnumeratesValues |
| callable | valueRetriever(callable|string|null $value) Получить обратный вызов для извлечения значения. | из EnumeratesValues |
| equality(mixed $value) Создать функцию для проверки равенства элемента. | из EnumeratesValues | |
| Closure | negate(Closure $callback) Создать функцию, использующую другую функцию, инвертируя ее результат. | из EnumeratesValues |
| identity() Создать функцию, возвращающую то, что ей передано. | из EnumeratesValues | |
| static void | macro(string $name, object|callable $macro) Зарегистрировать пользовательское макрос. | из Macroable |
| static void | mixin(object $mixin, bool $replace = true) Смешать другую объектную модель в класс. | из Macroable |
| static bool | hasMacro(string $name) Проверяет, зарегистрировано ли макрос. | из Macroable |
| static void | flushMacros() Очистить существующие макросы. | из Macroable |
| static mixed | __callStatic(string $method, array $parameters) Динамически обрабатывать вызовы к классу. | из Macroable |
| mixed | __call(string $method, array $parameters) Динамически обрабатывать вызовы к классу. | из Macroable |
| void | __construct(TValue>|TValue>|null $items = []) Создать новую коллекцию. | |
| static Enumerable | range(int $from, int $to) Без описания | |
| array | all() Без описания | |
| TValue> | lazy() Получить ленивую коллекцию для элементов в этой коллекции. | |
| 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 | contains($key, mixed $operator = null, mixed $value = null) Определить, существует ли элемент в коллекции. | |
| bool | containsStrict($key, TValue|null $value = null) Определить, существует ли элемент, используя строгое сравнение. | |
| bool | doesntContain(mixed $key, mixed $operator = null, mixed $value = null) Определить, не содержится ли элемент в коллекции. | |
| crossJoin(...$lists) Без описания | ||
| 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)
Получить дублируемые элементы из коллекции, используя строгое сравнение. | |
| duplicateComparator(bool $strict)
Получить функцию сравнения для обнаружения дубликатов. | ||
| Enumerable | except(TKey>|TKey> $keys)
Получить все элементы, кроме тех, у которых указаны ключи. | |
| Enumerable | filter(callable|null $callback = null)
Применить фильтр к каждому элементу. | |
| first(callable|null $callback = null, $default = null) Без описания | ||
| Enumerable | flatten(int $depth = INF) Без описания | |
| flip() Без описания | ||
| $this | forget($keys)
Удалить элемент из коллекции по ключу. | |
| get($key, $default = null) Без описания | ||
| getOrPut($key, $value) Без описания | ||
| 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 | containsOneItem()
Определить, содержит ли коллекция один элемент. | |
| string | join(string $glue, string $finalGlue = '')
Объединить все элементы из коллекции с помощью строки. Для конечных элементов можно использовать отдельную строку разделителя. | |
| keys() Без описания | ||
| last(callable|null $callback = null, $default = null) Без описания | ||
| pluck($value, $key = null) Без описания | ||
| map(callable $callback) Без описания | ||
| mapToDictionary(callable $callback) Без описания | ||
| mapWithKeys(callable $callback) Без описания | ||
| Enumerable | merge(TValue>|TValue> $items)
Объединить коллекцию с заданными элементами. | |
| mergeRecursive($items) Без описания | ||
| Collection | multiply(int $multiplier)
Умножить элементы в коллекции на множитель. | |
| combine($values) Без описания | ||
| Enumerable | union(TValue>|TValue> $items)
Объединить коллекцию с заданными элементами. | |
| Enumerable | nth(int $step, int $offset = 0)
Создать новую коллекцию, состоящую из каждого n-го элемента. | |
| Enumerable | only(TKey>|TKey>|string $keys)
Получить элементы со списком ключей. | |
| Collection | select(TKey>|TKey>|string|null $keys)
Выбрать определённые значения из элементов в коллекции. | |
| pop($count = 1) Без описания | ||
| $this | prepend(TValue $value, TKey $key = null)
Добавить элемент в начало коллекции. | |
| $this | push(TValue ...$values)
Добавить один или несколько элементов в конец коллекции. | |
| $this | unshift(TValue ...$values)
Добавить один или несколько элементов в начало коллекции. | |
| concat($source) Без описания | ||
| pull($key, $default = null) Без описания | ||
| $this | put(TKey $key, TValue $value)
Поместить элемент в коллекцию по ключу. | |
| random($number = null, $preserveKeys = false) Без описания |
| 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)
Получить элемент, следующий за заданным элементом. | |
| shift($count = 1) Без описания | ||
| 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) Без описания | ||
| splitIn($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) Без описания | ||
| Enumerable | sort($callback = null)
Отсортировать каждый элемент с помощью обратного вызова. | |
| Enumerable | sortDesc(int $options = SORT_REGULAR)
Отсортировать элементы в порядке убывания. | |
| Enumerable | sortBy($callback, int $options = SORT_REGULAR, bool $descending = false)
Отсортировать коллекцию, используя заданный обратный вызов. | |
| Collection | sortByMany(array $comparisons = [], int $options = SORT_REGULAR)
Отсортировать коллекцию, используя несколько сравнений. | |
| 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)
Отсортировать ключи коллекции, используя обратный вызов. | |
| Collection | splice(int $offset, int|null $length = null, TValue> $replacement = [])
Вырезать часть массива коллекции. | |
| Enumerable | take(int $limit)
Взять первые или последние {$limit} элементы. | |
| Enumerable | takeUntil($value)
Взять элементы в коллекции до тех пор, пока не будет выполнено заданное условие. | |
| Enumerable | takeWhile($value)
Взять элементы в коллекции, пока выполняется заданное условие. | |
| $this | transform(callable $callback)
Преобразовать каждый элемент в коллекции с помощью обратного вызова. | |
| Collection | dot()
Раскладывает многомерный ассоциативный массив с точками. | |
| Enumerable | undot()
Преобразует массив с "точечной" записью в развернутый массив. | |
| values() Без описания | ||
| zip($items) Без описания | ||
| pad($size, $value) Без описания | ||
| Traversable | getIterator()
Получить итератор для элементов. | |
| int | count()
Подсчитать количество элементов в коллекции. | |
| countBy($countBy = null) Без описания | ||
| $this | add(TValue $item)
Добавить элемент в коллекцию. | |
| TValue> | toBase()
Получить базовый экземпляр коллекции Support из этой коллекции. | |
| bool | offsetExists(TKey $key)
Определить, существует ли элемент по заданному смещению. | |
| mixed | offsetGet(TKey $key)
Получить элемент по заданному смещению. | |
| void | offsetSet(TKey|null $key, TValue $value)
Установить элемент по заданному смещению. | |
| void | offsetUnset(TKey $key)
Удалить элемент по заданному смещению. |
Подробности
$this|TWhenReturnType when($value = null, callable|null $callback = null, callable|null $default = null)
Примените обратный вызов, если заданное «значение» истинно.
$this|TUnlessReturnType unless($value = null, callable|null $callback = null, callable|null $default = null)
Примените обратный вызов, если заданное «значение» ложно.
static make($items = [])
Без описания
static wrap($value)
Без описания
static unwrap($value)
Без описания
static EnumeratesValues empty()
Создать новый экземпляр без элементов.
static times($number, callable|null $callback = null)
Без описания
float|int|null avg($callback = null)
Получить среднее значение заданного ключа.
float|int|null average($callback = null)
Псевдоним для метода «avg».
bool some($key, mixed $operator = null, mixed $value = null)
Псевдоним для метода «contains».
never dd(mixed ...$args)
Вывести заданные аргументы и завершить выполнение.
$this dump(mixed ...$args)
Вывести элементы.
$this each(callable $callback)
Выполнить обратный вызов над каждым элементом.
EnumeratesValues eachSpread(callable $callback)
Выполнить обратный вызов над каждым вложенным блоком элементов.
bool every($key, mixed $operator = null, mixed $value = null)
Определить, удовлетворяют ли все элементы заданному условию истинности.
TValue|null firstWhere(callable|string $key, mixed $operator = null, mixed $value = null)
Получить первый элемент по заданной паре ключ-значение.
value($key, $default = null)
Без описания
ensure($type)
Без описания
bool isNotEmpty()
Определить, является ли коллекция непустой.
mapSpread(callable $callback)
Без описания
mapToGroups(callable $callback)
Без описания
flatMap(callable $callback)
Без описания
mapInto($class)
Без описания
mixed min($callback = null)
Получить минимальное значение заданного ключа.
mixed max($callback = null)
Получить максимальное значение заданного ключа.
EnumeratesValues forPage(int $page, int $perPage)
«Разбить» коллекцию на страницы, разделив её на более мелкие коллекции.
partition($key, $operator = null, $value = null)
Описание отсутствует
float|null percentage(callable $callback, int $precision = 2)
Вычислить процент элементов, удовлетворяющих заданному условию.
mixed sum($callback = null)
Получить сумму заданных значений.
$this|TWhenEmptyReturnType whenEmpty(callable $callback, callable|null $default = null)
Применить обратный вызов, если коллекция пустая.
$this|TWhenNotEmptyReturnType whenNotEmpty(callable $callback, callable|null $default = null)
Применить обратный вызов, если коллекция не пустая.
$this|TUnlessEmptyReturnType unlessEmpty(callable $callback, callable|null $default = null)
Применить обратный вызов, если коллекция не пустая.
$this|TUnlessNotEmptyReturnType unlessNotEmpty(callable $callback, callable|null $default = null)
Применить обратный вызов, если коллекция пустая.
EnumeratesValues where(callable|string $key, mixed $operator = null, mixed $value = null)
Фильтр элементов по заданной паре ключ-значение.
EnumeratesValues whereNull(string|null $key = null)
Фильтровать элементы, где значение для заданного ключа равно null.
EnumeratesValues whereNotNull(string|null $key = null)
Фильтровать элементы, где значение для заданного ключа не равно null.
EnumeratesValues whereStrict(string $key, mixed $value)
Фильтровать элементы по заданной паре ключ-значение с использованием строгого сравнения.
EnumeratesValues whereIn(string $key, Arrayable|iterable $values, bool $strict = false)
Фильтровать элементы по заданной паре ключ-значение.
EnumeratesValues whereInStrict(string $key, Arrayable|iterable $values)
Фильтровать элементы по заданной паре ключ-значение с использованием строгого сравнения.
EnumeratesValues whereBetween(string $key, Arrayable|iterable $values)
Фильтровать элементы, для которых значение заданного ключа находится между заданными значениями.
EnumeratesValues whereNotBetween(string $key, Arrayable|iterable $values)
Фильтровать элементы таким образом, чтобы значение заданного ключа не находилось между заданными значениями.
EnumeratesValues whereNotIn(string $key, Arrayable|iterable $values, bool $strict = false)
Фильтровать элементы по заданной паре ключ-значение.
EnumeratesValues whereNotInStrict(string $key, Arrayable|iterable $values)
Фильтровать элементы по заданной паре ключ-значение с использованием строгого сравнения.
whereInstanceOf($type)
Без описания
TPipeReturnType pipe(callable $callback)
Передать коллекцию в заданный обратный вызов и вернуть результат.
TPipeIntoValue pipeInto(TPipeIntoValue> $class)
Передать коллекцию в новый класс.
mixed pipeThrough(callable[] $callbacks)
Пропустить коллекцию через серию обратных вызовов-фильтров и вернуть результат.
TReduceReturnType reduce(callable $callback, TReduceInitial $initial = null)
Свести коллекцию к одному значению.
array reduceSpread(callable $callback, mixed ...$initial)
Свести коллекцию к нескольким агрегированным значениям.
TReduceWithKeysReturnType reduceWithKeys(callable $callback, TReduceWithKeysInitial $initial = null)
Свести ассоциативную коллекцию к одному значению.
EnumeratesValues reject($callback = true)
Создать коллекцию всех элементов, которые не проходят заданный тест истинности.
$this tap(callable $callback)
Передать коллекцию в заданный обратный вызов, а затем вернуть её.
Enumerable unique($key = null, bool $strict = false)
Возвратить только уникальные элементы из массива коллекции.
EnumeratesValues uniqueStrict($key = null)
Возвратить только уникальные элементы из массива коллекции с использованием строгого сравнения.
TValue> collect()
Собрать значения в коллекцию.
toArray()
Без описания
array jsonSerialize()
Без описания
string toJson(int $options = 0)
Получить коллекцию элементов в формате JSON.
CachingIterator getCachingIterator(int $flags = CachingIterator::CALL_TOSTRING)
Получить экземпляр CachingIterator.
строка __toString()
Преобразовать коллекцию в её строковое представление.
$this escapeWhenCastingToString(bool $escape = true)
Указать, что строковое представление модели должно быть экранировано при вызове __toString.
статический пусто proxy(строка $method)
Добавить метод в список прокси-методов.
смешанный __get(строка $key)
Динамичный доступ к прокси-коллекциям.
защищённый getArrayableItems($items)
Без описания
защищённый Замыкание operatorForWhere(вызываемый|строка $key, строка|null $operator = null, смешанный $value = null)
Получить обратный вызов проверки оператора.
защищённый bool useAsCallable(смешанный $value)
Определить, является ли заданное значение вызываемым, но не строкой.
защищённый вызываемый valueRetriever(вызываемый|строка|null $value)
Получить вызываемый объект для извлечения значений.
защищённый equality(смешанный $value)
Создать функцию для проверки равенства элемента.
защищённый Замыкание negate(Замыкание $callback)
Создать функцию, используя другую функцию, инвертируя её результат.
защищённый identity()
Создать функцию, которая возвращает то, что ей передано.
статический пусто macro(строка $name, объект|вызываемый $macro)
Зарегистрировать пользовательский макрос.
статический пусто mixin(объект $mixin, bool $replace = true)
Включить другой объект в класс.
статический bool hasMacro(строка $name)
Проверяет, зарегистрирован ли макрос.
статический пусто flushMacros()
Очистить существующие макросы.
статический смешанный __callStatic(строка $method, массив $parameters)
Динамически обрабатывать вызовы класса.
смешанный __call(строка $method, массив $parameters)
Динамически обрабатывать вызовы класса.
пусто __construct(TValue>|TValue>|null $items = [])
Создать новую коллекцию.
статический Enumerable range(целое $from, целое $to)
Без описания
массив all()
Без описания
TValue> lazy()
Получить ленивую коллекцию для элементов в этой коллекции.
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 contains($key, mixed $operator = null, mixed $value = null)
Определить, существует ли элемент в коллекции.
bool containsStrict($key, TValue|null $value = null)
Определить, существует ли элемент, используя строгое сравнение.
bool doesntContain(mixed $key, mixed $operator = null, mixed $value = null)
Определить, не содержится ли элемент в коллекции.
crossJoin(...$lists)
Описание отсутствует
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)
Получить дублируемые элементы из коллекции, используя строгое сравнение.
protected duplicateComparator(bool $strict)
Получить функцию сравнения для обнаружения дубликатов.
Enumerable except(TKey>|TKey> $keys)
Получить все элементы, кроме тех, у которых указаны ключи.
Enumerable filter(callable|null $callback = null)
Применить фильтр к каждому из элементов.
first(callable|null $callback = null, $default = null)
Описание отсутствует
Enumerable flatten(int $depth = INF)
Без описания
flip()
Без описания
$this forget($keys)
Удаляет элемент из коллекции по ключу.
\Illuminate\Contracts\Support\Arrayable<array-key, TValue>|iterable<array-key, TKey>|TKey $keys
get($key, $default = null)
Без описания
getOrPut($key, $value)
Без описания
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 containsOneItem()
Определяет, содержит ли коллекция один элемент.
string join(string $glue, string $finalGlue = '')
Объединяет все элементы из коллекции, используя строку. Для конечных элементов можно использовать отдельную строку склеивания.
keys()
Без описания
last(callable|null $callback = null, $default = null)
Без описания
pluck($value, $key = null)
Без описания
map(callable $callback)
Без описания
mapToDictionary(callable $callback)
Без описания
mapWithKeys(callable $callback)
Без описания
Enumerable merge(TValue>|TValue> $items)
Объединить коллекцию с заданными элементами.
mergeRecursive($items)
Описание отсутствует
Collection multiply(int $multiplier)
Умножить элементы в коллекции на множитель.
combine($values)
Описание отсутствует
Enumerable union(TValue>|TValue> $items)
Объединить коллекцию с заданными элементами.
Enumerable nth(int $step, int $offset = 0)
Создать новую коллекцию, состоящую из каждого n-го элемента.
Enumerable only(TKey>|TKey>|string $keys)
Получить элементы со заданными ключами.
Collection select(TKey>|TKey>|string|null $keys)
Выбрать определенные значения из элементов в коллекции.
pop($count = 1)
Описание отсутствует
$this prepend(TValue $value, TKey $key = null)
Добавить элемент в начало коллекции.
$this push(TValue ...$values)
Добавить один или несколько элементов в конец коллекции.
$this unshift(TValue ...$values)
Добавить один или несколько элементов в начало коллекции.
concat($source)
Описание отсутствует
pull($key, $default = null)
Описание отсутствует
$this put(TKey $key, TValue $value)
Поместить элемент в коллекцию по ключу.
random($number = null, $preserveKeys = false)
Описание отсутствует
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)
Получить элемент, следующий за заданным.
shift($count = 1)
Описание отсутствует
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)
Описание отсутствует
splitIn($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)
Описание отсутствует
Enumerable sort($callback = null)
Сортировка каждого элемента с помощью обратного вызова.
Enumerable sortDesc(int $options = SORT_REGULAR)
Сортировка элементов в порядке убывания.
Enumerable sortBy($callback, int $options = SORT_REGULAR, bool $descending = false)
Сортировка коллекции с помощью заданного обратного вызова.
protected Collection sortByMany(array $comparisons = [], int $options = SORT_REGULAR)
Сортировка коллекции с использованием нескольких сравнений.
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)
Сортировка ключей коллекции с помощью обратного вызова.
Collection splice(int $offset, int|null $length = null, TValue> $replacement = [])
Вставка части массива подлежащей коллекции.
Enumerable take(int $limit)
Получение первых или последних {$limit} элементов.
Enumerable takeUntil($value)
Получение элементов из коллекции до тех пор, пока выполняется заданное условие.
Enumerable takeWhile($value)
Получение элементов из коллекции, пока выполняется заданное условие.
$this transform(callable $callback)
Преобразование каждого элемента в коллекции с помощью обратного вызова.
Collection dot()
Разворачивание многомерного ассоциативного массива с точками.
Enumerable undot()
Преобразование развёрнутого массива в «точечной» записи в расширенный массив.
values()
Без описания
zip($items)
Без описания
pad($size, $value)
Без описания
Traversable getIterator()
Получить итератор для элементов.
int count()
Подсчет количества элементов в коллекции.
countBy($countBy = null)
Без описания
$this add(TValue $item)
Добавление элемента в коллекцию.
TValue> toBase()
Получение базового экземпляра поддержки коллекции из этой коллекции.
bool offsetExists(TKey $key)
Определение наличия элемента по индексу.
mixed offsetGet(TKey $key)
Получение элемента по указанному индексу.
void offsetSet(TKey|null $key, TValue $value)
Установка элемента по указанному индексу.
void offsetUnset(TKey $key)
Удаление элемента по указанному индексу.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Support/Collection.html