Коллекция
класс Коллекция расширяет Коллекцию и реализует Интерфейс очереди (Просмотреть исходный код)
Трейты
| EnumeratesValues | |
| Macroable |
Свойства
| HigherOrderCollectionProxy только для чтения | $unique | из EnumeratesValues | |
| HigherOrderCollectionProxy только для чтения | $until | из EnumeratesValues | |
| static protected array | $macros | Зарегистрированные строковые макросы. | из Macroable |
| protected array | $items | Элементы, содержащиеся в коллекции. | из Collection |
Методы
| static EnumeratesValues | make(mixed $items = [])
Создать новый экземпляр коллекции, если значение не является коллекцией. | from EnumeratesValues |
| static EnumeratesValues | wrap(mixed $value)
Оборачивает заданное значение в коллекцию, если это применимо. | from EnumeratesValues |
| static array | unwrap(array|EnumeratesValues $value)
Получить базовые элементы из заданной коллекции, если это применимо. | from EnumeratesValues |
| static EnumeratesValues | empty()
Создать новый экземпляр без элементов. | from EnumeratesValues |
| static EnumeratesValues | times(int $number, callable $callback = null)
Создать новую коллекцию, вызвав обратный вызов заданное количество раз. | from EnumeratesValues |
| mixed | average(callable|string|null $callback = null)
Псевдоним для метода "avg". | from EnumeratesValues |
| bool | some(mixed $key, mixed $operator = null, mixed $value = null)
Псевдоним для метода "contains". | from EnumeratesValues |
| bool | containsStrict(mixed $key, mixed $value = null)
Определяет, существует ли элемент, используя строгое сравнение. | from EnumeratesValues |
| void | dd(mixed ...$args)
Вывести элементы и завершить сценарий. | from EnumeratesValues |
| $this | dump()
Вывести элементы. | from EnumeratesValues |
| $this | each(callable $callback)
Выполнить обратный вызов над каждым элементом. | from EnumeratesValues |
| EnumeratesValues | eachSpread(callable $callback)
Выполнить обратный вызов над каждым вложенным фрагментом элементов. | from EnumeratesValues |
| bool | every(string|callable $key, mixed $operator = null, mixed $value = null)
Определить, удовлетворяют ли все элементы заданному условию истинности. | from EnumeratesValues |
| mixed | firstWhere(string $key, mixed $operator = null, mixed $value = null)
Получить первый элемент по заданной паре ключ-значение. | from EnumeratesValues |
| bool | isNotEmpty()
Определить, не пуста ли коллекция. | from EnumeratesValues |
| EnumeratesValues | mapSpread(callable $callback)
Применить отображение к каждому вложенному фрагменту элементов. | from EnumeratesValues |
| EnumeratesValues | mapToGroups(callable $callback)
Применить отображение группировки к элементам. | from EnumeratesValues |
| EnumeratesValues | flatMap(callable $callback)
Применить отображение к коллекции и уплосстить результат на один уровень. | from EnumeratesValues |
| EnumeratesValues | mapInto(string $class)
Применить отображение значений в новый класс. | from EnumeratesValues |
| mixed | min(callable|string|null $callback = null)
Получить минимальное значение заданного ключа. | from EnumeratesValues |
| mixed | max(callable|string|null $callback = null)
Получить максимальное значение заданного ключа. | from EnumeratesValues |
| EnumeratesValues | forPage(int $page, int $perPage)
«Разбить» коллекцию, разделив ее на более мелкие коллекции. | from EnumeratesValues |
| EnumeratesValues | partition(callable|string $key, mixed $operator = null, mixed $value = null)
Разделить коллекцию на два массива, используя указанный обратный вызов или ключ. | from EnumeratesValues |
| mixed | sum(callable|string|null $callback = null)
Получить сумму заданных значений. | from EnumeratesValues |
| EnumeratesValues|mixed | when(bool|mixed $value, callable $callback = null, callable $default = null)
Применить обратный вызов, если значение истинно. | from EnumeratesValues |
| EnumeratesValues|mixed | whenEmpty(callable $callback, callable $default = null)
Применить обратный вызов, если коллекция пуста. | from EnumeratesValues |
| EnumeratesValues|смешанный тип | whenNotEmpty(вызываемый объект $callback, вызываемый объект $default = null)
Применить вызываемый объект, если коллекция не пустая. | из EnumeratesValues |
| EnumeratesValues|смешанный тип | unless(bool $value, вызываемый объект $callback, вызываемый объект $default = null)
Применить вызываемый объект, если значение ложно. | из EnumeratesValues |
| EnumeratesValues|смешанный тип | unlessEmpty(вызываемый объект $callback, вызываемый объект $default = null)
Применить вызываемый объект, если коллекция пустая. | из EnumeratesValues |
| EnumeratesValues|смешанный тип | unlessNotEmpty(вызываемый объект $callback, вызываемый объект $default = null)
Применить вызываемый объект, если коллекция не пустая. | из EnumeratesValues |
| EnumeratesValues | where(строка $key, смешанный тип $operator = null, смешанный тип $value = null)
Фильтровать элементы по заданной паре ключ-значение. | из EnumeratesValues |
| EnumeratesValues | whereNull(строка|null $key = null)
Фильтровать элементы, где значение для заданного ключа равно null. | из EnumeratesValues |
| EnumeratesValues | whereNotNull(строка|null $key = null)
Фильтровать элементы, где значение для заданного ключа не равно null. | из EnumeratesValues |
| EnumeratesValues | whereStrict(строка $key, смешанный тип $value)
Фильтровать элементы по заданной паре ключ-значение с использованием строгого сравнения. | из EnumeratesValues |
| EnumeratesValues | whereIn(строка $key, смешанный тип $values, bool $strict = false)
Фильтровать элементы по заданной паре ключ-значение. | из EnumeratesValues |
| EnumeratesValues | whereInStrict(строка $key, смешанный тип $values)
Фильтровать элементы по заданной паре ключ-значение с использованием строгого сравнения. | из EnumeratesValues |
| EnumeratesValues | whereBetween(строка $key, массив $values)
Фильтровать элементы таким образом, чтобы значение заданного ключа было между заданными значениями. | из EnumeratesValues |
| EnumeratesValues | whereNotBetween(строка $key, массив $values)
Фильтровать элементы таким образом, чтобы значение заданного ключа не было между заданными значениями. | из EnumeratesValues |
| EnumeratesValues | whereNotIn(строка $key, смешанный тип $values, bool $strict = false)
Фильтровать элементы по заданной паре ключ-значение. | из EnumeratesValues |
| EnumeratesValues | whereNotInStrict(строка $key, смешанный тип $values)
Фильтровать элементы по заданной паре ключ-значение с использованием строгого сравнения. | из EnumeratesValues |
| EnumeratesValues | whereInstanceOf(строка|массив строк $type)
Фильтровать элементы, удаляя любые элементы, которые не соответствуют заданному типу(ам). | из EnumeratesValues |
| смешанный тип | pipe(вызываемый объект $callback)
Передать коллекцию в заданный вызываемый объект и вернуть результат. | из EnumeratesValues |
| смешанный тип | pipeInto(строка $class)
Передать коллекцию в новый класс. | из EnumeratesValues |
| смешанный тип | pipeThrough(массив вызываемых объектов $pipes)
Передать коллекцию через серию вызываемых объектов-фильтров и вернуть результат. | из EnumeratesValues |
| $this | tap(вызываемый объект $callback)
Передать коллекцию в заданный вызываемый объект, а затем вернуть её. | из EnumeratesValues |
| смешанный тип | reduce(вызываемый объект $callback, смешанный тип $initial = null)
Свести коллекцию к одному значению. | из EnumeratesValues |
| массив | reduceMany(вызываемый объект $callback, смешанный тип ...$initial) deprecated
Свести коллекцию к нескольким агрегированным значениям. | из EnumeratesValues |
| массив | reduceSpread(вызываемый объект $callback, смешанный тип ...$initial)
Свести коллекцию к нескольким агрегированным значениям. | из EnumeratesValues |
| смешанный тип | reduceWithKeys(вызываемый объект $callback, смешанный тип $initial = null)
Свести ассоциативную коллекцию к одному значению. | из EnumeratesValues |
| EnumeratesValues | reject(callable|mixed $callback = true)
Создать коллекцию всех элементов, которые не удовлетворяют заданному условию истинности. | from EnumeratesValues |
| EnumeratesValues | uniqueStrict(string|callable|null $key = null)
Возвратить только уникальные элементы из массива коллекции, используя строгое сравнение. | from EnumeratesValues |
| Collection | collect()
Собрать значения в коллекцию. | from EnumeratesValues |
| array | toArray()
Получить коллекцию элементов как обычный массив. | from EnumeratesValues |
| array | jsonSerialize()
Преобразовать объект в что-то сериализуемое в JSON. | from EnumeratesValues |
| string | toJson(int $options = 0)
Получить коллекцию элементов в формате JSON. | from EnumeratesValues |
| CachingIterator | getCachingIterator(int $flags = CachingIterator::CALL_TOSTRING)
Получить экземпляр CachingIterator. | from EnumeratesValues |
| string | __toString()
Преобразовать коллекцию в её строковое представление. | from EnumeratesValues |
| $this | escapeWhenCastingToString(bool $escape = true)
Указать, что строковое представление модели должно быть экранировано при вызове __toString. | from EnumeratesValues |
| static void | proxy(string $method)
Добавить метод в список прокси-методов. | from EnumeratesValues |
| mixed | __get(string $key)
Динамический доступ к прокси-объектам коллекции. | from EnumeratesValues |
| array | getArrayableItems(mixed $items)
Массив результатов элементов из коллекции или Arrayable. | from EnumeratesValues |
| Closure | operatorForWhere(string $key, string|null $operator = null, mixed $value = null)
Получить обратный вызов проверки оператора. | from EnumeratesValues |
| bool | useAsCallable(mixed $value)
Определить, является ли заданное значение вызываемым, но не строкой. | from EnumeratesValues |
| callable | valueRetriever(callable|string|null $value)
Получить обратный вызов извлечения значения. | from EnumeratesValues |
| Closure | equality(mixed $value)
Создать функцию для проверки равенства элемента. | from EnumeratesValues |
| Closure | negate(Closure $callback)
Создать функцию, используя другую функцию, инвертируя её результат. | from EnumeratesValues |
| Closure | identity()
Создать функцию, которая возвращает переданное ей значение. | from EnumeratesValues |
| static void | macro(string $name, object|callable $macro)
Зарегистрировать пользовательское макро. | from Macroable |
| static void | mixin(object $mixin, bool $replace = true)
Смешать другой объект в класс. | from Macroable |
| static bool | hasMacro(string $name)
Проверяет, зарегистрировано ли макро. | from Macroable |
| static void | flushMacros()
Очистить существующие макросы. | from Macroable |
| static mixed | __callStatic(string $method, array $parameters)
Динамическая обработка вызовов класса. | from Macroable |
| mixed | __call(string $method, array $parameters)
Динамическая обработка вызовов класса. | from Macroable |
| void | __construct(mixed $items = [])
Создать новую коллекцию. | from Collection |
| static Enumerable | range(int $from, int $to)
Создать коллекцию с заданным диапазоном. | from Collection |
| array | all()
Получить все элементы в коллекции. | from Collection |
| LazyCollection | lazy()
Получить ленивую коллекцию для элементов в этой коллекции. | from Collection |
| mixed | avg(callable|string|null $callback = null)
Получить среднее значение заданного ключа. | из Коллекции |
| mixed | median(string|array|null $key = null)
Получить медиану заданного ключа. | из Коллекции |
| array|null | mode(string|array|null $key = null)
Получить моду заданного ключа. | из Коллекции |
| Перечисляемый | collapse()
Свести элементы коллекции в один массив. | |
| bool | contains(mixed $key, mixed $operator = null, mixed $value = null)
Определить, существует ли ключ в коллекции. | |
| bool | doesntContain(mixed $key, mixed $operator = null, mixed $value = null)
Определить, не содержится ли элемент в коллекции. | из Коллекции |
| Перечисляемый | crossJoin(mixed ...$lists)
Перекрестное соединение с заданными списками, возвращающее все возможные перестановки. | из Коллекции |
| Перечисляемый | diff(mixed $items)
Разность коллекций с заданными элементами. | |
| Перечисляемый | diffUsing(mixed $items, callable $callback)
Получить элементы в коллекции, которые отсутствуют в заданных элементах, используя обратный вызов. | из Коллекции |
| Перечисляемый | diffAssoc(mixed $items)
Получить элементы в коллекции, чьи ключи и значения отсутствуют в заданных элементах. | из Коллекции |
| Перечисляемый | diffAssocUsing(mixed $items, callable $callback)
Получить элементы в коллекции, чьи ключи и значения отсутствуют в заданных элементах, используя обратный вызов. | из Коллекции |
| Перечисляемый | diffKeys(mixed $items)
Получить элементы в коллекции, чьи ключи отсутствуют в заданных элементах. | из Коллекции |
| Перечисляемый | diffKeysUsing(mixed $items, callable $callback)
Получить элементы в коллекции, чьи ключи отсутствуют в заданных элементах, используя обратный вызов. | из Коллекции |
| Перечисляемый | duplicates(callable|string|null $callback = null, bool $strict = false)
Получить дублирующиеся элементы из коллекции. | из Коллекции |
| Перечисляемый | duplicatesStrict(callable|string|null $callback = null)
Получить дублирующиеся элементы из коллекции с использованием строгого сравнения. | из Коллекции |
| Closure | duplicateComparator(bool $strict)
Получить функцию сравнения для обнаружения дубликатов. | |
| Перечисляемый | except(mixed $keys)
Возвращает все модели в коллекции, кроме моделей со специфицированными ключами. | |
| Перечисляемый | filter(callable $callback = null)
Применить фильтр ко всем элементам. | из Коллекции |
| mixed | first(callable $callback = null, mixed $default = null)
Получить первый элемент из коллекции, удовлетворяющий заданному условию. | из Коллекции |
| Перечисляемый | flatten(int $depth = INF)
Получить плоский массив элементов коллекции. | |
| Перечисляемый | flip()
Перевернуть элементы коллекции. | |
| $this | forget(string|int|array $keys)
Удалить элемент из коллекции по ключу. | из Коллекции |
| mixed | get(mixed $key, mixed $default = null)
Получить элемент из коллекции по ключу. | из Коллекции |
| mixed | getOrPut(mixed $key, mixed $value)
Получить элемент из коллекции по ключу или добавить его в коллекцию, если он не существует. | из Коллекции |
| Перечисляемый | groupBy(array|callable|string $groupBy, bool $preserveKeys = false)
Сгруппировать ассоциативный массив по полю или с помощью обратного вызова. | из Коллекции |
| Перечисляемый | keyBy(callable|string $keyBy)
Установить ключи ассоциативного массива по полю или с помощью обратного вызова. | из Коллекции |
| bool | has(mixed $key)
Определить, существует ли элемент в коллекции по ключу. | из Коллекции |
| bool | hasAny(mixed $key)
Определить, существуют ли какие-либо ключи в коллекции. | из Коллекции |
| string | implode(string $value, string|null $glue = null)
Объединить значения заданного ключа в строку. | из Коллекции |
| Перечисляемый | intersect(mixed $items)
Пересечение коллекции с заданными элементами. |
| Перечислимый | intersectByKeys(mixed $items)
Пересечь коллекцию с заданными элементами по ключу. | из Коллекции |
| bool | isEmpty()
Определить, пуста ли коллекция. | из Коллекции |
| bool | containsOneItem()
Определить, содержит ли коллекция один элемент. | из Коллекции |
| string | join(string $glue, string $finalGlue = '')
Объединить все элементы коллекции, используя строку. Для последних элементов можно использовать отдельную строку разделителя. | из Коллекции |
| Перечислимый | keys()
Получить ключи элементов коллекции. | |
| mixed | last(callable $callback = null, mixed $default = null)
Получить последний элемент из коллекции. | из Коллекции |
| Перечислимый | pluck(string|array $value, string|null $key = null)
Получить массив со значениями заданного ключа. | |
| Перечислимый | map(callable $callback)
Применить преобразование к каждому элементу. | |
| Перечислимый | mapToDictionary(callable $callback)
Применить преобразование в словарь к элементам. | из Коллекции |
| Перечислимый | mapWithKeys(callable $callback)
Применить ассоциативное преобразование к каждому элементу. | |
| Перечислимый | merge(mixed $items)
Объединить коллекцию с заданными элементами. | |
| Перечислимый | mergeRecursive(mixed $items)
Рекурсивно объединить коллекцию с заданными элементами. | из Коллекции |
| Перечислимый | combine(mixed $values)
Создать коллекцию, используя эту коллекцию для ключей и другую для значений. | из Коллекции |
| Перечислимый | union(mixed $items)
Объединить коллекцию с заданными элементами. | из Коллекции |
| Перечислимый | nth(int $step, int $offset = 0)
Создать новую коллекцию, содержащую каждый n-й элемент. | из Коллекции |
| Перечислимый | only(mixed $keys)
Возвращает только модели из коллекции с указанными ключами. | |
| mixed | pop(int $count = 1)
Получить и удалить последние N элементов из коллекции. | из Коллекции |
| $this | prepend(mixed $value, mixed $key = null)
Добавить элемент в начало коллекции. | из Коллекции |
| $this | push(mixed ...$values)
Добавить один или несколько элементов в конец коллекции. | из Коллекции |
| Перечислимый | concat(iterable $source)
Добавить все заданные элементы в коллекцию. | из Коллекции |
| mixed | pull(mixed $key, mixed $default = null)
Получить и удалить элемент из коллекции. | из Коллекции |
| $this | put(mixed $key, mixed $value)
Поместить элемент в коллекцию по ключу. | из Коллекции |
| Перечислимый|mixed | random(int|null $number = null)
Случайным образом получить один или заданное количество элементов из коллекции. | из Коллекции |
| Перечислимый | replace(mixed $items)
Заменить элементы коллекции на заданные элементы. | из Коллекции |
| Перечислимый | replaceRecursive(mixed $items)
Рекурсивно заменить элементы коллекции на заданные элементы. | из Коллекции |
| Перечислимый | reverse()
Перевернуть порядок элементов. | из Коллекции |
| mixed | search(mixed $value, bool $strict = false)
Найти в коллекции заданное значение и вернуть соответствующий ключ, если поиск успешен. | из Коллекции |
| mixed | shift(int $count = 1)
Получить и удалить первые N элементов из коллекции. | из Коллекции |
| Перечислимый | shuffle(int|null $seed = null)
Перемешать элементы в коллекции. | из Коллекции |
| Коллекция | sliding(int $size = 2, int $step = 1)
Создать фрагменты, представляющие вид «скользящего окна» элементов в коллекции. | из Коллекции |
| Перечислимый | skip(int $count)
Пропустить первые {$count} элементов. | из Коллекции |
| Перечислимый | skipUntil(mixed $value)
Пропустить элементы в коллекции до тех пор, пока не будет выполнено данное условие. | из Коллекции |
| Перечислимый | skipWhile(mixed $value)
Пропустить элементы в коллекции, пока выполняется данное условие. | из Коллекции |
| Перечислимый | slice(int $offset, int|null $length = null)
Выделить часть массива базовой коллекции. | из Коллекции |
| Перечислимый | split(int $numberOfGroups)
Разбить коллекцию на определенное количество групп. | из Коллекции |
| Коллекция | splitIn(int $numberOfGroups)
Разбить коллекцию на определенное количество групп, заполняя первые группы полностью. | из Коллекции |
| mixed | sole(mixed $key = null, mixed $operator = null, mixed $value = null)
Получить первый элемент в коллекции, но только если существует ровно один элемент. В противном случае выбросить исключение. | из Коллекции |
| mixed | firstOrFail(mixed $key = null, mixed $operator = null, mixed $value = null)
Получить первый элемент в коллекции, но выбросить исключение, если соответствующих элементов нет. | из Коллекции |
| Перечислимый | chunk(int $size)
Разбить коллекцию на фрагменты заданного размера. | из Коллекции |
| Перечислимый | chunkWhile(callable $callback)
Разбить коллекцию на фрагменты с помощью обратного вызова. | из Коллекции |
| Перечислимый | sort(callable|null|int $callback = null)
Отсортировать каждый элемент с помощью обратного вызова. | из Коллекции |
| Перечислимый | sortDesc(int $options = SORT_REGULAR)
Отсортировать элементы в порядке убывания. | из Коллекции |
| Перечислимый | sortBy(callable|string $callback, int $options = SORT_REGULAR, bool $descending = false)
Отсортировать коллекцию с помощью данного обратного вызова. | из Коллекции |
| Коллекция | sortByMany(array $comparisons = [])
Отсортировать коллекцию, используя несколько сравнений. | из Коллекции |
| Перечислимый | sortByDesc(callable|string $callback, int $options = SORT_REGULAR)
Отсортировать коллекцию в порядке убывания с использованием данного обратного вызова. | из Коллекции |
| Перечислимый | sortKeys(int $options = SORT_REGULAR, bool $descending = false)
Отсортировать ключи коллекции. | из Коллекции |
| Перечислимый | sortKeysDesc(int $options = SORT_REGULAR)
Отсортировать ключи коллекции в порядке убывания. | из Коллекции |
| Коллекция | sortKeysUsing(callable $callback)
Отсортировать ключи коллекции, используя обратный вызов. | из Коллекции |
| Коллекция | splice(int $offset, int|null $length = null, mixed $replacement = [])
Вырезать часть массива базовой коллекции. | из Коллекции |
| Перечислимый | take(int $limit)
Взять первые или последние {$limit} элементов. | из Коллекции |
| Перечислимый | takeUntil(mixed $value)
Взять элементы в коллекции до тех пор, пока не будет выполнено данное условие. | из Коллекции |
| Перечислимый | takeWhile(mixed $value)
Взять элементы в коллекции, пока выполняется данное условие. | из Коллекции |
| $this | transform(callable $callback)
Преобразовать каждый элемент в коллекции с помощью обратного вызова. | из Коллекции |
| Коллекция | undot()
Преобразовать массив с плоской записью в формате «точка» в расширенный массив. | из Коллекции |
| Перечислимый | unique(string|callable|null $key = null, bool $strict = false)
Возвратить только уникальные элементы из коллекции. | |
| Перечислимый | values()
Сбросить ключи в базовом массиве. | из Коллекции |
| Перечислимый | zip(mixed $items)
Объединить коллекцию с одним или несколькими массивами. |
| Enumerable | pad(int $size, mixed $value)
Заполнить коллекцию до указанной длины значением. | |
| ArrayIterator | getIterator()
Получить итератор для элементов. | из Collection |
| int | count()
Подсчитать количество элементов в коллекции. | из Collection |
| Enumerable | countBy(callable|string $countBy = null)
Подсчитать количество элементов в коллекции по полю или используя обратный вызов. | из Collection |
| $this | add(mixed $item)
Добавить элемент в коллекцию. | из Collection |
| Collection | toBase()
Получить базовый экземпляр коллекции Support из этой коллекции. | из Collection |
| bool | offsetExists(mixed $key)
Определить, существует ли элемент по смещению. | из Collection |
| mixed | offsetGet(mixed $key)
Получить элемент по заданному смещению. | из Collection |
| void | offsetSet(mixed $key, mixed $value)
Установить элемент по заданному смещению. | из Collection |
| void | offsetUnset(mixed $key)
Сбросить элемент по заданному смещению. | из Collection |
| Model|Collection|null | find(mixed $key, mixed $default = null)
Найти модель в коллекции по ключу. | |
| $this | load(array|string $relations)
Загрузить набор отношений в коллекцию. | |
| $this | loadAggregate(array|string $relations, string $column, string $function = null)
Загрузить набор агрегаций по столбцу отношения в коллекцию. | |
| $this | loadCount(array|string $relations)
Загрузить набор подсчетов отношений в коллекцию. | |
| $this | loadMax(array|string $relations, string $column)
Загрузить набор максимальных значений столбца отношения в коллекцию. | |
| $this | loadMin(array|string $relations, string $column)
Загрузить набор минимальных значений столбца отношения в коллекцию. | |
| $this | loadSum(array|string $relations, string $column)
Загрузить набор сумм столбцов отношения в коллекцию. | |
| $this | loadAvg(array|string $relations, string $column)
Загрузить набор средних значений столбцов отношения в коллекцию. | |
| $this | loadExists(array|string $relations)
Загрузить набор существований отношений в коллекцию. | |
| $this | loadMissing(array|string $relations)
Загрузить набор отношений в коллекцию, если они еще не загружены. | |
| void | loadMissingRelation(Collection $models, array $path)
Загрузить путь отношения, если он еще не загружен. | |
| $this | loadMorph(string $relation, array $relations)
Загрузить набор отношений в смешанную коллекцию отношений. | |
| $this | loadMorphCount(string $relation, array $relations)
Загрузить набор подсчетов отношений в смешанную коллекцию отношений. | |
| array | modelKeys()
Получить массив первичных ключей. | |
| Collection | fresh(array|string $with = [])
Перезагрузить свежий экземпляр модели из базы данных для всех сущностей. | |
| $this | makeHidden(array|string $attributes)
Сделать заданные, обычно видимые, атрибуты скрытыми во всей коллекции. | |
| $this | makeVisible(array|string $attributes)
Сделать заданные, обычно скрытые, атрибуты видимыми во всей коллекции. | |
| $this | append(array|string $attributes)
Добавить атрибут во всю коллекцию. | |
| array | getDictionary(ArrayAccess|array|null $items = null)
Получить словарь с ключами, являющимися первичными ключами. | |
| string|null | getQueueableClass()
Получить тип сущностей, помещаемых в очередь. | |
| array | getQueueableIds()
Получить идентификаторы для всех сущностей. | |
| array | getQueueableRelations()
Получить отношения сущностей, помещаемых в очередь. | |
| string|null | getQueueableConnection()
Получить соединение сущностей, помещаемых в очередь. | |
| Builder | toQuery()
Получить конструктор запросов Eloquent из коллекции. |
Details
static EnumeratesValues make(mixed $items = [])
Создать новый экземпляр коллекции, если значение еще не является таковым.
static EnumeratesValues wrap(mixed $value)
Завернуть заданное значение в коллекцию, если применимо.
static array unwrap(array|EnumeratesValues $value)
Получить базовые элементы из заданного набора, если применимо.
static EnumeratesValues empty()
Создать новый экземпляр без элементов.
static EnumeratesValues times(int $number, callable $callback = null)
Создать новый набор, вызвав обратный вызов заданное количество раз.
mixed average(callable|string|null $callback = null)
Псевдоним для метода "avg".
bool some(mixed $key, mixed $operator = null, mixed $value = null)
Псевдоним для метода "contains".
bool containsStrict(mixed $key, mixed $value = null)
Определить, существует ли элемент, используя строгое сравнение.
void dd(mixed ...$args)
Вывести элементы и завершить сценарий.
$this dump()
Вывести элементы.
$this each(callable $callback)
Выполнить обратный вызов над каждым элементом.
EnumeratesValues eachSpread(callable $callback)
Выполнить обратный вызов над каждым вложенным фрагментом элементов.
bool every(string|callable $key, mixed $operator = null, mixed $value = null)
Определить, проходят ли все элементы заданный тест истинности.
mixed firstWhere(string $key, mixed $operator = null, mixed $value = null)
Получить первый элемент по заданной паре ключ-значение.
bool isNotEmpty()
Определить, не пуст ли набор.
EnumeratesValues mapSpread(callable $callback)
Применить отображение ко всем вложенным фрагментам элементов.
EnumeratesValues mapToGroups(callable $callback)
Применить отображение группировки к элементам.
Обратный вызов должен возвращать ассоциативный массив с единственной парой ключ/значение.
EnumeratesValues flatMap(callable $callback)
Применить отображение к набору и сплющить результат на один уровень.
EnumeratesValues mapInto(string $class)
Применить отображение значений в новый класс.
mixed min(callable|string|null $callback = null)
Получить минимальное значение заданного ключа.
mixed max(callable|string|null $callback = null)
Получить максимальное значение заданного ключа.
EnumeratesValues forPage(int $page, int $perPage)
Разделить коллекцию на более мелкие подколлекции.
EnumeratesValues partition(callable|string $key, mixed $operator = null, mixed $value = null)
Разделить коллекцию на два массива, используя предоставленный обратный вызов или ключ.
mixed sum(callable|string|null $callback = null)
Получить сумму заданных значений.
EnumeratesValues|mixed when(bool|mixed $value, callable $callback = null, callable $default = null)
Применить обратный вызов, если значение истинно.
EnumeratesValues|mixed whenEmpty(callable $callback, callable $default = null)
Применить обратный вызов, если коллекция пуста.
EnumeratesValues|mixed whenNotEmpty(callable $callback, callable $default = null)
Применить обратный вызов, если коллекция не пуста.
EnumeratesValues|mixed unless(bool $value, callable $callback, callable $default = null)
Применить обратный вызов, если значение ложно.
EnumeratesValues|mixed unlessEmpty(callable $callback, callable $default = null)
Применить обратный вызов, если коллекция не пуста.
EnumeratesValues|mixed unlessNotEmpty(callable $callback, callable $default = null)
Применить обратный вызов, если коллекция пуста.
EnumeratesValues where(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, mixed $values, bool $strict = false)
Фильтровать элементы по заданной паре ключ-значение.
EnumeratesValues whereInStrict(string $key, mixed $values)
Фильтровать элементы по заданной паре ключ-значение, используя строгое сравнение.
EnumeratesValues whereBetween(string $key, array $values)
Фильтровать элементы таким образом, чтобы значение заданного ключа находилось между заданными значениями.
EnumeratesValues whereNotBetween(string $key, array $values)
Фильтровать элементы таким образом, чтобы значение заданного ключа не находилось между заданными значениями.
EnumeratesValues whereNotIn(string $key, mixed $values, bool $strict = false)
Фильтровать элементы по заданной паре ключ-значение.
EnumeratesValues whereNotInStrict(string $key, mixed $values)
Фильтровать элементы по заданной паре ключ-значение, используя строгое сравнение.
EnumeratesValues whereInstanceOf(string|string[] $type)
Фильтровать элементы, удаляя те, которые не соответствуют заданному типу(ам).
mixed pipe(callable $callback)
Передать коллекцию в указанный обратный вызов и вернуть результат.
mixed pipeInto(string $class)
Передать коллекцию в новый класс.
mixed pipeThrough(callable[] $pipes)
Пропустить коллекцию через ряд вызовов-фильтров и вернуть результат.
$this tap(callable $callback)
Передать коллекцию в указанный обратный вызов, а затем вернуть её.
mixed reduce(callable $callback, mixed $initial = null)
Свести коллекцию к одному значению.
array reduceMany(callable $callback, mixed ...$initial) устарело
устарело
Свести коллекцию к нескольким агрегированным значениям.
array reduceSpread(callable $callback, mixed ...$initial)
Свести коллекцию к нескольким агрегированным значениям.
mixed reduceWithKeys(callable $callback, mixed $initial = null)
Свести ассоциативную коллекцию к одному значению.
EnumeratesValues reject(callable|mixed $callback = true)
Создать коллекцию из всех элементов, которые не проходят заданный тест истинности.
EnumeratesValues uniqueStrict(string|callable|null $key = null)
Возвратить только уникальные элементы из массива коллекции, используя строгое сравнение.
Collection collect()
Собрать значения в коллекцию.
array toArray()
Получить коллекцию элементов в виде простого массива.
array jsonSerialize()
Преобразовать объект в формат, сериализуемый в JSON.
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 array getArrayableItems(mixed $items)
Массив результатов элементов из Collection или Arrayable.
protected Closure operatorForWhere(string $key, string|null $operator = null, mixed $value = null)
Получить обратный вызов для проверки оператора.
protected bool useAsCallable(mixed $value)
Определить, является ли заданное значение вызываемым, но не строкой.
protected callable valueRetriever(callable|string|null $value)
Получить обратный вызов для извлечения значения.
protected Closure equality(mixed $value)
Создать функцию для проверки равенства элемента.
protected Closure negate(Closure $callback)
Создать функцию, используя другую функцию, инвертируя ее результат.
protected Closure 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)
Динамическая обработка вызовов класса.
смешанный тип __call(string $method, array $parameters)
Динамичная обработка вызовов класса.
void __construct(mixed $items = [])
Создать новую коллекцию.
статический Enumerable range(int $from, int $to)
Создать коллекцию с заданным диапазоном.
массив all()
Получить все элементы в коллекции.
LazyCollection lazy()
Получить ленивую коллекцию для элементов этой коллекции.
смешанный тип avg(callable|string|null $callback = null)
Получить среднее значение заданного ключа.
смешанный тип median(string|array|null $key = null)
Получить медиану заданного ключа.
массив|null mode(string|array|null $key = null)
Получить моду заданного ключа.
Enumerable collapse()
Сжать коллекцию элементов в один массив.
булево contains(mixed $key, mixed $operator = null, mixed $value = null)
Определить, существует ли ключ в коллекции.
булево doesntContain(mixed $key, mixed $operator = null, mixed $value = null)
Определить, не содержится ли элемент в коллекции.
Enumerable crossJoin(mixed ...$lists)
Перекрестное соединение с заданными списками, возвращающее все возможные перестановки.
Enumerable diff(mixed $items)
Разница между коллекцией и заданными элементами.
Enumerable diffUsing(mixed $items, callable $callback)
Получить элементы в коллекции, отсутствующие в заданных элементах, используя обратный вызов.
Enumerable diffAssoc(mixed $items)
Получить элементы в коллекции, у которых ключи и значения отсутствуют в заданных элементах.
Enumerable diffAssocUsing(mixed $items, callable $callback)
Получить элементы в коллекции, у которых ключи и значения отсутствуют в заданных элементах, используя обратный вызов.
Enumerable diffKeys(mixed $items)
Получить элементы в коллекции, у которых ключи отсутствуют в заданных элементах.
Enumerable diffKeysUsing(mixed $items, callable $callback)
Получить элементы в коллекции, у которых ключи отсутствуют в заданных элементах, используя обратный вызов.
Enumerable duplicates(callable|string|null $callback = null, bool $strict = false)
Получить дублирующиеся элементы из коллекции.
Enumerable duplicatesStrict(callable|string|null $callback = null)
Получить дублирующиеся элементы из коллекции с использованием строгого сравнения.
protected Closure duplicateComparator(bool $strict)
Получить функцию сравнения для определения дубликатов.
Enumerable except(mixed $keys)
Возвращает все модели в коллекции, за исключением моделей с указанными ключами.
Enumerable filter(callable $callback = null)
Применить фильтр к каждому элементу.
mixed first(callable $callback = null, mixed $default = null)
Получить первый элемент из коллекции, удовлетворяющий заданному условию.
Enumerable flatten(int $depth = INF)
Получить плоский массив элементов коллекции.
Enumerable flip()
Поменять местами ключи и значения в коллекции.
$this forget(string|int|array $keys)
Удалить элемент из коллекции по ключу.
mixed get(mixed $key, mixed $default = null)
Получить элемент из коллекции по ключу.
mixed getOrPut(mixed $key, mixed $value)
Получить элемент из коллекции по ключу или добавить его в коллекцию, если он не существует.
Enumerable groupBy(array|callable|string $groupBy, bool $preserveKeys = false)
Сгруппировать ассоциативный массив по полю или с помощью обратного вызова.
Enumerable keyBy(callable|string $keyBy)
Установить ключи ассоциативного массива по полю или с помощью обратного вызова.
bool has(mixed $key)
Определить, существует ли элемент в коллекции по ключу.
bool hasAny(mixed $key)
Определить, существуют ли какие-либо ключи в коллекции.
string implode(string $value, string|null $glue = null)
Конкатенировать значения заданного ключа в строку.
Enumerable intersect(mixed $items)
Пересечь коллекцию с заданными элементами.
Enumerable intersectByKeys(mixed $items)
Пересечь коллекцию с заданными элементами по ключу.
bool isEmpty()
Определить, пуста ли коллекция.
bool containsOneItem()
Определить, содержит ли коллекция один элемент.
string join(string $glue, string $finalGlue = '')
Объединить все элементы из коллекции с помощью строки. Для конечных элементов можно использовать отдельную строку-разделитель.
Enumerable keys()
Получить ключи элементов коллекции.
mixed last(callable $callback = null, mixed $default = null)
Получить последний элемент из коллекции.
Enumerable pluck(string|array $value, string|null $key = null)
Получить массив с значениями заданного ключа.
Enumerable map(callable $callback)
Применить функцию к каждому элементу.
Enumerable mapToDictionary(callable $callback)
Применить функцию для создания словаря из элементов.
Функция должна вернуть ассоциативный массив с одной парой ключ/значение.
Enumerable mapWithKeys(callable $callback)
Применить функцию для создания ассоциативного массива из элементов.
Функция должна вернуть ассоциативный массив с одной парой ключ/значение.
Enumerable merge(mixed $items)
Объединить коллекцию с заданными элементами.
Enumerable mergeRecursive(mixed $items)
Рекурсивно объединить коллекцию с заданными элементами.
Enumerable combine(mixed $values)
Создать коллекцию, используя текущую коллекцию для ключей и другую для значений.
Enumerable union(mixed $items)
Объединить коллекцию с заданными элементами.
Enumerable nth(int $step, int $offset = 0)
Создать новую коллекцию, содержащую каждый n-й элемент.
Enumerable only(mixed $keys)
Возвращает только модели из коллекции с указанными ключами.
mixed pop(int $count = 1)
Получить и удалить последние N элементов из коллекции.
$this prepend(mixed $value, mixed $key = null)
Добавить элемент в начало коллекции.
$this push(mixed ...$values)
Добавить один или несколько элементов в конец коллекции.
Enumerable concat(iterable $source)
Добавить все заданные элементы в коллекцию.
mixed pull(mixed $key, mixed $default = null)
Получить и удалить элемент из коллекции.
$this put(mixed $key, mixed $value)
Добавить элемент в коллекцию по ключу.
Enumerable|смешанный random(int|null $number = null)
Получить один или заданное количество элементов случайным образом из коллекции.
Enumerable replace(смешанный $items)
Заменить элементы коллекции заданными элементами.
Enumerable replaceRecursive(смешанный $items)
Рекурсивно заменить элементы коллекции заданными элементами.
Enumerable reverse()
Перевернуть порядок элементов.
смешанный search(смешанный $value, bool $strict = false)
Искать в коллекции заданное значение и вернуть соответствующий ключ при успехе.
смешанный shift(int $count = 1)
Получить и удалить первые N элементов из коллекции.
Enumerable shuffle(int|null $seed = null)
Перемешать элементы в коллекции.
Collection sliding(int $size = 2, int $step = 1)
Создать блоки, представляющие "скользящее окно" представления элементов в коллекции.
Enumerable skip(int $count)
Пропустить первые {$count} элементов.
Enumerable skipUntil(смешанный $value)
Пропустить элементы в коллекции до тех пор, пока не будет выполнено заданное условие.
Enumerable skipWhile(смешанный $value)
Пропустить элементы в коллекции, пока выполняется заданное условие.
Enumerable slice(int $offset, int|null $length = null)
Разрезать массив коллекции.
Enumerable split(int $numberOfGroups)
Разбить коллекцию на определенное количество групп.
Collection splitIn(int $numberOfGroups)
Разбить коллекцию на определенное количество групп, заполнив полностью первые группы.
смешанный sole(смешанный $key = null, смешанный $operator = null, смешанный $value = null)
Получить первый элемент в коллекции, только если существует ровно один элемент. В противном случае выбросить исключение.
смешанный firstOrFail(смешанный $key = null, смешанный $operator = null, смешанный $value = null)
Получить первый элемент в коллекции, но выбросить исключение, если соответствующие элементы отсутствуют.
Enumerable chunk(int $size)
Разбить коллекцию на блоки заданного размера.
Enumerable chunkWhile(callable $callback)
Разбить коллекцию на части с помощью обратного вызова.
Enumerable sort(callable|null|int $callback = null)
Отсортировать каждый элемент с помощью обратного вызова.
Enumerable sortDesc(int $options = SORT_REGULAR)
Отсортировать элементы в порядке убывания.
Enumerable sortBy(callable|string $callback, int $options = SORT_REGULAR, bool $descending = false)
Отсортировать коллекцию с помощью заданного обратного вызова.
protected Collection sortByMany(array $comparisons = [])
Отсортировать коллекцию с помощью нескольких сравнений.
Enumerable sortByDesc(callable|string $callback, int $options = SORT_REGULAR)
Отсортировать коллекцию в порядке убывания с помощью заданного обратного вызова.
Enumerable sortKeys(int $options = SORT_REGULAR, bool $descending = false)
Отсортировать ключи коллекции.
Enumerable sortKeysDesc(int $options = SORT_REGULAR)
Отсортировать ключи коллекции в порядке убывания.
Collection sortKeysUsing(callable $callback)
Отсортировать ключи коллекции с помощью обратного вызова.
Collection splice(int $offset, int|null $length = null, mixed $replacement = [])
Вставить часть массива базовой коллекции.
Enumerable take(int $limit)
Взять первые или последние {$limit} элементов.
Enumerable takeUntil(mixed $value)
Взять элементы из коллекции до тех пор, пока не будет выполнено данное условие.
Enumerable takeWhile(mixed $value)
Взять элементы из коллекции, пока выполняется заданное условие.
$this transform(callable $callback)
Преобразовать каждый элемент в коллекции с помощью обратного вызова.
Collection undot()
Преобразовать массив с плоским представлением в виде "точки" в расширенный массив.
Enumerable unique(string|callable|null $key = null, bool $strict = false)
Возвратить только уникальные элементы из коллекции.
Enumerable values()
Сбросить ключи в базовом массиве.
Enumerable zip(mixed $items)
Сгруппировать коллекцию вместе с одним или несколькими массивами.
Enumerable pad(int $size, mixed $value)
Заполнить коллекцию до указанной длины заданным значением.
ArrayIterator getIterator()
Получить итератор для элементов.
int count()
Подсчитать количество элементов в коллекции.
Enumerable countBy(callable|string $countBy = null)
Подсчитать количество элементов в коллекции по полю или с помощью обратного вызова.
$this add(mixed $item)
Добавить элемент в коллекцию.
Collection toBase()
Получить базовый экземпляр коллекции Support из этой коллекции.
bool offsetExists(mixed $key)
Определить, существует ли элемент по заданному смещению.
mixed offsetGet(mixed $key)
Получить элемент по заданному смещению.
void offsetSet(mixed $key, mixed $value)
Установить элемент по заданному смещению.
void offsetUnset(mixed $key)
Удалить элемент по заданному смещению.
Model|Collection|null find(mixed $key, mixed $default = null)
Найти модель в коллекции по ключу.
$this load(array|string $relations)
Загрузить набор отношений в коллекцию.
$this loadAggregate(array|string $relations, string $column, string $function = null)
Загрузить набор агрегаций по столбцу отношения в коллекцию.
$this loadCount(array|string $relations)
Загрузить набор подсчётов отношений в коллекцию.
$this loadMax(array|string $relations, string $column)
Загрузить набор максимальных значений столбцов отношения в коллекцию.
$this loadMin(array|string $relations, string $column)
Загрузить набор минимальных значений столбцов отношения в коллекцию.
$this loadSum(array|string $relations, string $column)
Загрузить набор сумм столбцов отношения в коллекцию.
$this loadAvg(array|string $relations, string $column)
Загрузить набор средних значений столбцов отношения в коллекцию.
$this loadExists(array|string $relations)
Загрузить набор связанных сущностей в коллекцию.
$this loadMissing(array|string $relations)
Загрузить набор отношений в коллекцию, если они еще не загружены с помощью eager loading.
protected void loadMissingRelation(Collection $models, array $path)
Загрузить путь к связи, если он еще не загружен с помощью eager loading.
$this loadMorph(string $relation, array $relations)
Загрузить набор связей в коллекцию смешанных отношений.
$this loadMorphCount(string $relation, array $relations)
Загрузить набор подсчетов отношений в коллекцию смешанных отношений.
array modelKeys()
Получить массив первичных ключей.
Collection fresh(array|string $with = [])
Перезагрузить свежий экземпляр модели из базы данных для всех сущностей.
$this makeHidden(array|string $attributes)
Скрыть указанные, обычно видимые, атрибуты для всей коллекции.
$this makeVisible(array|string $attributes)
Сделать указанные, обычно скрытые, атрибуты видимыми для всей коллекции.
$this append(array|string $attributes)
Добавить атрибут ко всей коллекции.
array getDictionary(ArrayAccess|array|null $items = null)
Получить словарь, индексированный первичными ключами.
string|null getQueueableClass()
Получить тип сущностей, которые планируется поместить в очередь.
array getQueueableIds()
Получить идентификаторы всех сущностей.
array 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/8.x/Illuminate/Database/Eloquent/Collection.html
