Spec-Zone.ru › Laravel 7

Коллекция

класс Collection реализует ArrayAccess, Enumerable (View source)

Свойства

EnumeratesValues
Macroable

Свойства

static protected array $proxies

Методы, которые могут быть проксированы.

из EnumeratesValues
HigherOrderCollectionProxy только для чтения $average из EnumeratesValues
HigherOrderCollectionProxy только для чтения $avg из EnumeratesValues
HigherOrderCollectionProxy только для чтения $contains из EnumeratesValues
HigherOrderCollectionProxy только для чтения $each из EnumeratesValues
HigherOrderCollectionProxy только для чтения $every из EnumeratesValues
HigherOrderCollectionProxy только для чтения $filter из EnumeratesValues
HigherOrderCollectionProxy только для чтения $first из EnumeratesValues
HigherOrderCollectionProxy только для чтения $flatMap из EnumeratesValues
HigherOrderCollectionProxy только для чтения $groupBy из EnumeratesValues
HigherOrderCollectionProxy только для чтения $keyBy из EnumeratesValues
HigherOrderCollectionProxy только для чтения $map из EnumeratesValues
HigherOrderCollectionProxy только для чтения $max из EnumeratesValues
HigherOrderCollectionProxy только для чтения $min из EnumeratesValues
HigherOrderCollectionProxy только для чтения $partition из EnumeratesValues
HigherOrderCollectionProxy только для чтения $reject из EnumeratesValues
HigherOrderCollectionProxy только для чтения $some из EnumeratesValues
HigherOrderCollectionProxy только для чтения $sortBy из EnumeratesValues
HigherOrderCollectionProxy только для чтения $sortByDesc из EnumeratesValues
HigherOrderCollectionProxy только для чтения $sum из EnumeratesValues
HigherOrderCollectionProxy только для чтения $unique из EnumeratesValues
HigherOrderCollectionProxy только для чтения $until из EnumeratesValues
static protected array $macros

Зарегистрированные строковые макросы.

из Macroable
protected array $items

Элементы, содержащиеся в коллекции.

Методы

static EnumeratesValues make(mixed $items = [])

Создать новый экземпляр коллекции, если значение не является коллекцией.

из EnumeratesValues
static EnumeratesValues wrap(mixed $value)

Оборачивает данное значение в коллекцию, если применимо.

из EnumeratesValues
static array unwrap(array|EnumeratesValues $value)

Получить базовые элементы из заданной коллекции, если применимо.

из EnumeratesValues
mixed average(callable|string|null $callback = null)

Псевдоним для метода "avg".

из EnumeratesValues
bool some(mixed $key, mixed $operator = null, mixed $value = null)

Псевдоним для метода "contains".

из EnumeratesValues
bool containsStrict(mixed $key, mixed $value = null)

Определить, существует ли элемент, используя строгое сравнение.

из EnumeratesValues
void dd(mixed ...$args)

Вывести элементы и завершить скрипт.

из EnumeratesValues
$this dump()

Вывести элементы.

из EnumeratesValues
$this each(callable $callback)

Выполнить обратный вызов для каждого элемента.

из EnumeratesValues
EnumeratesValues eachSpread(callable $callback)

Выполнить обратный вызов для каждого вложенного фрагмента элементов.

из EnumeratesValues
bool every(string|callable $key, mixed $operator = null, mixed $value = null)

Определить, удовлетворяют ли все элементы заданной проверке истинности.

из EnumeratesValues
mixed firstWhere(string $key, mixed $operator = null, mixed $value = null)

Получить первый элемент по заданной паре ключ-значение.

из EnumeratesValues
bool isNotEmpty()

Определить, не пуста ли коллекция.

из EnumeratesValues
EnumeratesValues mapSpread(callable $callback)

Применить отображение к каждому вложенному фрагменту элементов.

из EnumeratesValues
EnumeratesValues mapToGroups(callable $callback)

Применить группирующее отображение к элементам.

из EnumeratesValues
EnumeratesValues flatMap(callable $callback)

Применить отображение к коллекции и уплостить результат на один уровень.

из EnumeratesValues
EnumeratesValues mapInto(string $class)

Применить отображение значений в новый класс.

из EnumeratesValues
mixed min(callable|string|null $callback = null)

Получить минимальное значение заданного ключа.

из EnumeratesValues
mixed max(callable|string|null $callback = null)

Получить максимальное значение заданного ключа.

из EnumeratesValues
EnumeratesValues forPage(int $page, int $perPage)

«Разбить на страницы» коллекцию, разделив ее на более мелкие коллекции.

из EnumeratesValues
EnumeratesValues partition(callable|string $key, mixed $operator = null, mixed $value = null)

Разделить коллекцию на два массива с помощью заданного обратного вызова или ключа.

из EnumeratesValues
mixed sum(callable|string|null $callback = null)

Получить сумму заданных значений.

из EnumeratesValues
EnumeratesValues|mixed when(bool|mixed $value, callable $callback = null, callable $default = null)

Применить обратный вызов, если значение истинно.

из EnumeratesValues
EnumeratesValues|mixed whenEmpty(callable $callback, callable $default = null)

Применить обратный вызов, если коллекция пустая.

из EnumeratesValues
EnumeratesValues|mixed whenNotEmpty(callable $callback, callable $default = null)

