Spec-Zone.ru › Laravel 10

LazyCollection

class LazyCollection implements 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
$source

Методы

$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 = [])

Без описания

static wrap($value)

Без описания

из EnumeratesValues
static unwrap($value)

Без описания

из EnumeratesValues
static EnumeratesValues empty()

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

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

Без описания

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

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

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

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

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

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

из EnumeratesValues
$this dump()

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

из EnumeratesValues
$this each(callable $callback)

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

из EnumeratesValues
EnumeratesValues eachSpread(callable $callback)

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

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

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

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

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

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

Без описания

из EnumeratesValues
ensure($type)

Без описания

из EnumeratesValues
bool isNotEmpty()

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

из EnumeratesValues
mapSpread(callable $callback)

Без описания

из EnumeratesValues
mapToGroups(callable $callback)

Без описания

из EnumeratesValues
flatMap(callable $callback)

Без описания

из EnumeratesValues
mapInto($class)

Без описания

из EnumeratesValues
mixed min($callback = null)

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

из EnumeratesValues
mixed max($callback = null)

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

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

«Разбить» набор, разделив его на меньшие наборы.

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

Без описания

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

Вычислить процент элементов, прошедших заданный тест на истинность.

из EnumeratesValues
mixed sum($callback = null)

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

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

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

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

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

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

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

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

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

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

Без описания

from 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
__construct($source = null)

Без описания

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

Без описания

array all()

Без описания

LazyCollection eager()

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

LazyCollection remember()

Кэшировать значения по мере их перечисления.

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

Без описания

countBy($countBy = null)

Без описания

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)

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

Enumerable except(TKey>|TKey> $keys)

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

Enumerable filter(callable $callback = null)

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

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

Нет описания

Enumerable flatten(int $depth = INF)

Нет описания

flip()

Нет описания

get($key, $default = null)

Нет описания

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)

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

LazyCollection intersectUsing()

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

LazyCollection intersectAssoc(TValue>|TValue> $items)

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

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

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

LazyCollection select(TKey>|TKey>|string $keys)

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

concat($source)

Нет описания

random($number = null)

Нет описания

Enumerable replace(TValue>|TValue> $items)

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

Enumerable replaceRecursive(TValue>|TValue> $items)

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

Enumerable reverse()

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

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

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

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)

Без описания

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

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

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

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

chunk($size)

Без описания

splitIn($numberOfGroups)

Без описания

chunkWhile(callable $callback)

Без описания

Enumerable sort($callback = null)

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

Enumerable sortDesc(int $options = SORT_REGULAR)

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

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

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

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)

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

Enumerable take(int $limit)

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

Enumerable takeUntil($value)

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

LazyCollection takeUntilTimeout(DateTimeInterface $timeout)

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

Enumerable takeWhile($value)

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

LazyCollection tapEach(callable $callback)

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

LazyCollection dot()

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

Enumerable undot()

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

values()

Без описания

zip($items)

Без описания

pad($size, $value)

Без описания

Traversable getIterator()

Получить итератор значений.

int count()

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

makeIterator($source)

Без описания

explodePluckParameters(string|string[] $value, string|string[]|null $key)

Разделить аргументы «значение» и «ключ», переданные в «pluck».

LazyCollection passthru(string $method, array $params)

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

int now()

Получить текущее время.

Подробности

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

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

Параметры

$value
Обратный вызов $callback
Обратный вызов $default

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

$this|TWhenReturnType

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

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

Параметры

$value
Обратный вызов $callback
Обратный вызов $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

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)

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

Параметры

$callback

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

mixed

EnumeratesValues forPage(int $page, int $perPage)

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

Параметры

int $page
int $perPage

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

EnumeratesValues

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

Без описания

Параметры

$key
$operator
$value

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

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

Параметры

callable $callback
int $precision

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

float|null

mixed sum($callback = null)

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

Параметры

$callback

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

mixed

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

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

Параметры

callable $callback
callable $default

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

$this|TWhenEmptyReturnType

$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

TPipeIntoValue pipeInto(TPipeIntoValue> $class)

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

Параметры

TPipeIntoValue> $class

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

TPipeIntoValue

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

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

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

Параметры

callable $callback
TReduceWithKeysInitial $initial

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

TReduceWithKeysReturnType

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

Исключения

Исключение

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

__construct($source = null)

Без описания

Параметры

$source

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

Без описания

Параметры

int $from
int $to

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

Enumerable

array all()

Без описания

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

array

LazyCollection eager()

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

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

LazyCollection

LazyCollection remember()

Кэшировать значения по мере их перечисления.

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

LazyCollection

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
END_OF_DOCUMENT_MARKER

crossJoin(...$arrays)

Без описания

Параметры

...$arrays

countBy($countBy = null)

Без описания

Параметры

