Spec-Zone.ru › Laravel 11

Коллекция

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

Трейты

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 только для чтения $percentage из 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
static protected массив $macros

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

из Macroable
protected $items

Методы

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

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

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

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

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

Описание отсутствует

из EnumeratesValues
static wrap($value)

Описание отсутствует

из EnumeratesValues
static unwrap($value)

Описание отсутствует

из EnumeratesValues
static EnumeratesValues empty()

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

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

Описание отсутствует

из EnumeratesValues
float|int|null avg($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(mixed ...$args)

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

из EnumeratesValues
$this each(callable $callback)

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

из EnumeratesValues
EnumeratesValues eachSpread(callable $callback)

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

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

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

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

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

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

Описание отсутствует

из EnumeratesValues
ensure($type)

Описание отсутствует

из EnumeratesValues
bool isNotEmpty()

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

из EnumeratesValues
mapSpread(callable $callback)

Описание отсутствует

из EnumeratesValues
mapToGroups(callable $callback)

Описание отсутствует

из EnumeratesValues
flatMap(callable $callback)

Описание отсутствует

из EnumeratesValues
mapInto($class)

Описание отсутствует

из EnumeratesValues
mixed min($callback = null)

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

из EnumeratesValues
mixed max($callback = null)

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

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

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

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

Описание отсутствует

из EnumeratesValues
float|null percentage(callable $callback, int $precision = 2)

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

из EnumeratesValues
mixed sum($callback = null)

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

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

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

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

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

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

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

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

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

from 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
TPipeIntoValue pipeInto(TPipeIntoValue> $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
TReduceWithKeysReturnType reduceWithKeys(callable $callback, TReduceWithKeysInitial $initial = null)

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

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

Без описания

из EnumeratesValues
string toJson(int $options = 0)

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

из EnumeratesValues
CachingIterator getCachingIterator(int $flags = CachingIterator::CALL_TOSTRING)

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

из 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 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|null $callback = null)

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

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

Без описания

Enumerable flatten(int $depth = INF)

Без описания

flip()

Без описания

$this forget($keys)

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

get($key, $default = null)

Без описания

getOrPut($key, $value)

Без описания

groupBy($groupBy, $preserveKeys = false)

Без описания

keyBy($keyBy)

Без описания

bool has(TKey|TKey> $key)

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

bool hasAny(mixed $key)

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

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

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

Enumerable intersect(TValue>|TValue> $items)

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

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

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

Enumerable intersectAssoc(TValue>|TValue> $items)

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

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

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

Enumerable intersectByKeys(TValue>|TValue> $items)

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

bool isEmpty()

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

bool containsOneItem()

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

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

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

keys()

Без описания

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

Без описания

pluck($value, $key = null)

Без описания

map(callable $callback)

Без описания

mapToDictionary(callable $callback)

Без описания

mapWithKeys(callable $callback)

Без описания

Enumerable merge(TValue>|TValue> $items)

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

mergeRecursive($items)

Без описания

Collection multiply(int $multiplier)

Умножить элементы в коллекции на множитель.

combine($values)

Без описания

Enumerable union(TValue>|TValue> $items)

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

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

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

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

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

Collection select(TKey>|TKey>|string|null $keys)

Выбрать определённые значения из элементов в коллекции.

pop($count = 1)

Без описания

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

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

$this push(TValue ...$values)

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

$this unshift(TValue ...$values)

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

concat($source)

Без описания

pull($key, $default = null)

Без описания

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

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

random($number = null, $preserveKeys = false)

Без описания

Enumerable replace(TValue>|TValue> $items)

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

Enumerable replaceRecursive(TValue>|TValue> $items)

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

Enumerable reverse()

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

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

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

TValue|null before($value, bool $strict = false)

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

TValue|null after($value, bool $strict = false)

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

shift($count = 1)

Без описания

Enumerable shuffle()

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

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 = [], int $options = SORT_REGULAR)

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

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

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

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

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

Enumerable sortKeysDesc(int $options = SORT_REGULAR)

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