Применить обратный вызов, если коллекция не пустая.

из EnumeratesValues
EnumeratesValues|mixed unless(bool $value, callable $callback, callable $default = null)

Применить обратный вызов, если значение ложно.

из EnumeratesValues
EnumeratesValues|mixed unlessEmpty(callable $callback, callable $default = null)

Применить обратный вызов, если коллекция не пуста.

из EnumeratesValues
EnumeratesValues|mixed unlessNotEmpty(callable $callback, callable $default = null)

Применить обратный вызов, если коллекция не пуста.

from EnumeratesValues
EnumeratesValues where(string $key, mixed $operator = null, mixed $value = null)

Фильтровать элементы по заданной паре ключ-значение.

from EnumeratesValues
EnumeratesValues whereNull(string|null $key = null)

Фильтровать элементы, где заданный ключ не равен null.

from EnumeratesValues
EnumeratesValues whereNotNull(string|null $key = null)

Фильтровать элементы, где заданный ключ равен null.

from EnumeratesValues
EnumeratesValues whereStrict(string $key, mixed $value)

Фильтровать элементы по заданной паре ключ-значение с использованием строгого сравнения.

from EnumeratesValues
EnumeratesValues whereIn(string $key, mixed $values, bool $strict = false)

Фильтровать элементы по заданной паре ключ-значение.

from EnumeratesValues
EnumeratesValues whereInStrict(string $key, mixed $values)

Фильтровать элементы по заданной паре ключ-значение с использованием строгого сравнения.

from EnumeratesValues
EnumeratesValues whereBetween(string $key, array $values)

Фильтровать элементы, для которых значение заданного ключа находится между заданными значениями.

from EnumeratesValues
EnumeratesValues whereNotBetween(string $key, array $values)

Фильтровать элементы, для которых значение заданного ключа не находится между заданными значениями.

from EnumeratesValues
EnumeratesValues whereNotIn(string $key, mixed $values, bool $strict = false)

Фильтровать элементы по заданной паре ключ-значение.

from EnumeratesValues
EnumeratesValues whereNotInStrict(string $key, mixed $values)

Фильтровать элементы по заданной паре ключ-значение с использованием строгого сравнения.

from EnumeratesValues
EnumeratesValues whereInstanceOf(string $type)

Фильтровать элементы, удаляя любые элементы, которые не соответствуют заданному типу.

from EnumeratesValues
mixed pipe(callable $callback)

Передать коллекцию в заданный обратный вызов и вернуть результат.

from EnumeratesValues
$this tap(callable $callback)

Передать коллекцию в заданный обратный вызов и затем вернуть её.

from EnumeratesValues
EnumeratesValues reject(callable|mixed $callback = true)

Создать коллекцию всех элементов, которые не проходят заданный тест истинности.

from EnumeratesValues
EnumeratesValues unique(string|callable|null $key = null, bool $strict = false)

Возвратить только уникальные элементы из массива коллекции.

from EnumeratesValues
EnumeratesValues uniqueStrict(string|callable|null $key = null)

Возвратить только уникальные элементы из массива коллекции с использованием строгого сравнения.

from EnumeratesValues
EnumeratesValues until(mixed $value) deprecated

Взять элементы в коллекции до тех пор, пока не будет выполнено данное условие.

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
static void proxy(string $method)

Добавить метод в список прокси-методов.

from EnumeratesValues
mixed __get(string $key)

Динамический доступ к коллекциям-прокси.

из EnumeratesValues
array getArrayableItems(mixed $items)

Результат массива элементов из Collection или Arrayable.

из EnumeratesValues
Closure operatorForWhere(string $key, string|null $operator = null, mixed $value = null)

Получение обратного вызова оператора проверки.

из EnumeratesValues
bool useAsCallable(mixed $value)

Определение, является ли данное значение вызываемым, но не строкой.

из EnumeratesValues
callable valueRetriever(callable|string|null $value)

Получение обратного вызова для извлечения значения.

из EnumeratesValues
Closure equality(mixed $value)

Создание функции для проверки равенства элемента.

из EnumeratesValues
Closure negate(Closure $callback)

Создание функции, использующей другую функцию, инвертируя её результат.

из EnumeratesValues
Closure 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 mixed __callStatic(string $method, array $parameters)

Динамическая обработка вызовов класса.

из Macroable
mixed __call(string $method, array $parameters)

Динамическая обработка вызовов класса.

из Macroable
void __construct(mixed $items = [])

Создание новой коллекции.

static Enumerable times(int $number, callable $callback = null)

Создание новой коллекции, вызвав обратный вызов заданное количество раз.

array all()

Получение всех элементов в коллекции.

LazyCollection lazy()

Получение ленивой коллекции для элементов в этой коллекции.

mixed avg(callable|string|null $callback = null)

Получение среднего значения заданного ключа.

mixed median(string|array|null $key = null)

Получение медианы заданного ключа.

array|null mode(string|array|null $key = null)

Получение моды заданного ключа.

Enumerable collapse()

Сжатие коллекции элементов в один массив.

bool contains(mixed $key, mixed $operator = null, mixed $value = null)

Определение, существует ли элемент в коллекции.

Collection 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|null $callback = null, bool $strict = false)

Получение повторяющихся элементов из коллекции.

Enumerable duplicatesStrict(callable|null $callback = null)

