Spec-Zone.ru › Laravel 9

Коллекция

класс Коллекция реализует ArrayAccess, CanBeEscapedWhenCastToString, Enumerable (Просмотр исходного кода)

Трейты

EnumeratesValues
Macroable
Conditionable

Свойства

protected bool $escapeWhenCastingToString

Указывает, что строковое представление объекта должно быть экранировано при вызове __toString.

из EnumeratesValues
static protected array<int,string> $proxies

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

из EnumeratesValues
HigherOrderCollectionProxy только для чтения $average из EnumeratesValues
HigherOrderCollectionProxy только для чтения $avg из EnumeratesValues
HigherOrderCollectionProxy только для чтения $contains из EnumeratesValues
HigherOrderCollectionProxy только для чтения $doesntContain из 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 только для чтения $skipUntil из EnumeratesValues
HigherOrderCollectionProxy только для чтения $skipWhile из EnumeratesValues
HigherOrderCollectionProxy только для чтения $some из EnumeratesValues
HigherOrderCollectionProxy только для чтения $sortBy из EnumeratesValues
HigherOrderCollectionProxy только для чтения $sortByDesc из EnumeratesValues
HigherOrderCollectionProxy только для чтения $sum из EnumeratesValues
HigherOrderCollectionProxy только для чтения $takeUntil из EnumeratesValues
HigherOrderCollectionProxy только для чтения $takeWhile из EnumeratesValues
HigherOrderCollectionProxy только для чтения $unique из EnumeratesValues
HigherOrderCollectionProxy только для чтения $unless из EnumeratesValues
HigherOrderCollectionProxy только для чтения $until из EnumeratesValues
HigherOrderCollectionProxy только для чтения $when из EnumeratesValues
статический защищённый массив $macros

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

из Macroable
защищённый $items

Методы

$this|TWhenReturnType when($value = null, callable $callback = null, callable $default = null)

Применить обратный вызов, если заданное «значение» истинно (или разрешается до истинного).

из Conditionable
$this|TUnlessReturnType unless($value = null, callable $callback = null, callable $default = null)

Применить обратный вызов, если заданное «значение» ложно (или разрешается до ложного).

из Conditionable
static make($items = [])

Нет описания

из EnumeratesValues
static wrap($value)

Нет описания

из EnumeratesValues
static unwrap($value)

Нет описания

из EnumeratesValues
static EnumeratesValues empty()

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

из EnumeratesValues
static times($number, callable $callback = null)

Нет описания

из EnumeratesValues
float|int|null average($callback = null)

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

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

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

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

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

из EnumeratesValues
$this dump()

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

из EnumeratesValues
$this each(callable $callback)

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

из EnumeratesValues
EnumeratesValues eachSpread(callable $callback)

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

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

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

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

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

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

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

из EnumeratesValues
bool isNotEmpty()

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

из EnumeratesValues
mapSpread(callable $callback)

Нет описания

из EnumeratesValues
mapToGroups(callable $callback)

Нет описания

из EnumeratesValues
flatMap(callable $callback)

Нет описания

из EnumeratesValues
mapInto($class)

Нет описания

из EnumeratesValues
mixed min($callback = null)

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

из EnumeratesValues
mixed max($callback = null)

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

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

«Разбить» коллекцию на более мелкие коллекции.

из EnumeratesValues
partition($key, $operator = null, $value = null)

Нет описания

из EnumeratesValues
mixed sum($callback = null)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

from EnumeratesValues
EnumeratesValues whereIn(string $key, Arrayable|iterable $values, bool $strict = false)

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

from EnumeratesValues
EnumeratesValues whereInStrict(string $key, Arrayable|iterable $values)

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

from EnumeratesValues
EnumeratesValues whereBetween(string $key, Arrayable|iterable $values)

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

from EnumeratesValues
EnumeratesValues whereNotBetween(string $key, Arrayable|iterable $values)

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

from EnumeratesValues
EnumeratesValues whereNotIn(string $key, Arrayable|iterable $values, bool $strict = false)

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

from EnumeratesValues
EnumeratesValues whereNotInStrict(string $key, Arrayable|iterable $values)

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

from EnumeratesValues
whereInstanceOf($type)

Без описания

from EnumeratesValues
TPipeReturnType pipe(callable $callback)

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