Enumerable sortKeysUsing(callable $callback)

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

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

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

Enumerable take(int $limit)

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

Enumerable takeUntil($value)

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

Enumerable takeWhile($value)

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

$this transform(callable $callback)

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

Collection dot()

Раскладывает многомерный ассоциативный массив с точками.

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|null $callback = null, callable|null $default = null)

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

Параметры

$value
callable|null $callback
callable|null $default

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

$this|TWhenReturnType

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

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

Параметры

$value
callable|null $callback
callable|null $default

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

$this|TUnlessReturnType

static make($items = [])

Без описания

Параметры

$items

static wrap($value)

Без описания

Параметры

$value

static unwrap($value)

Без описания

Параметры

$value

static EnumeratesValues empty()

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

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

EnumeratesValues

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

Без описания

Параметры

$number
callable|null $callback

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

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

Параметры

$callback

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

float|int|null

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(mixed ...$args)

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

Параметры

mixed ...$args

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

$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

value($key, $default = null)

Без описания

Параметры

$key
$default

ensure($type)

Без описания

Параметры

$type

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)

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

Parameters

$callback

Return Value

mixed

EnumeratesValues forPage(int $page, int $perPage)

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

Parameters

int $page
int $perPage

Return Value

EnumeratesValues

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

Описание отсутствует

Parameters

$key
$operator
$value

float|null percentage(callable $callback, int $precision = 2)

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

Parameters

callable $callback
int $precision

Return Value

float|null

mixed sum($callback = null)

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

Parameters

$callback

Return Value

mixed

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

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

Parameters

callable $callback
callable|null $default

Return Value

$this|TWhenEmptyReturnType

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

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

Parameters

callable $callback
callable|null $default

Return Value

$this|TWhenNotEmptyReturnType

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

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

Parameters

callable $callback
callable|null $default

Return Value

$this|TUnlessEmptyReturnType

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

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

Parameters

callable $callback
callable|null $default

Return Value

$this|TUnlessNotEmptyReturnType

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

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

Parameters

callable|string $key
mixed $operator
mixed $value

Return Value

EnumeratesValues

EnumeratesValues whereNull(string|null $key = null)

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

Parameters

string|null $key

Return Value

EnumeratesValues

EnumeratesValues whereNotNull(string|null $key = null)

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

Parameters

string|null $key

Return Value

EnumeratesValues

EnumeratesValues whereStrict(string $key, mixed $value)

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

Parameters

string $key
mixed $value

Return Value

EnumeratesValues

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

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

Parameters

string $key
Arrayable|iterable $values
bool $strict

Return Value

EnumeratesValues

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

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

Parameters

string $key
Arrayable|iterable $values

Return Value

EnumeratesValues

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

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

Parameters

string $key
Arrayable|iterable $values

Return Value

EnumeratesValues

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

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

Parameters

string $key
Arrayable|iterable $values

Return Value

EnumeratesValues

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

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

Parameters

string $key
Arrayable|iterable $values
bool $strict

Return Value

EnumeratesValues

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

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

Parameters

string $key
Arrayable|iterable $values

Return Value

EnumeratesValues

whereInstanceOf($type)

Без описания

Parameters

$type

TPipeReturnType pipe(callable $callback)

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

Parameters

callable $callback

Return Value

TPipeReturnType

TPipeIntoValue pipeInto(TPipeIntoValue> $class)

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

Parameters

TPipeIntoValue> $class

Return Value

TPipeIntoValue

mixed pipeThrough(callable[] $callbacks)

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

Parameters

callable[] $callbacks

Return Value

mixed

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

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

Parameters

callable $callback
TReduceInitial $initial

Return Value

TReduceReturnType

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

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

Parameters

callable $callback
mixed ...$initial

Return Value

array

Exceptions

UnexpectedValueException

TReduceWithKeysReturnType reduceWithKeys(callable $callback, TReduceWithKeysInitial $initial = null)

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

Parameters

callable $callback
TReduceWithKeysInitial $initial