Получение повторяющихся элементов из коллекции с использованием строгого сравнения.

Closure duplicateComparator(bool $strict)

Получение функции сравнения для обнаружения дубликатов.

Enumerable except(mixed $keys)

Получение всех элементов, кроме тех, у которых указаны ключи.

Enumerable filter(callable $callback = null)

Применение фильтра к каждому элементу.

mixed first(callable $callback = null, mixed $default = null)

Получение первого элемента из коллекции, удовлетворяющего заданному условию.

END_OF_DOCUMENT_MARKER
Коллекция flatten(int $depth = INF)

Получить плоский массив элементов из коллекции.

Перечислимый flip()

Перевернуть элементы в коллекции.

$this forget(string|array $keys)

Удалить элемент из коллекции по ключу.

mixed get(mixed $key, mixed $default = null)

Получить элемент из коллекции по ключу.

Перечислимый groupBy(array|callable|string $groupBy, bool $preserveKeys = false)

Сгруппировать ассоциативный массив по полю или с помощью обратного вызова.

Перечислимый keyBy(callable|string $keyBy)

Указать ключи ассоциативного массива по полю или с помощью обратного вызова.

bool has(mixed $key)

Определить, существует ли элемент в коллекции по ключу.

string implode(string $value, string|null $glue = null)

Соединить значения заданного ключа в строку.

Перечислимый intersect(mixed $items)

Пересечь коллекцию с заданными элементами.

Перечислимый intersectByKeys(mixed $items)

Пересечь коллекцию с заданными элементами по ключу.

bool isEmpty()

Определить, пуста ли коллекция.

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()

Получить и удалить последний элемент из коллекции.

$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)

Получить один или заданное количество элементов случайным образом из коллекции.

mixed reduce(callable $callback, mixed $initial = null)

Свести коллекцию к одному значению.

Перечислимый replace(mixed $items)

Заменить элементы коллекции на заданные.

Перечислимый replaceRecursive(mixed $items)

Рекурсивно заменить элементы коллекции на заданные.

Перечислимый reverse()

Перевернуть порядок элементов.

mixed search(mixed $value, bool $strict = false)

Найти значение в коллекции и вернуть соответствующий ключ, если поиск успешен.

mixed shift()

Получить и удалить первый элемент из коллекции.

Перечислимый shuffle(int|null $seed = null)

Перемешать элементы в коллекции.

Перечислимый skip(int $count)

Пропустить первые {$count} элементов.

Коллекция skipUntil(mixed $value)

Пропустить элементы в коллекции до тех пор, пока не будет выполнено данное условие.

Коллекция skipWhile(mixed $value)

Пропустить элементы в коллекции, пока выполняется данное условие.

Перечислимый slice(int $offset, int|null $length = null)

Выделить часть массива лежащей в основе коллекции.

Перечислимый split(int $numberOfGroups)

Разбить коллекцию на определенное количество групп.

Перечислимый chunk(int $size)

Разбить коллекцию на куски заданного размера.

Перечислимый sort(callable|null|int $callback = null)

Отсортировать элементы с помощью обратного вызова.

Перечислимый sortDesc(int $options = SORT_REGULAR)

Отсортировать элементы в порядке убывания.

Перечислимый sortBy(callable|string $callback, int $options = SORT_REGULAR, bool $descending = false)

Отсортировать коллекцию с помощью заданного обратного вызова.

Перечислимый sortByDesc(callable|string $callback, int $options = SORT_REGULAR)

Отсортировать коллекцию в порядке убывания с помощью заданного обратного вызова.

Перечислимый sortKeys(int $options = SORT_REGULAR, bool $descending = false)

Отсортировать ключи коллекции.

Перечислимый sortKeysDesc(int $options = SORT_REGULAR)

Отсортировать ключи коллекции в порядке убывания.

Коллекция splice(int $offset, int|null $length = null, mixed $replacement = [])

Выполнить вставку в массив базовой коллекции.

Перечислимый take(int $limit)

Взять первые или последние {$limit} элементов.

Коллекция takeUntil(mixed $value)

Взять элементы из коллекции до тех пор, пока не выполняется заданное условие.

Коллекция takeWhile(mixed $value)

Взять элементы из коллекции, пока выполняется заданное условие.

$this transform(callable $callback)

Преобразовать каждый элемент в коллекции с помощью обратного вызова.

Перечислимый values()

Сбросить ключи в базовом массиве.

Коллекция zip(mixed $items)

Объединить коллекцию с одним или несколькими массивами.

Перечислимый pad(int $size, mixed $value)

Заполнить коллекцию до заданной длины значением.

ArrayIterator getIterator()

Получить итератор для элементов.

int count()

Подсчитать количество элементов в коллекции.

Перечислимый countBy(callable|string $countBy = null)

Подсчитать количество элементов в коллекции по полю или с помощью обратного вызова.

$this add(mixed $item)

Добавить элемент в коллекцию.

Коллекция toBase()

Получить экземпляр базовой коллекции Support из этой коллекции.

bool offsetExists(mixed $key)

Определить, существует ли элемент по заданному смещению.

mixed offsetGet(mixed $key)

Получить элемент по заданному смещению.

void offsetSet(mixed $key, mixed $value)

Установить элемент по заданному смещению.

void offsetUnset(string $key)

Удалить элемент по заданному смещению.