$countBy

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

Enumerable except(TKey>|TKey> $keys)

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

Параметры

TKey>|TKey> $keys

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

Enumerable

Enumerable filter(callable $callback = null)

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

Параметры

callable $callback

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

Enumerable

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

Без описания

Параметры

callable $callback
$default

Enumerable flatten(int $depth = INF)

Без описания

Параметры

int $depth

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

Enumerable

flip()

Без описания

get($key, $default = null)

Без описания

Параметры

$key
$default

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

LazyCollection intersectUsing()

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

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

LazyCollection

LazyCollection intersectAssoc(TValue>|TValue> $items)

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

Параметры

TValue>|TValue> $items

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

LazyCollection

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

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

Параметры

TValue>|TValue> $items
callable $callback

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

LazyCollection

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

Нет описания

Параметры

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

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

LazyCollection select(TKey>|TKey>|string $keys)

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

Параметры

TKey>|TKey>|string $keys

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

LazyCollection

concat($source)

Нет описания

Параметры

$source

random($number = null)

Нет описания

Параметры

$number
END_OF_DOCUMENT_MARKER

Enumerable replace(TValue>|TValue> $items)

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

Parameters

TValue>|TValue> $items

Return Value

Enumerable

Enumerable replaceRecursive(TValue>|TValue> $items)

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

Parameters

TValue>|TValue> $items

Return Value

Enumerable

Enumerable reverse()

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

Return Value

Enumerable

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

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

Parameters

$value
bool $strict

Return Value

TKey|bool

Enumerable shuffle(int|null $seed = null)

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

Parameters

int|null $seed

Return Value

Enumerable

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

Без описания

Parameters

$size
$step

Enumerable skip(int $count)

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

Parameters

int $count

Return Value

Enumerable

Enumerable skipUntil($value)

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

Parameters

$value

Return Value

Enumerable

Enumerable skipWhile($value)

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

Parameters

$value

Return Value

Enumerable

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

Получить срез элементов из перечислимого.

Parameters

int $offset
int|null $length

Return Value

Enumerable

split($numberOfGroups)

Без описания

Parameters

$numberOfGroups

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

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

Parameters

$key
mixed $operator
mixed $value

Return Value

TValue

Exceptions

ItemNotFoundException
MultipleItemsFoundException

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

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

Parameters

$key
mixed $operator
mixed $value

Return Value

TValue

Exceptions

ItemNotFoundException

chunk($size)

Без описания

Parameters

$size

splitIn($numberOfGroups)

Без описания

Parameters

$numberOfGroups

chunkWhile(callable $callback)

Без описания

Parameters

callable $callback

Enumerable sort($callback = null)

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

Parameters

$callback

Return Value

Enumerable

Enumerable sortDesc(int $options = SORT_REGULAR)

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

Parameters

int $options

Return Value

Enumerable

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

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

Parameters

$callback
int $options
bool $descending

Return Value

Enumerable

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

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

Parameters

$callback
int $options

Return Value

Enumerable

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

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

Parameters

int $options
bool $descending

Return Value

Enumerable

Enumerable sortKeysDesc(int $options = SORT_REGULAR)

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

Parameters

int $options

Return Value

Enumerable

Enumerable sortKeysUsing(callable $callback)

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

Parameters

callable $callback

Return Value

Enumerable

Enumerable take(int $limit)

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

Parameters

int $limit

Return Value

Enumerable

Enumerable takeUntil($value)

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

Parameters

$value

Return Value

Enumerable

LazyCollection takeUntilTimeout(DateTimeInterface $timeout)

Взятие элементов из коллекции до заданного момента времени.

Parameters

DateTimeInterface $timeout

Return Value

LazyCollection

Enumerable takeWhile($value)

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

Parameters

$value

Return Value

Enumerable

LazyCollection tapEach(callable $callback)

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

Parameters

callable $callback

Return Value

LazyCollection

LazyCollection dot()

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

Return Value

LazyCollection

Enumerable undot()

Преобразование развернутого массива с обозначением "точка" в расширенный массив.

Return Value

Enumerable

values()

Без описания

zip($items)

Без описания

Parameters

$items

pad($size, $value)

Без описания

Parameters

$size
$value

Traversable getIterator()

Получение итератора значений.

Return Value

Traversable

int count()

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

Return Value

int

protected makeIterator($source)

Без описания

Parameters

$source

protected explodePluckParameters(string|string[] $value, string|string[]|null $key)

Разделение аргументов "значение" и "ключ", переданных в "pluck".

Parameters

string|string[] $value
string|string[]|null $key

protected LazyCollection passthru(string $method, array $params)

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

Parameters

string $method
array $params

Return Value

LazyCollection

protected int now()

Получение текущего времени.

Return Value

int

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

Spec-Zone.ru

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