Return Value

TReduceWithKeysReturnType

EnumeratesValues reject($callback = true)

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

Parameters

$callback

Return Value

EnumeratesValues

$this tap(callable $callback)

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

Parameters

callable $callback

Return Value

$this

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

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

Parameters

$key
bool $strict

Return Value

Enumerable

EnumeratesValues uniqueStrict($key = null)

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

Parameters

$key

Return Value

EnumeratesValues

TValue> collect()

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

Return Value

TValue>

toArray()

Без описания

array jsonSerialize()

Без описания

Return Value

array

string toJson(int $options = 0)

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

Parameters

int $options

Return Value

string

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

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

Parameters

int $flags

Return Value

CachingIterator

строка __toString()

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

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

строка

$this escapeWhenCastingToString(bool $escape = true)

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

Параметры

bool $escape

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

$this

статический пусто proxy(строка $method)

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

Параметры

строка $method

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

пусто

смешанный __get(строка $key)

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

Параметры

строка $key

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

смешанный

Исключения

Исключение

защищённый getArrayableItems($items)

Без описания

Параметры

$items

защищённый Замыкание operatorForWhere(вызываемый|строка $key, строка|null $operator = null, смешанный $value = null)

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

Параметры

вызываемый|строка $key
строка|null $operator
смешанный $value

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

Замыкание

защищённый bool useAsCallable(смешанный $value)

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

Параметры

смешанный $value

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

bool

защищённый вызываемый valueRetriever(вызываемый|строка|null $value)

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

Параметры

вызываемый|строка|null $value

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

вызываемый

защищённый equality(смешанный $value)

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

Параметры

смешанный $value

защищённый Замыкание negate(Замыкание $callback)

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

Параметры

Замыкание $callback

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

Замыкание

защищённый identity()

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

статический пусто macro(строка $name, объект|вызываемый $macro)

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

Параметры

строка $name
объект|вызываемый $macro

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

пусто

статический пусто mixin(объект $mixin, bool $replace = true)

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

Параметры

объект $mixin
bool $replace

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

пусто

Исключения

ReflectionException

статический bool hasMacro(строка $name)

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

Параметры

строка $name

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

bool

статический пусто flushMacros()

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

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

пусто

статический смешанный __callStatic(строка $method, массив $parameters)

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

Параметры

строка $method
массив $parameters

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

смешанный

Исключения

BadMethodCallException

смешанный __call(строка $method, массив $parameters)

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

Параметры

строка $method
массив $parameters

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

смешанный

Исключения

BadMethodCallException

пусто __construct(TValue>|TValue>|null $items = [])

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

Параметры

TValue>|TValue>|null $items

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

пусто

статический Enumerable range(целое $from, целое $to)

Без описания

Параметры

целое $from
целое $to

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

Enumerable

массив all()

Без описания

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

массив

TValue> lazy()

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

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

TValue>

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

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

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

Параметры

TValue>|TValue> $items
callable $callback

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

Enumerable

Enumerable diffAssoc(TValue>|TValue> $items)

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

Параметры

TValue>|TValue> $items

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

Enumerable

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

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

Параметры

TValue>|TValue> $items
callable $callback

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

Enumerable

Enumerable diffKeys(TValue>|TValue> $items)

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

Параметры

TValue>|TValue> $items

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

Enumerable

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

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

Параметры

TValue>|TValue> $items
callable $callback

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

Enumerable

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

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

Параметры

$callback
bool $strict

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

Enumerable

Enumerable duplicatesStrict($callback = null)

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

Параметры

$callback

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

Enumerable

protected duplicateComparator(bool $strict)

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

Параметры

bool $strict

Enumerable except(TKey>|TKey> $keys)

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

Параметры

TKey>|TKey> $keys

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

Enumerable

Enumerable filter(callable|null $callback = null)

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

Параметры

callable|null $callback

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

Enumerable

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

Описание отсутствует

Параметры

callable|null $callback
$default

Enumerable flatten(int $depth = INF)