Подробности

static EnumeratesValues make(mixed $items = [])

Создать новый экземпляр коллекции, если значение не является коллекцией.

Parameters

mixed $items

Return Value

EnumeratesValues

static EnumeratesValues wrap(mixed $value)

Оборачивает заданное значение в коллекцию, если это возможно.

Parameters

mixed $value

Return Value

EnumeratesValues

static array unwrap(array|EnumeratesValues $value)

Получить базовые элементы из заданной коллекции, если это возможно.

Parameters

array|EnumeratesValues $value

Return Value

array

mixed average(callable|string|null $callback = null)

Псевдоним для метода "avg".

Parameters

callable|string|null $callback

Return Value

mixed

bool some(mixed $key, mixed $operator = null, mixed $value = null)

Псевдоним для метода "contains".

Parameters

mixed $key
mixed $operator
mixed $value

Return Value

bool

bool containsStrict(mixed $key, mixed $value = null)

Определить, существует ли элемент, используя строгое сравнение.

Parameters

mixed $key
mixed $value

Return Value

bool

void dd(mixed ...$args)

Вывести элементы и завершить выполнение скрипта.

Parameters

mixed ...$args

Return Value

void

$this dump()

Вывести элементы.

Return Value

$this

$this each(callable $callback)

Выполнить обратный вызов для каждого элемента.

Параметры

callable $callback

Значение возврата

$this

EnumeratesValues eachSpread(callable $callback)

Выполнить обратный вызов для каждого вложенного фрагмента элементов.

Параметры

callable $callback

Значение возврата

EnumeratesValues

bool every(string|callable $key, mixed $operator = null, mixed $value = null)

Определить, проходят ли все элементы заданный тест истинности.

Параметры

string|callable $key
mixed $operator
mixed $value

Значение возврата

bool

mixed firstWhere(string $key, mixed $operator = null, mixed $value = null)

Получить первый элемент по заданной паре ключ-значение.

Параметры

string $key
mixed $operator
mixed $value

Значение возврата

mixed

bool isNotEmpty()

Определить, не пуста ли коллекция.

Значение возврата

bool

EnumeratesValues mapSpread(callable $callback)

Применить отображение к каждому вложенному фрагменту элементов.

Параметры

callable $callback

Значение возврата

EnumeratesValues

EnumeratesValues mapToGroups(callable $callback)

Применить отображение группировки к элементам.

Обратный вызов должен вернуть ассоциативный массив с единственной парой ключ/значение.

Параметры

callable $callback

Значение возврата

EnumeratesValues

EnumeratesValues flatMap(callable $callback)

Применить отображение к коллекции и сплющить результат на один уровень.

Параметры

callable $callback

Значение возврата

EnumeratesValues

EnumeratesValues mapInto(string $class)

Применить отображение значений в новый класс.

Параметры

string $class

Значение возврата

EnumeratesValues

mixed min(callable|string|null $callback = null)

Получить минимальное значение заданного ключа.

Параметры

callable|string|null $callback

Значение возврата

mixed

mixed max(callable|string|null $callback = null)

Получить максимальное значение заданного ключа.

Параметры

callable|string|null $callback

Значение возврата

mixed

EnumeratesValues forPage(int $page, int $perPage)

Разбить коллекцию на страницы с помощью слайсинга.

Параметры

int $page
int $perPage

Значение возврата

EnumeratesValues

EnumeratesValues partition(callable|string $key, mixed $operator = null, mixed $value = null)

Разделить коллекцию на два массива, используя обратный вызов или ключ.

Параметры

callable|string $key
mixed $operator
mixed $value

Значение возврата

EnumeratesValues

mixed sum(callable|string|null $callback = null)

Получить сумму заданных значений.

Параметры

callable|string|null $callback

Значение возврата

mixed

EnumeratesValues|mixed when(bool|mixed $value, callable $callback = null, callable $default = null)

Применить обратный вызов, если значение истинно.

Параметры

bool|mixed $value
callable $callback
callable $default

Значение возврата

EnumeratesValues|mixed

EnumeratesValues|mixed whenEmpty(callable $callback, callable $default = null)

Применить обратный вызов, если коллекция пуста.

Параметры

callable $callback
callable $default

Значение возврата

EnumeratesValues|mixed

EnumeratesValues|mixed whenNotEmpty(callable $callback, callable $default = null)

Применить обратный вызов, если коллекция не пуста.

Параметры

callable $callback
callable $default

Значение возврата

EnumeratesValues|mixed

EnumeratesValues|смешанный тип unless(bool $value, callable $callback, callable $default = null)

Применить обратный вызов, если значение ложное.

Параметры

bool $value
callable $callback
callable $default

Возвращаемое значение

EnumeratesValues|смешанный тип

EnumeratesValues|смешанный тип unlessEmpty(callable $callback, callable $default = null)

Применить обратный вызов, если коллекция пуста.

Параметры

callable $callback
callable $default

Возвращаемое значение

EnumeratesValues|смешанный тип

EnumeratesValues|смешанный тип unlessNotEmpty(callable $callback, callable $default = null)

Применить обратный вызов, если коллекция не пуста.

Параметры

callable $callback
callable $default

Возвращаемое значение

EnumeratesValues|смешанный тип

EnumeratesValues where(string $key, mixed $operator = null, mixed $value = null)