from EnumeratesValues
mixed pipeInto(class-string $class)

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

from EnumeratesValues
mixed pipeThrough(callable[] $callbacks)

Передать коллекцию через ряд вызываемых функций-фильтров и вернуть результат.

from EnumeratesValues
TReduceReturnType reduce(callable $callback, TReduceInitial $initial = null)

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

from EnumeratesValues
array reduceSpread(callable $callback, mixed ...$initial)

Свести коллекцию к нескольким агрегированным значениям.

from EnumeratesValues
EnumeratesValues reject($callback = true)

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

from EnumeratesValues
$this tap(callable $callback)

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

from EnumeratesValues
Enumerable unique($key = null, bool $strict = false)

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

EnumeratesValues uniqueStrict($key = null)

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

from EnumeratesValues
TValue> collect()

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

from EnumeratesValues
toArray()

Без описания

from EnumeratesValues
array jsonSerialize()

Без описания

from EnumeratesValues
string toJson(int $options = 0)

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

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

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

from EnumeratesValues
string __toString()

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

из EnumeratesValues
$this escapeWhenCastingToString(bool $escape = true)

Указать, что строковое представление модели должно быть экранировано при вызове __toString.

из EnumeratesValues
static void proxy(string $method)

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

из EnumeratesValues
mixed __get(string $key)

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

из EnumeratesValues
getArrayableItems($items)

Без описания

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

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

из EnumeratesValues
bool useAsCallable(mixed $value)

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

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

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

из EnumeratesValues
equality(mixed $value)

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

из EnumeratesValues
Closure negate(Closure $callback)

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

из EnumeratesValues
identity()

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

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

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

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

Добавить другой объект в класс.

из Macroable
static bool hasMacro(string $name)

Проверка регистрации макроса.

из Macroable
static void flushMacros()

Очистка существующих макросов.

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

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

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

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

из Macroable
void __construct(TValue>|TValue>|null $items = [])

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

static Enumerable range(int $from, int $to)

Без описания

array all()

Без описания

TValue> lazy()

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

float|int|null 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)

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

duplicateComparator(bool $strict)

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

Enumerable except(TKey>|TKey> $keys)

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

Enumerable filter(callable $callback = null)

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

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

Без описания

Enumerable flatten(int $depth = INF)

Без описания

flip()

Без описания

$this forget(TKey|TKey> $keys)

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

get($key, $default = null)

Без описания

mixed getOrPut(mixed $key, mixed $value)

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

groupBy($groupBy, $preserveKeys = false)

Без описания

keyBy($keyBy)

Без описания

bool has(TKey|TKey> $key)

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

bool hasAny(mixed $key)

Определить, существуют ли какие-либо ключи в коллекции.

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

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

Enumerable intersect(TValue>|TValue> $items)

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

Collection intersectUsing(TValue>|TValue> $items, callable $callback)

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

Collection intersectAssoc(TValue>|TValue> $items)

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

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)

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

pop($count = 1)

Без описания

$this prepend(TValue $value, TKey $key = null)

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

$this push(TValue ...$values)

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

Enumerable concat(TValue> $source)

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

pull($key, $default = null)

Без описания

$this put(TKey $key, TValue $value)

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

random($number = null)

Без описания

Enumerable replace(TValue>|TValue> $items)

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

Enumerable replaceRecursive(TValue>|TValue> $items)

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

Enumerable reverse()

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

TKey|bool search($value, bool $strict = false)

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

shift($count = 1)

Без описания

Enumerable shuffle(int|null $seed = null)

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

sliding($size = 2, $step = 1)

Без описания

Enumerable skip(int $count)

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

Enumerable skipUntil($value)

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

Enumerable skipWhile($value)

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

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

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

split($numberOfGroups)

Без описания

splitIn($numberOfGroups)

Без описания

TValue sole($key = null, mixed $operator = null, mixed $value = null)

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

TValue firstOrFail($key = null, mixed $operator = null, mixed $value = null)

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

chunk($size)

Без описания

chunkWhile(callable $callback)

Без описания

Enumerable sort($callback = null)

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

Enumerable sortDesc(int $options = SORT_REGULAR)

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

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

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

Collection sortByMany(array $comparisons = [])

Сортировка коллекции с использованием нескольких сравнений.

