Коллекция
класс Коллекция расширяет Коллекцию и реализует Интерфейс очереди (Просмотреть исходный код)
Трейты
| Взаимодействие со словарем | |
| Перечисляет значения | |
| Макросовместимый | |
| Условный |
Свойства
| HigherOrderCollectionProxy только для чтения | $takeWhile | из EnumeratesValues | |
| 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 |
| 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 $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 |
| TPipeIntoValue | pipeInto(TPipeIntoValue> $class)
Передать коллекцию в новый класс. | из EnumeratesValues |
| mixed | pipeThrough(callable[] $callbacks)
Пропустить коллекцию через ряд коллбэков-фильтров и вернуть результат. | из EnumeratesValues |
| TReduceReturnType | reduce(callable $callback, TReduceInitial $initial = null)
Свести коллекцию к одному значению. | из EnumeratesValues |
| array | reduceSpread(callable $callback, mixed ...$initial)
Свести коллекцию к нескольким агрегированным значениям. | из EnumeratesValues |
| TReduceWithKeysReturnType | reduceWithKeys(callable $callback, TReduceWithKeysInitial $initial = null)
Свести ассоциативную коллекцию к одному значению. | из 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 | |
| массив | jsonSerialize() Без описания | из EnumeratesValues |
| строка | toJson(int $options = 0)
Получить коллекцию элементов в формате JSON. | из EnumeratesValues |
| CachingIterator | getCachingIterator(int $flags = CachingIterator::CALL_TOSTRING)
Получить экземпляр CachingIterator. | из EnumeratesValues |
| строка | __toString()
Преобразовать коллекцию в строковое представление. | из EnumeratesValues |
| $this | escapeWhenCastingToString(bool $escape = true)
Указать, что строковое представление модели должно быть экранировано при вызове __toString. | из EnumeratesValues |
| static 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 | |
| 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 |
| смешанный тип | __call(string $method, array $parameters)
Динамическая обработка вызовов класса. | из Macroable |
| void | __construct(TValue>|TValue>|null $items = [])
Создать новую коллекцию. | из Collection |
| static 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)
Разность коллекции с заданными элементами. | |
| Enumerable | diffUsing(TValue>|TValue> $items, callable $callback)
Получить элементы в коллекции, которых нет в заданных элементах, используя функцию обратного вызова. | из Collection |
| Enumerable | diffAssoc(TValue>|TValue> $items)
Получить элементы в коллекции, у которых ключи и значения отсутствуют в заданных элементах. | из Collection |
| Enumerable | diffAssocUsing(TValue>|TValue> $items, callable $callback)
Получить элементы в коллекции, у которых ключи и значения отсутствуют в заданных элементах, используя функцию обратного вызова. | из Collection |
| Enumerable | diffKeys(TValue>|TValue> $items)
Получить элементы в коллекции, у которых ключи отсутствуют в заданных элементах. | из Collection |
| Enumerable | diffKeysUsing(TValue>|TValue> $items, callable $callback)
Получить элементы в коллекции, у которых ключи отсутствуют в заданных элементах, используя функцию обратного вызова. | из Collection |
| Enumerable | duplicates($callback = null, bool $strict = false)
Получить дубликаты элементов из коллекции. | из Collection |
| Enumerable | duplicatesStrict($callback = null)
Получить дубликаты элементов из коллекции, используя строгое сравнение. | из Collection |
| duplicateComparator(bool $strict)
Получить функцию сравнения для обнаружения дубликатов. | ||
| Enumerable | except(TKey>|TKey> $keys) Описание отсутствует | |
| Enumerable | filter(callable $callback = null)
Применить фильтр к каждому элементу. | из Collection |
| first(callable $callback = null, $default = null) Описание отсутствует | из Collection | |
| Enumerable | flatten(int $depth = INF)
Получить сплющенную массив элементов коллекции. | |
| flip()
Перевернуть элементы в коллекции. | ||
| $this | forget($keys)
Удалить элемент из коллекции по ключу. | из Collection |
| get($key, $default = null) Описание отсутствует | из Collection | |
| getOrPut($key, $value) Описание отсутствует | из Collection | |
| groupBy($groupBy, $preserveKeys = false) Описание отсутствует | из Collection | |
| keyBy($keyBy) Описание отсутствует | из Collection | |
| bool | has(TKey|TKey> $key)
Определить, существует ли элемент в коллекции по ключу. | из Collection |
| bool | hasAny(mixed $key)
Определить, существуют ли какие-либо ключи в коллекции. | из Collection |
| string | implode(callable|string $value, string|null $glue = null)
Конкатенировать значения заданного ключа в строку. | из Collection |
| Enumerable | intersect(TValue>|TValue> $items)
Пересечение коллекции с заданными элементами. | |
| Collection | intersectUsing(TValue>|TValue> $items, callable $callback)
Пересечение коллекции с заданными элементами, используя функцию обратного вызова. | из Collection |
| Collection | intersectAssoc(TValue>|TValue> $items)
Пересечение коллекции с заданными элементами с дополнительной проверкой индекса. | из Collection |
| Collection | intersectAssocUsing(TValue>|TValue> $items, callable $callback)
Пересечение коллекции с заданными элементами с дополнительной проверкой индекса, используя функцию обратного вызова. | из Collection |
| Enumerable | intersectByKeys(TValue>|TValue> $items)
Пересечение коллекции с заданными элементами по ключу. | из Collection |
| 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) Без описания | |
| Коллекция | select(TKey>|TKey>|string|null $keys)
Выбрать определенные значения из элементов в коллекции. | из Коллекции |
| pop($count = 1) Без описания | из Коллекции | |
| $this | prepend(TValue $value, TKey $key = null)
Добавить элемент в начало коллекции. | из Коллекции |
| $this | push(TValue ...$values)
Добавить один или несколько элементов в конец коллекции. | из Коллекции |
| concat($source) Без описания | из Коллекции | |
| pull($key, $default = null) Без описания | из Коллекции | |
| $this | put(TKey $key, TValue $value)
Поместить элемент в коллекцию по ключу. | из Коллекции |
| random($number = null, $preserveKeys = false) Без описания | из Коллекции | |
| Перечислимый | replace(TValue>|TValue> $items)
Заменить элементы коллекции заданными элементами. | из Коллекции |
| Перечислимый | replaceRecursive(TValue>|TValue> $items)
Рекурсивно заменить элементы коллекции заданными элементами. | из Коллекции |
| Перечислимый | reverse()
Инвертировать порядок элементов. | из Коллекции |
| TKey|bool | search($value, bool $strict = false)
Найти в коллекции заданное значение и вернуть соответствующий ключ, если поиск успешен. | из Коллекции |
| shift($count = 1) Без описания | из Коллекции | |
| Перечислимый | shuffle(int|null $seed = null)
Перемешать элементы в коллекции. | из Коллекции |
| sliding($size = 2, $step = 1) Без описания | из Коллекции | |
| Перечислимый | skip(int $count)
Пропустить первые {$count} элементов. | из Коллекции |
| Перечислимый | skipUntil($value)
Пропустить элементы в коллекции до тех пор, пока не будет выполнено заданное условие. | из Коллекции |
| Перечислимый | skipWhile($value)
Пропустить элементы в коллекции, пока выполняется заданное условие. | из Коллекции |
| Перечислимый | slice(int $offset, int|null $length = null)
Вырезать часть подлежащего массива коллекции. | из Коллекции |
| разделить($numberOfGroups) Описание отсутствует | из Коллекции | |
| разделитьНа($numberOfGroups) Описание отсутствует | из Коллекции | |
| TValue | единственный($key = null, mixed $operator = null, mixed $value = null)
Получить первый элемент в коллекции, только если существует ровно один элемент. В противном случае, выбросить исключение. | из Коллекции |
| TValue | первыйИлиОшибка($key = null, mixed $operator = null, mixed $value = null)
Получить первый элемент в коллекции, но выбросить исключение, если соответствующие элементы отсутствуют. | из Коллекции |
| разбитьНаЧасти($size) Описание отсутствует | из Коллекции | |
| разбитьПока(callable $callback) Описание отсутствует | из Коллекции | |
| Enumerable | сортировать($callback = null)
Отсортировать каждый элемент с помощью обратного вызова. | из Коллекции |
| Enumerable | сортироватьПоУбыванию(int $options = SORT_REGULAR)
Сортировать элементы в порядке убывания. | из Коллекции |
| Enumerable | сортироватьПо($callback, int $options = SORT_REGULAR, bool $descending = false)
Отсортировать коллекцию с помощью заданного обратного вызова. | из Коллекции |
| Коллекция | сортироватьПоНесколькимПараметрам(array $comparisons = [], int $options = SORT_REGULAR)
Отсортировать коллекцию, используя несколько сравнений. | из Коллекции |
| Enumerable | сортироватьПоУбываниюПо($callback, int $options = SORT_REGULAR)
Отсортировать коллекцию в порядке убывания с помощью заданного обратного вызова. | из Коллекции |
| Enumerable | сортироватьКлючи(int $options = SORT_REGULAR, bool $descending = false)
Сортировать ключи коллекции. | из Коллекции |
| Enumerable | сортироватьКлючиПоУбыванию(int $options = SORT_REGULAR)
Сортировать ключи коллекции в порядке убывания. | из Коллекции |
| Enumerable | сортироватьКлючиСОбратнымВызовом(callable $callback)
Сортировать ключи коллекции с помощью обратного вызова. | из Коллекции |
| Коллекция | вставить(int $offset, int|null $length = null, TValue> $replacement = [])
Вставить часть массива подлежащей коллекции. | из Коллекции |
| Enumerable | взятьПервые(int $limit)
Взять первые или последние {$limit} элементов. | из Коллекции |
| Enumerable | взятьДо($value)
Взять элементы в коллекции до тех пор, пока не будет выполнено заданное условие. | из Коллекции |
| Enumerable | взятьПока($value)
Взять элементы в коллекции, пока выполняется заданное условие. | из Коллекции |
| $this | преобразовать(callable $callback)
Преобразовать каждый элемент в коллекции с помощью обратного вызова. | из Коллекции |
| Коллекция | точечнаяЗапись()
Развернуть многомерный ассоциативный массив с точками. | из Коллекции |
| Enumerable | распаковать()
Преобразовать развёрнутый массив с "точечной" записью в расширенный массив. | из Коллекции |
| значения() Описание отсутствует | из Коллекции | |
| сжать($items)
Сжать коллекцию вместе с одним или несколькими массивами. | ||
| заполнить($size, $value)
Заполнить коллекцию до заданной длины значением. | ||
| Traversable | получитьИтератор()
Получить итератор для элементов. | из Коллекции |
| int | количество()
Подсчитать количество элементов в коллекции. | из Коллекции |
| считатьПо($countBy = null)
Подсчитать количество элементов в коллекции по полю или с помощью обратного вызова. | ||
| $this | добавить(TValue $item)
Добавить элемент в коллекцию. | из Коллекции |
| TValue> | вБазовую()
Получить экземпляр базовой коллекции Support из этой коллекции. | из Коллекции |
| bool | существуетЭлемент(TKey $key)
Определить, существует ли элемент по указанному смещению. | из Коллекции |
| mixed | получитьЭлемент(TKey $key)
Получить элемент по указанному смещению. | из Коллекции |
| void | offsetSet(TKey|null $key, TValue $value)
Установить элемент по заданному смещению. | from Коллекция |
| void | offsetUnset(TKey $key)
Удалить элемент по заданному смещению. | from Коллекция |
| mixed | getDictionaryKey(mixed $attribute)
Получить атрибут ключа словаря — при необходимости преобразуя его в строку. | from Взаимодействие со словарем |
| 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)
Загрузить набор отношений в коллекцию, если они еще не загружены жадно. | |
| void | loadMissingRelation(Коллекция $models, array $path)
Загрузить путь к отношению, если он еще не загружен жадно. | |
| $this | loadMorph(string $relation, $relations)
Загрузить набор отношений в коллекцию смешанного отношения. | |
| $this | loadMorphCount(string $relation, $relations)
Загрузить набор подсчетов отношений в коллекцию смешанного отношения. | |
| array<int,array-key> | modelKeys()
Получить массив первичных ключей. | |
| Коллекция | 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)
Получить имя класса сущности, которая будет помещена в очередь, для данной модели. | |
| array<int,mixed> | getQueueableIds()
Получить идентификаторы всех сущностей. | |
| array<int,string> | getQueueableRelations()
Получить отношения сущностей, которые будут помещены в очередь. | |
| string|null | getQueueableConnection()
Получить подключение к базе данных для сущностей, которые будут помещены в очередь. | |
| Билдер | 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 Перечисление значений 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)
Получить первый элемент по заданной паре ключ-значение.
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 $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)
Передать коллекцию заданному обращению и вернуть результат.
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.
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($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)
Пересечь коллекцию с заданными элементами.
Collection intersectUsing(TValue>|TValue> $items, callable $callback)
Пересечь коллекцию с заданными элементами, используя обратный вызов.
Collection intersectAssoc(TValue>|TValue> $items)
Пересечь коллекцию с заданными элементами с дополнительной проверкой индекса.
Collection intersectAssocUsing(TValue>|TValue> $items, callable $callback)
Пересечь коллекцию с заданными элементами с дополнительной проверкой индекса, используя обратный вызов.
Enumerable 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)
Без описания
Enumerable merge(TValue>|TValue> $items)
Объединить коллекцию с заданными элементами.
mergeRecursive($items)
Без описания
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)
Добавить один или несколько элементов в конец коллекции.
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)
Найти в коллекции заданное значение и вернуть соответствующий ключ, если поиск успешен.
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 = [], 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)
Преобразовать каждый элемент в коллекции с помощью обратного вызова.
Коллекция dot()
Сгладить многомерный ассоциативный массив с точками.
Перечислимый undot()
Преобразовать сглаженный массив в формате "точка" в расширенный массив.
values()
Без описания
zip($items)
Сжать коллекцию вместе с одним или несколькими массивами.
pad($size, $value)
Заполнить коллекцию до указанной длины значением.
Итерируемый 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)
Удалить элемент по заданному смещению.
protected mixed getDictionaryKey(mixed $attribute)
Получить атрибут ключа словаря, при необходимости преобразовав его в строку.
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.
protected 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()
Получить тип сущностей, которые находятся в очереди.
protected string getQueueableModelClass(Model $model)
Получить имя класса сущности, которая находится в очереди, для данной модели.
array<int,mixed> getQueueableIds()
Получить идентификаторы всех сущностей.
array<int,string> getQueueableRelations()
Получить отношения сущностей, которые находятся в очереди.
string|null getQueueableConnection()
Получить соединение сущностей, которые находятся в очереди.
Builder toQuery()
Получить Eloquent билдер запроса из коллекции.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Database/Eloquent/Collection.html