Фильтровать элементы по заданной паре ключ-значение.

Параметры

string $key
mixed $operator
mixed $value

Возвращаемое значение

EnumeratesValues

EnumeratesValues whereNull(string|null $key = null)

Фильтровать элементы, где заданный ключ не равен null.

Параметры

string|null $key

Возвращаемое значение

EnumeratesValues

EnumeratesValues whereNotNull(string|null $key = null)

Фильтровать элементы, где заданный ключ равен null.

Параметры

string|null $key

Возвращаемое значение

EnumeratesValues

EnumeratesValues whereStrict(string $key, mixed $value)

Фильтровать элементы по заданной паре ключ-значение с использованием строгого сравнения.

Параметры

string $key
mixed $value

Возвращаемое значение

EnumeratesValues

EnumeratesValues whereIn(string $key, mixed $values, bool $strict = false)

Фильтровать элементы по заданной паре ключ-значение.

Параметры

string $key
mixed $values
bool $strict

Возвращаемое значение

EnumeratesValues
END_OF_DOCUMENT_MARKER

EnumeratesValues whereInStrict(string $key, mixed $values)

Фильтровать элементы по заданной паре ключ-значение с использованием строгого сравнения.

Параметры

string $key
mixed $values

Возвращаемое значение

EnumeratesValues

EnumeratesValues whereBetween(string $key, array $values)

Фильтровать элементы таким образом, чтобы значение заданного ключа находилось между заданными значениями.

Параметры

string $key
array $values

Возвращаемое значение

EnumeratesValues

EnumeratesValues whereNotBetween(string $key, array $values)

Фильтровать элементы таким образом, чтобы значение заданного ключа не находилось между заданными значениями.

Параметры

string $key
array $values

Возвращаемое значение

EnumeratesValues

EnumeratesValues whereNotIn(string $key, mixed $values, bool $strict = false)

Фильтровать элементы по заданной паре ключ-значение.

Параметры

string $key
mixed $values
bool $strict

Возвращаемое значение

EnumeratesValues

EnumeratesValues whereNotInStrict(string $key, mixed $values)

Фильтровать элементы по заданной паре ключ-значение с использованием строгого сравнения.

Параметры

string $key
mixed $values

Возвращаемое значение

EnumeratesValues

EnumeratesValues whereInstanceOf(string $type)

Фильтровать элементы, удаляя любые элементы, которые не соответствуют заданному типу.

Параметры

string $type

Возвращаемое значение

EnumeratesValues

mixed pipe(callable $callback)

Передать коллекцию заданному обработчику и вернуть результат.

Параметры

callable $callback

Возвращаемое значение

mixed

$this tap(callable $callback)

Передать коллекцию заданному обработчику, а затем вернуть её.

Параметры

callable $callback

Возвращаемое значение

$this

EnumeratesValues reject(callable|mixed $callback = true)

Создать коллекцию всех элементов, которые не проходят заданный тест истинности.

Параметры

callable|mixed $callback

Значение возврата

EnumeratesValues

EnumeratesValues unique(string|callable|null $key = null, bool $strict = false)

Возвратить только уникальные элементы из массива коллекции.

Параметры

string|callable|null $key
bool $strict

Значение возврата

EnumeratesValues

EnumeratesValues uniqueStrict(string|callable|null $key = null)

Возвратить только уникальные элементы из массива коллекции с использованием строгого сравнения.

Параметры

string|callable|null $key

Значение возврата

EnumeratesValues

EnumeratesValues until(mixed $value) устаревшее

устаревшее

Используйте метод "takeUntil" напрямую.

Получить элементы из коллекции до тех пор, пока не будет выполнено заданное условие.

Это псевдоним метода "takeUntil".

Параметры

mixed $value

Значение возврата

EnumeratesValues

Collection collect()

Собрать значения в коллекцию.

Значение возврата

Collection

array toArray()

Получить коллекцию элементов в виде простого массива.

Значение возврата

array

array jsonSerialize()

Преобразовать объект в что-то сериализуемое в JSON.

Значение возврата

array

string toJson(int $options = 0)

Получить коллекцию элементов в формате JSON.

Параметры

int $options

Значение возврата

string

CachingIterator getCachingIterator(int $flags = CachingIterator::CALL_TOSTRING)

Получить экземпляр CachingIterator.

Параметры

int $flags

Значение возврата

CachingIterator

string __toString()

Преобразовать коллекцию в строковое представление.

Значение возврата

string

static void proxy(string $method)

Добавить метод в список проксируемых методов.

Параметры

string $method

Значение возврата

void

mixed __get(string $key)

Динамический доступ к прокси коллекций.

Параметры

string $key

Значение возврата

mixed

Исключения

Исключение

protected array getArrayableItems(mixed $items)

Массив результатов элементов из Collection или Arrayable.

Параметры

mixed $items

Значение возврата

array

protected Closure operatorForWhere(string $key, string|null $operator = null, mixed $value = null)

Получить функцию-проверяющую оператор.

Параметры

string $key
string|null $operator
mixed $value

Значение возврата

Closure

protected bool useAsCallable(mixed $value)

Определить, является ли данное значение вызываемым, но не строкой.

Параметры

mixed $value

Значение возврата

bool

protected callable valueRetriever(callable|string|null $value)

Получить функцию извлечения значения.

Параметры