Без описания

Параметры

int $depth

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

Enumerable

flip()

Без описания

$this forget($keys)

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

\Illuminate\Contracts\Support\Arrayable<array-key, TValue>|iterable<array-key, TKey>|TKey $keys

Параметры

$keys

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

$this

get($key, $default = null)

Без описания

Параметры

$key
$default

getOrPut($key, $value)

Без описания

Параметры

$key
$value

groupBy($groupBy, $preserveKeys = false)

Без описания

Параметры

$groupBy
$preserveKeys

keyBy($keyBy)

Без описания

Параметры

$keyBy

bool has(TKey|TKey> $key)

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

Параметры

TKey|TKey> $key

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

bool

bool hasAny(mixed $key)

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

Параметры

mixed $key

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

bool

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

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

Параметры

callable|string $value
string|null $glue

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

string

Enumerable intersect(TValue>|TValue> $items)

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

Параметры

TValue>|TValue> $items

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

Enumerable

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

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

Параметры

TValue>|TValue> $items
callable $callback

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

Enumerable

Enumerable intersectAssoc(TValue>|TValue> $items)

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

Параметры

TValue>|TValue> $items

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

Enumerable

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

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

Параметры

TValue>|TValue> $items
callable $callback

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

Enumerable

Enumerable intersectByKeys(TValue>|TValue> $items)

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

Параметры

TValue>|TValue> $items

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

Enumerable

bool isEmpty()

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

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

bool

bool containsOneItem()

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

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

bool

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

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

Параметры

string $glue
string $finalGlue

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

string

keys()

Без описания

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

Без описания

Параметры

callable|null $callback
$default

pluck($value, $key = null)

Без описания

Параметры

$value
$key

map(callable $callback)

Без описания

Параметры

callable $callback

mapToDictionary(callable $callback)

Без описания

Параметры

callable $callback

mapWithKeys(callable $callback)

Без описания

Параметры

callable $callback

Enumerable merge(TValue>|TValue> $items)

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

Параметры

TValue>|TValue> $items

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

Enumerable

mergeRecursive($items)

Описание отсутствует

Параметры

$items

Collection multiply(int $multiplier)

Умножить элементы в коллекции на множитель.

Параметры

int $multiplier

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

Collection

combine($values)

Описание отсутствует

Параметры

$values

Enumerable union(TValue>|TValue> $items)

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

Параметры

TValue>|TValue> $items

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

Enumerable

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

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

Параметры

int $step
int $offset

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

Enumerable

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

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

Параметры

TKey>|TKey>|string $keys

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

Enumerable

Collection select(TKey>|TKey>|string|null $keys)

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

Параметры

TKey>|TKey>|string|null $keys

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

Collection

pop($count = 1)

Описание отсутствует

Параметры

$count

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

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

Параметры

TValue $value
TKey $key

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

$this

$this push(TValue ...$values)

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

Параметры

TValue ...$values

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

$this

$this unshift(TValue ...$values)

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

Параметры

TValue ...$values

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

$this

concat($source)

Описание отсутствует

Параметры

$source

pull($key, $default = null)

Описание отсутствует

Параметры

$key
$default

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

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

Параметры

TKey $key
TValue $value

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

$this

random($number = null, $preserveKeys = false)

Описание отсутствует

Параметры

$number
$preserveKeys

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

TValue|null before($value, bool $strict = false)

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

Параметры

$value
bool $strict

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

TValue|null

TValue|null after($value, bool $strict = false)

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

Параметры

$value
bool $strict

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

TValue|null

shift($count = 1)

Описание отсутствует

Параметры

$count

Enumerable shuffle()

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

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

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 = [], int $options = SORT_REGULAR)

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

Параметры

array $comparisons
int $options

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

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
END_OF_DOCUMENT_MARKER

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

Collection dot()

Разворачивание многомерного ассоциативного массива с точками.

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

Collection

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

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

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

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/11.x/Illuminate/Support/Collection.html

Spec-Zone.ru

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