Enumerable sortByDesc($callback, int $options = SORT_REGULAR)

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

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

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

Enumerable sortKeysDesc(int $options = SORT_REGULAR)

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

Enumerable sortKeysUsing(callable $callback)

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

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

Вставить/удалить часть массива, лежащего в основе коллекции.

Enumerable take(int $limit)

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

Enumerable takeUntil($value)

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

Enumerable takeWhile($value)

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

$this transform(callable $callback)

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

Enumerable undot()

Преобразовать массив с «точечной» нотацией в расширенный массив.

values()

Без описания

zip($items)

Без описания

pad($size, $value)

Без описания

Traversable getIterator()

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

int count()

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

countBy($countBy = null)

Без описания

$this add(TValue $item)

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

TValue> toBase()

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

bool offsetExists(TKey $key)

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

mixed offsetGet(TKey $key)

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

void offsetSet(TKey|null $key, TValue $value)

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

void offsetUnset(TKey $key)

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

Подробности

$this|TWhenReturnType when($value = null, callable $callback = null, callable $default = null)

Применить обратный вызов, если заданное «значение» истинно (или разрешается в истинное).

Параметры

$value
callable $callback
callable $default

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

$this|TWhenReturnType

$this|TUnlessReturnType unless($value = null, callable $callback = null, callable $default = null)

Применить обратный вызов, если заданное «значение» ложно (или разрешается в ложное).

Параметры

$value
callable $callback
callable $default

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

$this|TUnlessReturnType

static make($items = [])

Без описания

Параметры

$items

static wrap($value)

Без описания

Параметры

$value

static unwrap($value)

Без описания

Параметры

$value

static EnumeratesValues empty()

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

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

EnumeratesValues

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

Без описания

Параметры

$number
callable $callback

float|int|null average($callback = null)

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

Параметры

$callback

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

float|int|null

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

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

Параметры

$key
mixed $operator
mixed $value

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

bool

never dd(mixed ...$args)

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

Параметры

mixed ...$args

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

never

$this dump()

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

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

$this

$this each(callable $callback)

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

Параметры

callable $callback

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

$this

EnumeratesValues eachSpread(callable $callback)

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

Параметры

callable $callback

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

EnumeratesValues

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

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

Параметры

$key
mixed $operator
mixed $value

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

bool

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

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

Параметры

callable|string $key
mixed $operator
mixed $value

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

TValue|null

mixed value(string $key, mixed $default = null)

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

Параметры

string $key
mixed $default

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

mixed

bool isNotEmpty()

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

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

bool

mapSpread(callable $callback)

Без описания

Параметры

callable $callback

mapToGroups(callable $callback)

Без описания

Параметры

callable $callback

flatMap(callable $callback)

Без описания

Параметры

callable $callback

mapInto($class)

Без описания

Параметры

$class

mixed min($callback = null)

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

Параметры

$callback

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

mixed

mixed max($callback = null)

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

Параметры

$callback

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

mixed

EnumeratesValues forPage(int $page, int $perPage)

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

Параметры

int $page
int $perPage

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

EnumeratesValues

partition($key, $operator = null, $value = null)

Без описания

Параметры

$key
$operator
$value

mixed sum($callback = null)

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

Параметры

$callback

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

mixed

$this|TWhenEmptyReturnType whenEmpty(callable $callback, callable $default = null)

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

Параметры

callable $callback
callable $default

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

$this|TWhenEmptyReturnType
END_OF_DOCUMENT_MARKER

$this|TWhenNotEmptyReturnType whenNotEmpty(callable $callback, callable $default = null)

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

Параметры

callable $callback
callable $default

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

$this|TWhenNotEmptyReturnType

$this|TUnlessEmptyReturnType unlessEmpty(callable $callback, callable $default = null)

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

Параметры

callable $callback
callable $default

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

$this|TUnlessEmptyReturnType

$this|TUnlessNotEmptyReturnType unlessNotEmpty(callable $callback, callable $default = null)

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

Параметры

callable $callback
callable $default

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

$this|TUnlessNotEmptyReturnType

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

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

Параметры

callable|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, Arrayable|iterable $values, bool $strict = false)

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

Параметры

string $key
Arrayable|iterable $values
bool $strict

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

EnumeratesValues

EnumeratesValues whereInStrict(string $key, Arrayable|iterable $values)

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