callable|string|null $value

Значение возврата

callable

protected Closure equality(mixed $value)

Создать функцию для проверки равенства элемента.

Параметры

mixed $value

Значение возврата

Closure

protected Closure negate(Closure $callback)

Создать функцию, используя другую функцию, инвертировав ее результат.

Параметры

Closure $callback

Значение возврата

Closure

protected Closure identity()

Создать функцию, возвращающую то, что ей передается.

Значение возврата

Closure
END_OF_DOCUMENT_MARKER

static void macro(string $name, object|callable $macro)

Зарегистрировать пользовательское макрос.

Parameters

string $name
object|callable $macro

Return Value

void

static void mixin(object $mixin, bool $replace = true)

Смешать другой объект в класс.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

Проверить, зарегистрирован ли макрос.

Parameters

string $name

Return Value

bool

static mixed __callStatic(string $method, array $parameters)

Динамически обработать вызовы к классу.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

Динамически обработать вызовы к классу.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

void __construct(mixed $items = [])

Создать новую коллекцию.

Parameters

mixed $items

Return Value

void

static Enumerable times(int $number, callable $callback = null)

Создать новую коллекцию, вызвав обратный вызов заданное количество раз.

Parameters

int $number
callable $callback

Return Value

Enumerable

array all()

Получить все элементы в коллекции.

Return Value

array

LazyCollection lazy()

Получить ленивую коллекцию элементов в этой коллекции.

Return Value

LazyCollection

mixed avg(callable|string|null $callback = null)

Получить среднее значение заданного ключа.

Parameters

callable|string|null $callback

Return Value

mixed

mixed median(string|array|null $key = null)

Получить медиану заданного ключа.

Parameters

string|array|null $key

Return Value

mixed

array|null mode(string|array|null $key = null)

Получить моду заданного ключа.

Parameters

string|array|null $key

Return Value

array|null

Enumerable collapse()

Сжать коллекцию элементов в один массив.

Return Value

Enumerable

bool contains(mixed $key, mixed $operator = null, mixed $value = null)

Определить, существует ли элемент в коллекции.

Parameters

mixed $key
mixed $operator
mixed $value

Return Value

bool

Collection crossJoin(mixed ...$lists)

Перекрестное соединение с заданными списками, возвращая все возможные перестановки.

Parameters

mixed ...$lists

Return Value

Collection

Enumerable diff(mixed $items)

Получить элементы в коллекции, отсутствующие в заданных элементах.

Parameters

mixed $items

Return Value

Enumerable

Enumerable diffUsing(mixed $items, callable $callback)

Получить элементы в коллекции, отсутствующие в заданных элементах, используя обратный вызов.

Parameters

mixed $items
callable $callback

Return Value

Enumerable

Enumerable diffAssoc(mixed $items)

Получить элементы в коллекции, ключи и значения которых отсутствуют в заданных элементах.

Parameters

mixed $items

Return Value

Enumerable

Enumerable diffAssocUsing(mixed $items, callable $callback)

Получить элементы в коллекции, ключи и значения которых отсутствуют в заданных элементах, используя обратный вызов.

Parameters

mixed $items
callable $callback

Return Value

Enumerable

Enumerable diffKeys(mixed $items)

Получить элементы в коллекции, ключи которых отсутствуют в заданных элементах.

Параметры

mixed $items

Возвращаемое значение

Enumerable

Enumerable diffKeysUsing(mixed $items, callable $callback)

Получить элементы в коллекции, ключи которых отсутствуют в заданных элементах, используя обратный вызов.

Параметры

mixed $items
callable $callback

Возвращаемое значение

Enumerable

Enumerable duplicates(callable|null $callback = null, bool $strict = false)

Получить дублирующиеся элементы из коллекции.

Параметры

callable|null $callback
bool $strict

Возвращаемое значение

Enumerable

Enumerable duplicatesStrict(callable|null $callback = null)

Получить дублирующиеся элементы из коллекции, используя строгое сравнение.

Параметры

callable|null $callback

Возвращаемое значение

Enumerable

protected Closure duplicateComparator(bool $strict)

Получить функцию сравнения для определения дубликатов.

Параметры

bool $strict

Возвращаемое значение

Closure

Enumerable except(mixed $keys)

Получить все элементы, кроме тех, ключи которых указаны.

Параметры

mixed $keys

Возвращаемое значение

Enumerable

Enumerable filter(callable $callback = null)

Применить фильтр к каждому из элементов.

Параметры

callable $callback

Возвращаемое значение

Enumerable

mixed first(callable $callback = null, mixed $default = null)

Получить первый элемент в коллекции, удовлетворяющий заданному условию.

Параметры

callable $callback
mixed $default

Возвращаемое значение

mixed

Collection flatten(int $depth = INF)

Получить сплющенную массив элементов в коллекции.

Параметры

int $depth

Возвращаемое значение

Collection

Enumerable flip()

Перевернуть элементы в коллекции.

Возвращаемое значение

Enumerable

$this forget(string|array $keys)

Удалить элемент из коллекции по ключу.

Параметры

string|array $keys

Возвращаемое значение

$this

mixed get(mixed $key, mixed $default = null)

Получить элемент из коллекции по ключу.

Параметры

mixed $key
mixed $default

Возвращаемое значение

mixed

