Коллекция
класс Коллекция расширяет Коллекцию и реализует QueueableCollection (Просмотр исходного кода)
Трейты
| EnumeratesValues | |
| Macroable | |
| Conditionable |
Свойства
| HigherOrderCollectionProxy только для чтения | $unique | из EnumeratesValues | |
| HigherOrderCollectionProxy только для чтения | $unless | из EnumeratesValues | |
| HigherOrderCollectionProxy только для чтения | $until | из EnumeratesValues | |
| HigherOrderCollectionProxy только для чтения | $when | из EnumeratesValues | |
| static protected array | $macros | Зарегистрированные строковые макросы. | из Macroable |
| protected | $items | из Collection |
Методы
| $this|TWhenReturnType | when($value = null, callable $callback = null, callable $default = null)
Применить обратный вызов, если заданное "значение" истинно (или разрешается до истинного). | из Conditionable |
| $this|TUnlessReturnType | unless($value = null, callable $callback = null, callable $default = null)
Применить обратный вызов, если заданное "значение" ложно (или разрешается до ложного). | из Conditionable |
| static | make($items = []) Без описания | из EnumeratesValues |
| static | wrap($value) Без описания | из EnumeratesValues |
| static | unwrap($value) Без описания | из EnumeratesValues |
| static EnumeratesValues | empty()
Создать новый экземпляр без элементов. | из EnumeratesValues |
| static | times($number, callable $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()
Вывести элементы. | из 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 |
| mixed | value(string $key, mixed $default = null)
Получить значение одного ключа из первого соответствующего элемента в коллекции. | из 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 | |
| mixed | sum($callback = null)
Получить сумму заданных значений. | из EnumeratesValues |
| $this|TWhenEmptyReturnType | whenEmpty(callable $callback, callable $default = null)
Применить обратный вызов, если коллекция пуста. | из EnumeratesValues |
| $this|TWhenNotEmptyReturnType | whenNotEmpty(callable $callback, callable $default = null)
Применить обратный вызов, если коллекция не пуста. | из EnumeratesValues |
| $this|TUnlessEmptyReturnType | unlessEmpty(callable $callback, callable $default = null)
Применить обратный вызов, если коллекция не пуста. | из EnumeratesValues |
| $this|TUnlessNotEmptyReturnType | unlessNotEmpty(callable $callback, callable $default = null)
Применить обратный вызов, если коллекция пуста. | из EnumeratesValues |
| EnumeratesValues | where(callable|string $key, mixed $operator = null, mixed $value = null)
Фильтр элементов по заданной паре ключ-значение. | из EnumeratesValues |
| EnumeratesValues | whereNull(string|null $key = null)
Фильтровать элементы, где значение для данного ключа равно null. | из EnumeratesValues |
| EnumeratesValues | whereNotNull(string|null $key = null)
Фильтровать элементы, где значение для данного ключа не равно null. | из EnumeratesValues |
| EnumeratesValues | whereStrict(string $key, mixed $value)
Фильтр элементов по заданной паре ключ-значение с использованием строгого сравнения. | из EnumeratesValues |
| EnumeratesValues | whereIn(string $key, Arrayable|iterable $values, bool $strict = false)
Фильтровать элементы по заданной паре ключ-значение. | из EnumeratesValues |
| EnumeratesValues | whereInStrict(string $key, Arrayable|iterable $values)
Фильтровать элементы по заданной паре ключ-значение с использованием строгого сравнения. | из EnumeratesValues |
| EnumeratesValues | whereBetween(string $key, Arrayable|iterable $values)
Фильтровать элементы, где значение данного ключа находится между заданными значениями. | из EnumeratesValues |
| EnumeratesValues | whereNotBetween(string $key, Arrayable|iterable $values)
Фильтровать элементы, где значение данного ключа не находится между заданными значениями. | из EnumeratesValues |
| EnumeratesValues | whereNotIn(string $key, Arrayable|iterable $values, bool $strict = false)
Фильтровать элементы по заданной паре ключ-значение. | из EnumeratesValues |
| EnumeratesValues | whereNotInStrict(string $key, Arrayable|iterable $values)
Фильтровать элементы по заданной паре ключ-значение с использованием строгого сравнения. | из EnumeratesValues |
| whereInstanceOf($type) Без описания | из EnumeratesValues | |
| TPipeReturnType | pipe(callable $callback)
Передать коллекцию в заданный обратный вызов и вернуть результат. | из EnumeratesValues |
| mixed | pipeInto(class-string $class)
Передать коллекцию в новый класс. | из EnumeratesValues |
| mixed | pipeThrough(callable[] $callbacks)
Пропустить коллекцию через серию вызываемых труб и вернуть результат. | из EnumeratesValues |
| TReduceReturnType | reduce(callable $callback, TReduceInitial $initial = null)
Свести коллекцию к одному значению. | из EnumeratesValues |
| array | reduceSpread(callable $callback, mixed ...$initial)
Свести коллекцию к нескольким агрегированным значениям. | из EnumeratesValues |
| EnumeratesValues | reject($callback = true)
Создать коллекцию всех элементов, которые не проходят заданный тест истинности. | из EnumeratesValues |
| $this | tap(callable $callback)
Передать коллекцию в заданный обратный вызов, а затем вернуть её. | из EnumeratesValues |
| Enumerable | unique($key = null, bool $strict = false) Без описания | |
| EnumeratesValues | uniqueStrict($key = null)
Возвратить только уникальные элементы из массива коллекции, используя строгое сравнение. | из EnumeratesValues |
| TValue> | collect()
Собрать значения в коллекцию. | из EnumeratesValues |
| toArray() Без описания | из EnumeratesValues | |
| array | jsonSerialize() Без описания | из EnumeratesValues |
| string | toJson(int $options = 0)
Получить коллекцию элементов в формате JSON. | из EnumeratesValues |
| CachingIterator | getCachingIterator(int $flags = CachingIterator::CALL_TOSTRING)
Получить экземпляр CachingIterator. | из EnumeratesValues |
| строка | __toString()
Преобразовать коллекцию в строковое представление. | из EnumeratesValues |
| $this | escapeWhenCastingToString(bool $escape = true)
Указать, что строковое представление модели должно быть экранировано при вызове __toString. | из EnumeratesValues |
| статический void | proxy(string $method)
Добавить метод в список проксированных методов. | из EnumeratesValues |
| смешанный | __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 | |
| статический void | macro(string $name, object|callable $macro)
Зарегистрировать пользовательское макрос. | из Macroable |
| статический void | mixin(object $mixin, bool $replace = true)
Вмешать другой объект в класс. | из Macroable |
| статический bool | hasMacro(string $name)
Проверяет, зарегистрировано ли макрос. | из Macroable |
| статический void | flushMacros()
Очистить существующие макросы. | из Macroable |
| статический смешанный | __callStatic(string $method, array $parameters)
Динамическое обращение к классу. | из Macroable |
| смешанный | __call(string $method, array $parameters)
Динамическое обращение к классу. | из Macroable |
| void | __construct(TValue>|TValue>|null $items = [])
Создать новую коллекцию. | из Collection |
| статический Enumerable | range(int $from, int $to) Без описания | из Collection |
| массив | all() Без описания | из Collection |
| TValue> | lazy()
Получить ленивую коллекцию для элементов в этой коллекции. | из Collection |
| float|int|null | avg($callback = null)
Получить среднее значение заданного ключа. | из Collection |
| float|int|null | median(string|array<array-key,string>|null $key = null)
Получить медиану заданного ключа. | из Collection |
| array<int,float|int>|null | mode(string|array<array-key,string>|null $key = null)
Получить моду заданного ключа. | из Collection |
| collapse()
Сжатие коллекции элементов в один массив. | ||
| bool | contains($key, mixed $operator = null, mixed $value = null)
Определить, существует ли ключ в коллекции. | |
| bool | containsStrict($key, TValue|null $value = null)
Определить, существует ли элемент, используя строгое сравнение. | из Collection |
| bool | doesntContain(mixed $key, mixed $operator = null, mixed $value = null)
Определить, не содержится ли элемент в коллекции. | из Collection |
| crossJoin(...$lists) Без описания | из Collection | |
| Enumerable | diff(TValue>|TValue> $items)
Разность между коллекцией и заданными элементами. |
| Перечисляемый | diffUsing(TValue>|TValue> $items, callable $callback)
Получить элементы в коллекции, которые отсутствуют в заданных элементах, используя обратный вызов. | из Коллекции |
| Перечисляемый | diffAssoc(TValue>|TValue> $items)
Получить элементы в коллекции, ключи и значения которых отсутствуют в заданных элементах. | из Коллекции |
| Перечисляемый | diffAssocUsing(TValue>|TValue> $items, callable $callback)
Получить элементы в коллекции, ключи и значения которых отсутствуют в заданных элементах, используя обратный вызов. | из Коллекции |
| Перечисляемый | diffKeys(TValue>|TValue> $items)
Получить элементы в коллекции, ключи которых отсутствуют в заданных элементах. | из Коллекции |
| Перечисляемый | diffKeysUsing(TValue>|TValue> $items, callable $callback)
Получить элементы в коллекции, ключи которых отсутствуют в заданных элементах, используя обратный вызов. | из Коллекции |
| Перечисляемый | duplicates($callback = null, bool $strict = false)
Получить дублируемые элементы из коллекции. | из Коллекции |
| Перечисляемый | duplicatesStrict($callback = null)
Получить дублируемые элементы из коллекции, используя строгое сравнение. | из Коллекции |
| duplicateComparator(bool $strict)
Получить функцию сравнения для определения дубликатов. | ||
| Перечисляемый | except(TKey>|TKey> $keys) Без описания | |
| Перечисляемый | filter(callable $callback = null)
Выполнить фильтрацию каждого из элементов. | из Коллекции |
| first(callable $callback = null, $default = null) Без описания | из Коллекции | |
| Перечисляемый | flatten(int $depth = INF)
Получить сплющенную массив элементов в коллекции. | |
| flip()
Перевернуть элементы в коллекции. | ||
| $this | forget(TKey|TKey> $keys)
Удалить элемент из коллекции по ключу. | из Коллекции |
| get($key, $default = null) Без описания | из Коллекции | |
| mixed | getOrPut(mixed $key, mixed $value)
Получить элемент из коллекции по ключу или добавить его в коллекцию, если он не существует. | из Коллекции |
| groupBy($groupBy, $preserveKeys = false) Без описания | из Коллекции | |
| keyBy($keyBy) Без описания | из Коллекции | |
| bool | has(TKey|TKey> $key)
Определить, существует ли элемент в коллекции по ключу. | из Коллекции |
| bool | hasAny(mixed $key)
Определить, существуют ли какие-либо ключи в коллекции. | из Коллекции |
| string | implode(string $value, string|null $glue = null)
Конкатенация значений заданного ключа в строку. | из Коллекции |
| Перечисляемый | intersect(TValue>|TValue> $items)
Пересечение коллекции с заданными элементами. | |
| Коллекция | intersectUsing(TValue>|TValue> $items, callable $callback)
Пересечение коллекции с заданными элементами, используя обратный вызов. | из Коллекции |
| Коллекция | intersectAssoc(TValue>|TValue> $items)
Пересечение коллекции с заданными элементами с дополнительной проверкой индекса. | из Коллекции |
| Коллекция | intersectAssocUsing(TValue>|TValue> $items, callable $callback)
Пересечение коллекции с заданными элементами с дополнительной проверкой индекса, используя обратный вызов. | из Коллекции |
| Перечисляемый | intersectByKeys(TValue>|TValue> $items)
Пересечение коллекции с заданными элементами по ключу. | из Коллекции |
| bool | isEmpty()
Определить, пуста ли коллекция. | из Коллекции |
| bool | containsOneItem()
Определить, содержит ли коллекция один элемент. | из Коллекции |
| string | join(string $glue, string $finalGlue = '')
Объединение всех элементов коллекции с помощью строки. Для последних элементов можно использовать отдельную строку разделителя. | из Коллекции |
| keys()
Получить ключи элементов коллекции. | ||
| last(callable $callback = null, $default = null) Без описания | из Коллекции |
| pluck($value, $key = null)
Получить массив со значениями заданного ключа. | ||
| map(callable $callback) Описание отсутствует | ||
| mapToDictionary(callable $callback) Описание отсутствует | из Collection | |
| mapWithKeys(callable $callback) Описание отсутствует | ||
| Enumerable | merge(TValue>|TValue> $items)
Объединить коллекцию с заданными элементами. | |
| mergeRecursive($items) Описание отсутствует | из Collection | |
| combine($values) Описание отсутствует | из Collection | |
| Enumerable | union(TValue>|TValue> $items)
Объединить коллекцию с заданными элементами. | из Collection |
| Enumerable | nth(int $step, int $offset = 0)
Создать новую коллекцию, состоящую из каждого n-го элемента. | из Collection |
| Enumerable | only(TKey>|TKey>|string $keys) Описание отсутствует | |
| pop($count = 1) Описание отсутствует | из Collection | |
| $this | prepend(TValue $value, TKey $key = null)
Добавить элемент в начало коллекции. | из Collection |
| $this | push(TValue ...$values)
Добавить один или несколько элементов в конец коллекции. | из Collection |
| Enumerable | concat(TValue> $source)
Добавить все заданные элементы в коллекцию. | из Collection |
| pull($key, $default = null) Описание отсутствует | из Collection | |
| $this | put(TKey $key, TValue $value)
Поместить элемент в коллекцию по ключу. | из Collection |
| random($number = null) Описание отсутствует | из Collection | |
| Enumerable | replace(TValue>|TValue> $items)
Заменить элементы коллекции заданными элементами. | из Collection |
| Enumerable | replaceRecursive(TValue>|TValue> $items)
Рекурсивно заменить элементы коллекции заданными элементами. | из Collection |
| Enumerable | reverse()
Инвертировать порядок элементов. | из Collection |
| TKey|bool | search($value, bool $strict = false)
Найти значение в коллекции и вернуть соответствующий ключ, если поиск успешен. | из Collection |
| shift($count = 1) Описание отсутствует | из Collection | |
| Enumerable | shuffle(int|null $seed = null)
Перемешать элементы в коллекции. | из Collection |
| sliding($size = 2, $step = 1) Описание отсутствует | из Collection | |
| Enumerable | skip(int $count)
Пропустить первые {$count} элементов. | из Collection |
| Enumerable | skipUntil($value)
Пропустить элементы в коллекции до тех пор, пока не будет выполнено заданное условие. | из Collection |
| Enumerable | skipWhile($value)
Пропустить элементы в коллекции, пока выполняется заданное условие. | из Collection |
| Enumerable | slice(int $offset, int|null $length = null)
Вырезать фрагмент из основного массива коллекции. | из Collection |
| split($numberOfGroups) Описание отсутствует | из Collection | |
| splitIn($numberOfGroups) Описание отсутствует | из Collection | |
| TValue | sole($key = null, mixed $operator = null, mixed $value = null)
Получить первый элемент в коллекции, но только если элементов ровно один. В противном случае выбросить исключение. | из Collection |
| TValue | firstOrFail($key = null, mixed $operator = null, mixed $value = null)
Получить первый элемент в коллекции, но выбросить исключение, если соответствующих элементов нет. | из Collection |
| chunk($size) Описание отсутствует | из Collection | |
| chunkWhile(callable $callback) Описание отсутствует | из Collection |
| Enumerable | sort($callback = null)
Сортировка каждого элемента с помощью обратного вызова. | из Коллекции |
| Enumerable | sortDesc(int $options = SORT_REGULAR)
Сортировка элементов в порядке убывания. | из Коллекции |
| Enumerable | sortBy($callback, int $options = SORT_REGULAR, bool $descending = false)
Сортировка коллекции с помощью заданного обратного вызова. | из Коллекции |
| Коллекция | sortByMany(array $comparisons = [])
Сортировка коллекции с использованием нескольких сравнений. | из Коллекции |
| 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)
Сортировка ключей коллекции с помощью обратного вызова. | из Коллекции |
| Коллекция | splice(int $offset, int|null $length = null, TValue> $replacement = [])
Вставка в массив коллекции. | из Коллекции |
| Enumerable | take(int $limit)
Взять первые или последние {$limit} элементов. | из Коллекции |
| Enumerable | takeUntil($value)
Взять элементы в коллекции до тех пор, пока не выполнится заданное условие. | из Коллекции |
| Enumerable | takeWhile($value)
Взять элементы в коллекции, пока выполняется заданное условие. | из Коллекции |
| $this | transform(callable $callback)
Преобразование каждого элемента в коллекции с помощью обратного вызова. | из Коллекции |
| 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)
Удаление элемента по заданному смещению. | из Коллекции |
| find($key, $default = null) Без описания | ||
| $this | load($relations)
Загрузка набора отношений в коллекцию. | |
| $this | loadAggregate($relations, string $column, string|null $function = null)
Загрузка агрегатов по полю отношения в коллекцию. | |
| $this | loadCount($relations)
Загрузка количества отношений в коллекцию. | |
| $this | loadMax($relations, string $column)
Загрузка максимальных значений поля отношения в коллекцию. | |
| $this | loadMin($relations, string $column)
Загрузка минимальных значений поля отношения в коллекцию. | |
| $this | loadSum($relations, string $column)
Загрузка сумм значений поля отношения в коллекцию. | |
| $this | loadAvg($relations, string $column)
Загрузка средних значений поля отношения в коллекцию. |
| $this | loadExists($relations)
Загрузить набор связанных сущностей в коллекцию. | |
| $this | loadMissing($relations)
Загрузить набор отношений в коллекцию, если они ещё не загружены с помощью eager loading. | |
| void | loadMissingRelation(Collection $models, array $path)
Загрузить путь к отношению, если он ещё не загружен с помощью eager loading. | |
| $this | loadMorph(string $relation, $relations)
Загрузить набор отношений в коллекцию смешанных отношений. | |
| $this | loadMorphCount(string $relation, $relations)
Загрузить набор подсчётов отношений в коллекцию смешанных отношений. | |
| array<int,array-key> | modelKeys()
Получить массив первичных ключей. | |
| Collection | fresh(array<array-key,string>|string $with = [])
Перезагрузить свежие экземпляры моделей из базы данных для всех сущностей. | |
| $this | makeHidden(array<array-key,string>|string $attributes)
Скрыть заданные, обычно видимые, атрибуты для всей коллекции. | |
| $this | makeVisible(array<array-key,string>|string $attributes)
Сделать заданные, обычно скрытые, атрибуты видимыми для всей коллекции. | |
| $this | setVisible(array<int,string> $visible)
Установить видимые атрибуты для всей коллекции. | |
| $this | setHidden(array<int,string> $hidden)
Установить скрытые атрибуты для всей коллекции. | |
| $this | append(array<array-key,string>|string $attributes)
Добавить атрибут ко всей коллекции. | |
| TModel> | getDictionary(TModel>|null $items = null)
Получить словарь, ключами которого являются первичные ключи. | |
| string|null | getQueueableClass()
Получить тип сущностей, которые будут помещены в очередь. | |
| string | getQueueableModelClass(Model $model)
Получить имя класса, который можно поместить в очередь, для данной модели. | |
| array<int,mixed> | getQueueableIds()
Получить идентификаторы всех сущностей. | |
| array<int,string> | getQueueableRelations()
Получить отношения сущностей, которые будут помещены в очередь. | |
| string|null | getQueueableConnection()
Получить соединение сущностей, которые будут помещены в очередь. | |
| Builder | toQuery()
Получить Eloquent запрос из коллекции. |
Подробности
$this|TWhenReturnType when($value = null, callable $callback = null, callable $default = null)
Применить коллбэк, если заданное «значение» истинно.
$this|TUnlessReturnType unless($value = null, callable $callback = null, callable $default = null)
Применить коллбэк, если заданное «значение» ложно.
static make($items = [])
Без описания
static wrap($value)
Без описания
static unwrap($value)
Без описания
static EnumeratesValues empty()
Создать новый экземпляр без элементов.
static times($number, callable $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()
Вывести элементы.
$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)
Получить первый элемент по заданной паре ключ-значение.
mixed value(string $key, mixed $default = null)
Получить значение одного ключа из первого совпадающего элемента в коллекции.
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)
Без описания
mixed sum($callback = null)
Получить сумму заданных значений.
$this|TWhenEmptyReturnType whenEmpty(callable $callback, callable $default = null)
Применить обратный вызов, если коллекция пуста.
$this|TWhenNotEmptyReturnType whenNotEmpty(callable $callback, callable $default = null)
Применить обратный вызов, если коллекция не пуста.
$this|TUnlessEmptyReturnType unlessEmpty(callable $callback, callable $default = null)
Применить обратный вызов, если коллекция не пуста.
$this|TUnlessNotEmptyReturnType unlessNotEmpty(callable $callback, callable $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)
Передать коллекцию заданному вызову функции и вернуть результат.
mixed pipeInto(class-string $class)
Передать коллекцию в новый класс.
mixed pipeThrough(callable[] $callbacks)
Передать коллекцию через серию вызовов функций и вернуть результат.
TReduceReturnType reduce(callable $callback, TReduceInitial $initial = null)
Свести коллекцию к одному значению.
array reduceSpread(callable $callback, mixed ...$initial)
Свести коллекцию к нескольким агрегированным значениям.
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.
string __toString()
Преобразовать коллекцию в ее строковое представление.
$this escapeWhenCastingToString(bool $escape = true)
Указать, что строковое представление модели должно быть экранировано при вызове __toString.
static void proxy(string $method)
Добавить метод в список проксируемых методов.
mixed __get(string $key)
Динамический доступ к проксиям коллекции.
protected getArrayableItems($items)
Описание отсутствует
protected Closure operatorForWhere(callable|string $key, string|null $operator = null, mixed $value = null)
Получить обратный вызов для проверки оператора.
protected bool useAsCallable(mixed $value)
Определить, является ли заданное значение вызываемым, но не строкой.
protected callable valueRetriever(callable|string|null $value)
Получить обратный вызов для получения значения.
protected equality(mixed $value)
Создать функцию для проверки равенства элемента.
protected Closure negate(Closure $callback)
Создать функцию, используя другую функцию, инвертировав ее результат.
protected identity()
Создать функцию, которая возвращает то, что передано ей.
static void macro(string $name, object|callable $macro)
Зарегистрировать пользовательское макро.
static void mixin(object $mixin, bool $replace = true)
Смешать другую объект в класс.
static bool hasMacro(string $name)
Проверяет, зарегистрировано ли макро.
static void flushMacros()
Очистить существующие макросы.
static mixed __callStatic(string $method, array $parameters)
Динамически обрабатывать вызовы к классу.
mixed __call(string $method, array $parameters)
Динамически обрабатывать вызовы к классу.
void __construct(TValue>|TValue>|null $items = [])
Создать новую коллекцию.
static Enumerable range(int $from, int $to)
Описание отсутствует
array all()
Описание отсутствует
TValue> lazy()
Получить ленивую коллекцию элементов в этой коллекции.
float|int|null avg($callback = null)
Получить среднее значение заданного ключа.
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 $callback = null)
Применить фильтр к каждому элементу.
first(callable $callback = null, $default = null)
Нет описания
Enumerable flatten(int $depth = INF)
Получить плоский массив элементов в коллекции.
flip()
Поменять местами ключи и значения в коллекции.
$this forget(TKey|TKey> $keys)
Удалить элемент из коллекции по ключу.
get($key, $default = null)
Нет описания
mixed getOrPut(mixed $key, mixed $value)
Получить элемент из коллекции по ключу или добавить его в коллекцию, если он не существует.
groupBy($groupBy, $preserveKeys = false)
Нет описания
keyBy($keyBy)
Нет описания
bool has(TKey|TKey> $key)
Определить, существует ли элемент в коллекции по ключу.
bool hasAny(mixed $key)
Определить, существуют ли какие-либо ключи в коллекции.
string implode(string $value, string|null $glue = null)
Объединить значения заданного ключа в строку.
Enumerable intersect(TValue>|TValue> $items)
Пересечь коллекцию с заданными элементами.
Collection intersectUsing(TValue>|TValue> $items, callable $callback)
Пересечь коллекцию с заданными элементами, используя обратный вызов.
Collection intersectAssoc(TValue>|TValue> $items)
Пересечь коллекцию с заданными элементами, проверив дополнительные индексы.
Коллекция intersectAssocUsing(TValue>|TValue> $items, callable $callback)
Пересечение коллекции с заданными элементами с дополнительной проверкой индекса, используя обратный вызов.
Перечисляемый intersectByKeys(TValue>|TValue> $items)
Пересечение коллекции с заданными элементами по ключу.
bool isEmpty()
Определение пустой ли коллекция.
bool containsOneItem()
Определение содержит ли коллекция один элемент.
string join(string $glue, string $finalGlue = '')
Объединение всех элементов коллекции с использованием строки. Для последних элементов может быть использована отдельная строка склеивания.
keys()
Получение ключей элементов коллекции.
last(callable $callback = null, $default = null)
Без описания
pluck($value, $key = null)
Получение массива со значениями заданного ключа.
map(callable $callback)
Без описания
mapToDictionary(callable $callback)
Без описания
mapWithKeys(callable $callback)
Без описания
Перечисляемый merge(TValue>|TValue> $items)
Объединение коллекции с заданными элементами.
mergeRecursive($items)
Без описания
combine($values)
Без описания
Перечисляемый union(TValue>|TValue> $items)
Объединение коллекции с заданными элементами.
Перечисляемый nth(int $step, int $offset = 0)
Создание новой коллекции, содержащей каждый n-ый элемент.
Перечисляемый only(TKey>|TKey>|string $keys)
Без описания
pop($count = 1)
Без описания
$this prepend(TValue $value, TKey $key = null)
Добавление элемента в начало коллекции.
$this push(TValue ...$values)
Добавление одного или нескольких элементов в конец коллекции.
Перечисляемый concat(TValue> $source)
Добавление всех заданных элементов в коллекцию.
pull($key, $default = null)
Без описания
$this put(TKey $key, TValue $value)
Установка элемента в коллекцию по ключу.
random($number = null)
Без описания
Enumerable replace(TValue>|TValue> $items)
Заменить элементы коллекции на заданные.
Enumerable replaceRecursive(TValue>|TValue> $items)
Рекурсивно заменить элементы коллекции на заданные.
Enumerable reverse()
Изменить порядок элементов на обратный.
TKey|bool search($value, bool $strict = false)
Поиск значения в коллекции и возврат соответствующего ключа, если найден.
shift($count = 1)
Без описания
Enumerable shuffle(int|null $seed = null)
Перемешать элементы в коллекции.
sliding($size = 2, $step = 1)
Без описания
Enumerable skip(int $count)
Пропустить первые {$count} элементов.
Enumerable skipUntil($value)
Пропустить элементы в коллекции до тех пор, пока не будет выполнено заданное условие.
Enumerable skipWhile($value)
Пропустить элементы в коллекции, пока выполняется заданное условие.
Enumerable slice(int $offset, int|null $length = null)
Выделить подмассив из коллекции.
split($numberOfGroups)
Без описания
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 = [])
Сортировать коллекцию, используя несколько сравнений.
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)
Преобразовать каждый элемент в коллекции с помощью обратного вызова.
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)
Удалить элемент по заданному смещению.
find($key, $default = null)
Описание отсутствует
$this load($relations)
Загрузить набор взаимосвязей в коллекцию.
$this loadAggregate($relations, string $column, string|null $function = null)
Загрузить набор агрегаций по столбцу взаимосвязи в коллекцию.
$this loadCount($relations)
Загрузить набор подсчетов взаимосвязей в коллекцию.
$this loadMax($relations, string $column)
Загрузить набор максимальных значений столбца взаимосвязи в коллекцию.
$this loadMin($relations, string $column)
Загрузить набор минимальных значений столбца взаимосвязи в коллекцию.
$this loadSum($relations, string $column)
Загрузить набор сумм значений столбца взаимосвязи в коллекцию.
$this loadAvg($relations, string $column)
Загрузить набор средних значений столбца взаимосвязи в коллекцию.
$this loadExists($relations)
Загрузить набор связанных сущностей в коллекцию.
$this loadMissing($relations)
Загрузить набор взаимосвязей в коллекцию, если они не были загружены заранее.
protected void loadMissingRelation(Collection $models, array $path)
Загрузить путь к взаимосвязи, если он не был загружен заранее.
$this loadMorph(string $relation, $relations)
Загрузить набор взаимосвязей в коллекцию смешанных взаимосвязей.
$this loadMorphCount(string $relation, $relations)
Загрузить набор подсчетов взаимосвязей в коллекцию смешанных взаимосвязей.
array<int,array-key> modelKeys()
Получить массив первичных ключей.
Collection fresh(array<array-key,string>|string $with = [])
Перезагрузить свежий экземпляр модели из базы данных для всех сущностей.
$this makeHidden(array<array-key,string>|string $attributes)
Скрыть заданные атрибуты, которые обычно видны, для всей коллекции.
$this makeVisible(array<array-key,string>|string $attributes)
Сделать заданные атрибуты, которые обычно скрыты, видимыми для всей коллекции.
$this setVisible(array<int,string> $visible)
Установить видимые атрибуты для всей коллекции.
$this setHidden(array<int,string> $hidden)
Установите скрытые атрибуты для всего набора.
$this append(array<array-key,string>|string $attributes)
Добавить атрибут ко всему набору.
TModel> getDictionary(TModel>|null $items = null)
Получить словарь, индексированный по первичным ключам.
string|null getQueueableClass()
Получить тип сущностей, которые будут помещены в очередь.
protected string getQueueableModelClass(Model $model)
Получить имя класса для сущностей, которые будут помещены в очередь, для заданной модели.
array<int,mixed> getQueueableIds()
Получить идентификаторы всех сущностей.
array<int,string> getQueueableRelations()
Получить связи сущностей, которые будут помещены в очередь.
string|null getQueueableConnection()
Получить подключение к базе данных для сущностей, которые будут помещены в очередь.
Builder toQuery()
Получить Eloquent-объект Query Builder из коллекции.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/9.x/Illuminate/Database/Eloquent/Collection.html