Параметры

string $key
Arrayable|iterable $values

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

EnumeratesValues

EnumeratesValues whereBetween(string $key, Arrayable|iterable $values)

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

Параметры

string $key
Arrayable|iterable $values

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

EnumeratesValues

EnumeratesValues whereNotBetween(string $key, Arrayable|iterable $values)

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

Параметры

string $key
Arrayable|iterable $values

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

EnumeratesValues

EnumeratesValues whereNotIn(string $key, Arrayable|iterable $values, bool $strict = false)

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

Параметры

string $key
Arrayable|iterable $values
bool $strict

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

EnumeratesValues

EnumeratesValues whereNotInStrict(string $key, Arrayable|iterable $values)

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

Параметры

string $key
Arrayable|iterable $values

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

EnumeratesValues

whereInstanceOf($type)

Нет описания

Параметры

$type

TPipeReturnType pipe(callable $callback)

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

Параметры

callable $callback

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

TPipeReturnType

mixed pipeInto(class-string $class)

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

Параметры

class-string $class

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

mixed

mixed pipeThrough(callable[] $callbacks)

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

Параметры

callable[] $callbacks

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

mixed

TReduceReturnType reduce(callable $callback, TReduceInitial $initial = null)

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

Параметры

callable $callback
TReduceInitial $initial

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

TReduceReturnType

array reduceSpread(callable $callback, mixed ...$initial)

Свести коллекцию к нескольким агрегированным значениям.

Параметры

callable $callback
mixed ...$initial

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

array

Исключения

UnexpectedValueException

EnumeratesValues reject($callback = true)

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

Параметры

$callback

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

EnumeratesValues

$this tap(callable $callback)

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

Параметры

callable $callback

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

$this

Enumerable unique($key = null, bool $strict = false)

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

Параметры

$key
bool $strict

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

Enumerable

EnumeratesValues uniqueStrict($key = null)

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

Параметры

$key

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

EnumeratesValues

TValue> collect()

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

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

TValue>

toArray()

Без описания

array jsonSerialize()

Без описания

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

array

string toJson(int $options = 0)

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

Параметры

int $options

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

string

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

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

Параметры

int $flags

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

CachingIterator

string __toString()

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

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

string

$this escapeWhenCastingToString(bool $escape = true)

Указать, что строковое представление модели должно быть экранировано при вызове __toString.

Параметры

bool $escape

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

$this

static void proxy(string $method)

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

Параметры

string $method

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

void

mixed __get(string $key)

Динамически получить доступ к прокси-объектам коллекции.

Параметры

string $key

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

mixed

Исключения

Exception

protected getArrayableItems($items)

Без описания

Параметры

$items

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

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

Параметры

callable|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 equality(mixed $value)

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

Параметры

mixed $value

protected Closure negate(Closure $callback)

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

Параметры

Closure $callback

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

Closure

protected identity()

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

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

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

Параметры

string $name
object|callable $macro

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

void

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

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

Параметры

object $mixin
bool $replace

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

void

Исключения

ReflectionException

static bool hasMacro(string $name)

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

Параметры

string $name

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

bool

static void flushMacros()

Очистить существующие макросы.

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

void

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

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

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

void __construct(TValue>|TValue>|null $items = [])

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

Параметры

TValue>|TValue>|null $items

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

void

static Enumerable range(int $from, int $to)

Нет описания

Параметры

int $from
int $to

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

Enumerable

array all()

Нет описания

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

array

TValue> lazy()

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

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

TValue>

float|int|null avg($callback = null)

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

Параметры

$callback

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

float|int|null

float|int|null median(string|array<array-key,string>|null $key = null)

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

Параметры

string|array<array-key,string>|null $key

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

float|int|null

array<int,float|int>|null mode(string|array<array-key,string>|null $key = null)

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

Параметры

string|array<array-key,string>|null $key

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

array<int,float|int>|null

collapse()

Нет описания

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

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

Параметры

$key
mixed $operator
mixed $value

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

bool

bool containsStrict($key, TValue|null $value = null)

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

Параметры

$key
TValue|null $value

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

bool

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

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

Параметры

mixed $key
mixed $operator
mixed $value

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

bool

crossJoin(...$lists)

Нет описания

Параметры

...$lists

Enumerable diff(TValue>|TValue> $items)

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