Enumerable groupBy(array|callable|string $groupBy, bool $preserveKeys = false)

Сгруппировать ассоциативный массив по полю или с помощью обратного вызова.

Параметры

array|callable|string $groupBy
bool $preserveKeys

Возвращаемое значение

Enumerable

Enumerable keyBy(callable|string $keyBy)

Задать ключ ассоциативному массиву по полю или с помощью обратного вызова.

Параметры

callable|string $keyBy

Возвращаемое значение

Enumerable

bool has(mixed $key)

Определить, существует ли элемент в коллекции по ключу.

Параметры

mixed $key

Возвращаемое значение

bool

string implode(string $value, string|null $glue = null)

Объединить значения заданного ключа в строку.

Параметры

string $value
string|null $glue

Возвращаемое значение

string

Enumerable intersect(mixed $items)

Пересечь коллекцию с заданными элементами.

Параметры

mixed $items

Возвращаемое значение

Enumerable

Enumerable intersectByKeys(mixed $items)

Пересечь коллекцию с заданными элементами по ключу.

Параметры

mixed $items

Возвращаемое значение

Enumerable

bool isEmpty()

Определить, пуста ли коллекция.

Возвращаемое значение

bool

string join(string $glue, string $finalGlue = '')

Объединить все элементы из коллекции с помощью строки. Для конечных элементов можно использовать отдельную строку склеивания.

Параметры

string $glue
string $finalGlue

Возвращаемое значение

string

Enumerable keys()

Получить ключи элементов коллекции.

Возвращаемое значение

Enumerable

mixed last(callable $callback = null, mixed $default = null)

Получить последний элемент из коллекции.

Параметры

callable $callback
mixed $default

Возвращаемое значение

mixed

Enumerable pluck(string|array $value, string|null $key = null)

Получить значения заданного ключа.

Параметры

string|array $value
string|null $key

Возвращаемое значение

Enumerable

Enumerable map(callable $callback)

Применить функцию к каждому элементу.

Параметры

callable $callback

Возвращаемое значение

Enumerable

Enumerable mapToDictionary(callable $callback)

Применить отображение словаря к элементам.

Функция обратного вызова должна возвращать ассоциативный массив с единственной парой ключ/значение.

Параметры

callable $callback

Возвращаемое значение

Enumerable

Enumerable mapWithKeys(callable $callback)

Применить ассоциативное отображение к каждому элементу.

Функция обратного вызова должна возвращать ассоциативный массив с единственной парой ключ/значение.

Параметры

callable $callback

Возвращаемое значение

Enumerable

Enumerable merge(mixed $items)

Объединить коллекцию с заданными элементами.

Параметры

mixed $items

Возвращаемое значение

Enumerable

Enumerable mergeRecursive(mixed $items)

Рекурсивно объединить коллекцию с заданными элементами.

Параметры

mixed $items

Возвращаемое значение

Enumerable

Enumerable combine(mixed $values)

Создать коллекцию, используя эту коллекцию для ключей и другую для значений.

Параметры

mixed $values

Возвращаемое значение

Enumerable

Enumerable union(mixed $items)

Объединить коллекцию с заданными элементами.

Параметры

mixed $items

Возвращаемое значение

Enumerable

Enumerable nth(int $step, int $offset = 0)

Создать новую коллекцию, состоящую из каждого n-ого элемента.

Параметры

int $step
int $offset

Возвращаемое значение

Enumerable

Enumerable only(mixed $keys)

Получить элементы с указанными ключами.

Параметры

mixed $keys

Возвращаемое значение

Enumerable

mixed pop()

Получить и удалить последний элемент из коллекции.

Возвращаемое значение

mixed

$this prepend(mixed $value, mixed $key = null)

Добавить элемент в начало коллекции.

Параметры

mixed $value
mixed $key

Возвращаемое значение

$this

$this push(mixed ...$values)

Добавить один или несколько элементов в конец коллекции.

Параметры

mixed ...$values

Возвращаемое значение

$this

Enumerable concat(iterable $source)

Добавить все заданные элементы в коллекцию.

Параметры

iterable $source

Возвращаемое значение

Enumerable

mixed pull(mixed $key, mixed $default = null)

Получить и удалить элемент из коллекции.

Параметры

mixed $key
mixed $default

Возвращаемое значение

mixed

$this put(mixed $key, mixed $value)

Поместить элемент в коллекцию по ключу.

Параметры

mixed $key
mixed $value

Возвращаемое значение

$this

Enumerable|смешанный random(int|null $number = null)

Получить один или заданное количество элементов случайным образом из коллекции.

Параметры

int|null $number

Возвращаемое значение

Enumerable|смешанный

Исключения

InvalidArgumentException

смешанный reduce(callable $callback, mixed $initial = null)

Свести коллекцию к одному значению.

Параметры

callable $callback
смешанный $initial

Возвращаемое значение

смешанный

Enumerable replace(mixed $items)

Заменить элементы коллекции заданными элементами.

Параметры

смешанный $items

Возвращаемое значение

Enumerable

Enumerable replaceRecursive(mixed $items)

Рекурсивно заменить элементы коллекции заданными элементами.

Параметры

смешанный $items

Возвращаемое значение

Enumerable

Enumerable reverse()

Перевернуть порядок элементов.

Возвращаемое значение

Enumerable

смешанный search(mixed $value, bool $strict = false)