Параметры

TValue>|TValue> $items

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

Enumerable
END_OF_DOCUMENT_MARKER

Enumerable diffUsing(TValue>|TValue> $items, callable $callback)

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

Parameters

TValue>|TValue> $items
callable $callback

Return Value

Enumerable

Enumerable diffAssoc(TValue>|TValue> $items)

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

Parameters

TValue>|TValue> $items

Return Value

Enumerable

Enumerable diffAssocUsing(TValue>|TValue> $items, callable $callback)

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

Parameters

TValue>|TValue> $items
callable $callback

Return Value

Enumerable

Enumerable diffKeys(TValue>|TValue> $items)

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

Parameters

TValue>|TValue> $items

Return Value

Enumerable

Enumerable diffKeysUsing(TValue>|TValue> $items, callable $callback)

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

Parameters

TValue>|TValue> $items
callable $callback

Return Value

Enumerable

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

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

Parameters

$callback
bool $strict

Return Value

Enumerable

Enumerable duplicatesStrict($callback = null)

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

Parameters

$callback

Return Value

Enumerable

protected duplicateComparator(bool $strict)

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

Parameters

bool $strict

Enumerable except(TKey>|TKey> $keys)

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

Parameters

TKey>|TKey> $keys

Return Value

Enumerable

Enumerable filter(callable $callback = null)

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

Parameters

callable $callback

Return Value

Enumerable

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

Без описания

Parameters

callable $callback
$default

Enumerable flatten(int $depth = INF)

Без описания

Parameters

int $depth

Return Value

Enumerable

flip()

Без описания

$this forget(TKey|TKey> $keys)

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

Parameters

TKey|TKey> $keys

Return Value

$this

get($key, $default = null)

Без описания

Parameters

$key
$default

mixed getOrPut(mixed $key, mixed $value)

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

Parameters

mixed $key
mixed $value

Return Value

mixed

groupBy($groupBy, $preserveKeys = false)

Без описания

Parameters

$groupBy
$preserveKeys

keyBy($keyBy)

Без описания

Parameters

$keyBy

bool has(TKey|TKey> $key)

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

Parameters

TKey|TKey> $key

Return Value

bool

bool hasAny(mixed $key)

Определить, существуют ли какие-либо ключи в коллекции.

Parameters

mixed $key

Return Value

bool

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

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

Parameters

string $value
string|null $glue

Return Value

string

Enumerable intersect(TValue>|TValue> $items)

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

Parameters

TValue>|TValue> $items

Return Value

Enumerable

Collection intersectUsing(TValue>|TValue> $items, callable $callback)

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

Parameters

TValue>|TValue> $items
callable $callback

Return Value

Collection

Collection intersectAssoc(TValue>|TValue> $items)

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

Parameters

TValue>|TValue> $items

Return Value

Collection

Collection intersectAssocUsing(TValue>|TValue> $items, callable $callback)

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

Parameters

TValue>|TValue> $items
callable $callback

Return Value

Collection

Enumerable intersectByKeys(TValue>|TValue> $items)

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

Parameters

TValue>|TValue> $items

Return Value

Enumerable

bool isEmpty()

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

Return Value

bool

bool containsOneItem()

Определить, содержит ли коллекция один элемент.

Return Value

bool

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

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

Parameters

string $glue
string $finalGlue

Return Value

string

keys()

Без описания

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

Без описания

Parameters

callable $callback
$default

pluck($value, $key = null)

Без описания

Parameters

$value
$key

map(callable $callback)

Без описания

Parameters

callable $callback

mapToDictionary(callable $callback)

Без описания

Parameters

callable $callback

mapWithKeys(callable $callback)

Без описания

Parameters

callable $callback

Enumerable merge(TValue>|TValue> $items)

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

Parameters

TValue>|TValue> $items

Return Value

Enumerable

mergeRecursive($items)

Без описания

Parameters

$items

combine($values)

Без описания

Parameters

$values

Enumerable union(TValue>|TValue> $items)

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

Parameters

TValue>|TValue> $items

Return Value

Enumerable

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

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

Parameters

int $step
int $offset

Return Value

Enumerable

Enumerable only(TKey>|TKey>|string $keys)

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

Parameters

TKey>|TKey>|string $keys

Return Value

Enumerable