Поиск значения в коллекции и возврат соответствующего ключа, если поиск успешен.

Параметры

смешанный $value
bool $strict

Возвращаемое значение

смешанный

смешанный shift()

Получить и удалить первый элемент из коллекции.

Возвращаемое значение

смешанный

Enumerable shuffle(int|null $seed = null)

Перемешать элементы в коллекции.

Параметры

int|null $seed

Возвращаемое значение

Enumerable

Enumerable skip(int $count)

Пропустить первые {$count} элементов.

Параметры

int $count

Возвращаемое значение

Enumerable

Collection skipUntil(mixed $value)

Пропустить элементы в коллекции до тех пор, пока не будет выполнено заданное условие.

Параметры

смешанный $value

Возвращаемое значение

Collection

Collection skipWhile(mixed $value)

Пропустить элементы в коллекции, пока выполняется заданное условие.

Параметры

смешанный $value

Возвращаемое значение

Collection

Enumerable slice(int $offset, int|null $length = null)

Выделить часть массива из базовой коллекции.

Параметры

int $offset
int|null $length

Возвращаемое значение

Enumerable

Enumerable split(int $numberOfGroups)

Разделить коллекцию на определенное количество групп.

Параметры

int $numberOfGroups

Возвращаемое значение

Enumerable

Enumerable chunk(int $size)

Разбить коллекцию на куски заданного размера.

Параметры

int $size

Возвращаемое значение

Enumerable

Enumerable sort(callable|null|int $callback = null)

Отсортировать каждый элемент с помощью обратного вызова.

Параметры

callable|null|int $callback

Возвращаемое значение

Enumerable

Enumerable sortDesc(int $options = SORT_REGULAR)

Отсортировать элементы в порядке убывания.

Параметры

int $options

Возвращаемое значение

Enumerable

Enumerable sortBy(callable|string $callback, int $options = SORT_REGULAR, bool $descending = false)

Отсортировать коллекцию с помощью данного обратного вызова.

Параметры

callable|string $callback
int $options
bool $descending

Возвращаемое значение

Enumerable

Enumerable sortByDesc(callable|string $callback, int $options = SORT_REGULAR)

Отсортировать коллекцию в порядке убывания с помощью данного обратного вызова.

Параметры

callable|string $callback
int $options

Возвращаемое значение

Enumerable

Enumerable sortKeys(int $options = SORT_REGULAR, bool $descending = false)

Сортировка ключей коллекции.

Параметры

int $options
bool $descending

Возвращаемое значение

Enumerable

Enumerable sortKeysDesc(int $options = SORT_REGULAR)

Сортировка ключей коллекции в обратном порядке.

Параметры

int $options

Возвращаемое значение

Enumerable

Collection splice(int $offset, int|null $length = null, mixed $replacement = [])

Вставка в массив коллекции.

Параметры

int $offset
int|null $length
mixed $replacement

Возвращаемое значение

Collection

Enumerable take(int $limit)

Получить первые или последние {$limit} элементов.

Параметры

int $limit

Возвращаемое значение

Enumerable

Collection takeUntil(mixed $value)

Получить элементы коллекции до тех пор, пока не выполнится заданное условие.

Параметры

mixed $value

Возвращаемое значение

Collection

Collection takeWhile(mixed $value)

Получить элементы коллекции, пока выполняется заданное условие.

Параметры

mixed $value

Возвращаемое значение

Collection

$this transform(callable $callback)

Преобразовать каждый элемент коллекции с помощью обратного вызова.

Параметры

callable $callback

Возвращаемое значение

$this

Enumerable values()

Сбросить ключи в базовом массиве.

Возвращаемое значение

Enumerable

Collection zip(mixed $items)

Объединить коллекцию с одним или несколькими массивами.

e.g. new Collection([1, 2, 3])->zip([4, 5, 6]); => [[1, 4], [2, 5], [3, 6]]

Параметры

mixed $items

Возвращаемое значение

Collection

Enumerable pad(int $size, mixed $value)

Добавить элементы в коллекцию до указанной длины.

Параметры

int $size
mixed $value

Возвращаемое значение

Enumerable

ArrayIterator getIterator()

Получить итератор для элементов.

Возвращаемое значение

ArrayIterator

int count()

Подсчет элементов в коллекции.

Возвращаемое значение

int

Enumerable countBy(callable|string $countBy = null)

Подсчет элементов в коллекции по полю или с помощью обратного вызова.

Параметры

callable|string $countBy

Возвращаемое значение

Enumerable

$this add(mixed $item)

Добавить элемент в коллекцию.

Параметры

mixed $item

Возвращаемое значение

$this

Collection toBase()

Получить базовую коллекцию Support.

Возвращаемое значение

Collection

bool offsetExists(mixed $key)

Проверить существование элемента по ключу.

Параметры

mixed $key

Возвращаемое значение

bool

mixed offsetGet(mixed $key)

Получить элемент по ключу.

Параметры

mixed $key

Возвращаемое значение

mixed

void offsetSet(mixed $key, mixed $value)

Установить элемент по ключу.

Параметры

mixed $key
mixed $value

Возвращаемое значение

void

void offsetUnset(string $key)

Удалить элемент по ключу.

Параметры

string $key

Возвращаемое значение

void

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/7.x/Illuminate/Support/Collection.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API