pop($count = 1)

Без описания

Parameters

$count

$this prepend(TValue $value, TKey $key = null)

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

Parameters

TValue $value
TKey $key

Return Value

$this
END_OF_DOCUMENT_MARKER

$this push(TValue ...$values)

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

Параметры

TValue ...$values

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

$this

Enumerable concat(TValue> $source)

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

Параметры

TValue> $source

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

Enumerable

pull($key, $default = null)

Нет описания

Параметры

$key
$default

$this put(TKey $key, TValue $value)

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

Параметры

TKey $key
TValue $value

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

$this

random($number = null)

Нет описания

Параметры

$number

Enumerable replace(TValue>|TValue> $items)

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

Параметры

TValue>|TValue> $items

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

Enumerable

Enumerable replaceRecursive(TValue>|TValue> $items)

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

Параметры

TValue>|TValue> $items

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

Enumerable

Enumerable reverse()

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

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

Enumerable

TKey|bool search($value, bool $strict = false)

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

Параметры

$value
bool $strict

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

TKey|bool

shift($count = 1)

Нет описания

Параметры

$count

Enumerable shuffle(int|null $seed = null)

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

Параметры

int|null $seed

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

Enumerable

sliding($size = 2, $step = 1)

Нет описания

Параметры

$size
$step

Enumerable skip(int $count)

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

Параметры

int $count

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

Enumerable

Enumerable skipUntil($value)

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

Параметры

$value

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

Enumerable

Enumerable skipWhile($value)

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

Параметры

$value

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

Enumerable

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

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

Параметры

int $offset
int|null $length

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

Enumerable

split($numberOfGroups)

Нет описания

Параметры

$numberOfGroups

splitIn($numberOfGroups)

Нет описания

Параметры

$numberOfGroups

TValue sole($key = null, mixed $operator = null, mixed $value = null)

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

Параметры

$key
mixed $operator
mixed $value

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

TValue

Исключения

ItemNotFoundException
MultipleItemsFoundException

TValue firstOrFail($key = null, mixed $operator = null, mixed $value = null)

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

Параметры

$key
mixed $operator
mixed $value

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

TValue

Исключения

ItemNotFoundException

chunk($size)

Нет описания

Параметры

$size

chunkWhile(callable $callback)

Без описания

Параметры

callable $callback

Enumerable sort($callback = null)

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

Параметры

$callback

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

Enumerable

Enumerable sortDesc(int $options = SORT_REGULAR)

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

Параметры

int $options

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

Enumerable

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

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

Параметры

$callback
int $options
bool $descending

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

Enumerable

protected Collection sortByMany(array $comparisons = [])

Сортировка коллекции с использованием нескольких сравнений.

Параметры

array $comparisons

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

Collection

Enumerable sortByDesc($callback, int $options = SORT_REGULAR)

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

Параметры

$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

Enumerable sortKeysUsing(callable $callback)

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

Параметры

callable $callback

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

Enumerable

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

Вставка фрагмента в массив коллекции.

Параметры

int $offset
int|null $length
TValue> $replacement

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

Collection

Enumerable take(int $limit)

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

Параметры

int $limit

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

Enumerable

Enumerable takeUntil($value)

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

Параметры

$value

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

Enumerable

Enumerable takeWhile($value)

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

Параметры

$value

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

Enumerable

$this transform(callable $callback)

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

Параметры

callable $callback

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

$this

Enumerable undot()

Преобразование плоского массива с нотацией «точка» в расширенный массив.

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

Enumerable

values()

Без описания

zip($items)

Без описания

Параметры

$items

pad($size, $value)

Без описания

Параметры

$size
$value

Traversable getIterator()

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

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

Traversable

int count()

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

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

int

countBy($countBy = null)

Без описания

Параметры

$countBy

$this add(TValue $item)

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

Параметры

TValue $item

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

$this

TValue> toBase()

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

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

TValue>

bool offsetExists(TKey $key)

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

Параметры

TKey $key

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

bool

mixed offsetGet(TKey $key)

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

Параметры

TKey $key

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

mixed

void offsetSet(TKey|null $key, TValue $value)

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

Параметры

TKey|null $key
TValue $value

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

void

void offsetUnset(TKey $key)

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

Параметры

TKey $key

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

void

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

Spec-Zone.ru

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