Spec-Zone.ru › Laravel 8

LazyCollection

класс LazyCollection реализует CanBeEscapedWhenCastToString, Enumerable (Просмотреть исходный код)

Свойства

EnumeratesValues
Macroable

Свойства

protected bool $escapeWhenCastingToString

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

из EnumeratesValues
static protected string[] $proxies

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

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

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

from Macroable
callable|LazyCollection $source

Источник, из которого генерируются элементы.

Методы

static EnumeratesValues make(mixed $items = [])

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

from EnumeratesValues
static EnumeratesValues wrap(mixed $value)

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

from EnumeratesValues
static array unwrap(array|EnumeratesValues $value)

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

from EnumeratesValues
static EnumeratesValues empty()

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

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

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

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

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

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

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

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

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

from EnumeratesValues
void dd(mixed ...$args)

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

from EnumeratesValues
$this dump()

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

from EnumeratesValues
$this each(callable $callback)

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

from EnumeratesValues
EnumeratesValues eachSpread(callable $callback)

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

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

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

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

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

from EnumeratesValues
bool isNotEmpty()

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

from EnumeratesValues
EnumeratesValues mapSpread(callable $callback)

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

from EnumeratesValues
EnumeratesValues mapToGroups(callable $callback)

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

from EnumeratesValues
EnumeratesValues flatMap(callable $callback)

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

from EnumeratesValues
EnumeratesValues mapInto(string $class)

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

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

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

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

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

from EnumeratesValues
EnumeratesValues forPage(int $page, int $perPage)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

из EnumeratesValues
EnumeratesValues whereNull(string|null $key = null)

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

из EnumeratesValues
EnumeratesValues whereNotNull(string|null $key = null)

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

из EnumeratesValues
EnumeratesValues whereStrict(string $key, mixed $value)

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

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

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

из EnumeratesValues
EnumeratesValues whereInStrict(string $key, mixed $values)

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

из EnumeratesValues
EnumeratesValues whereBetween(string $key, array $values)

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

из EnumeratesValues
EnumeratesValues whereNotBetween(string $key, array $values)

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

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

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

из EnumeratesValues
EnumeratesValues whereNotInStrict(string $key, mixed $values)

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

из EnumeratesValues
EnumeratesValues whereInstanceOf(string|string[] $type)

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

из EnumeratesValues
смешанный pipe(callable $callback)

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

из EnumeratesValues
смешанный pipeInto(string $class)

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

из EnumeratesValues
смешанный pipeThrough(callable[] $pipes)

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

из EnumeratesValues
$this tap(callable $callback)

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

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

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

из EnumeratesValues
массив reduceMany(callable $callback, mixed ...$initial) deprecated

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

из EnumeratesValues
массив reduceSpread(callable $callback, mixed ...$initial)

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

из EnumeratesValues
смешанный reduceWithKeys(callable $callback, mixed $initial = null)

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

из EnumeratesValues
EnumeratesValues reject(callable|mixed $callback = true)

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

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

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

из EnumeratesValues
Collection collect()

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

из EnumeratesValues
array toArray()

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

из EnumeratesValues
array jsonSerialize()

Преобразовать объект в формат, сериализуемый в JSON.

из 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
array getArrayableItems(mixed $items)

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

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

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

из EnumeratesValues
bool useAsCallable(mixed $value)

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

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

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

из EnumeratesValues
Closure equality(mixed $value)

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

из EnumeratesValues
Closure negate(Closure $callback)

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

из EnumeratesValues
Closure identity()

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

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

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

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

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

из Macroable
static bool hasMacro(string $name)

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

из Macroable
static void flushMacros()

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

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

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

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

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

из Macroable
void __construct(mixed $source = null)

Создание нового экземпляра ленивой коллекции.

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

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

array all()

Получить все элементы в перечислимом объекте.

LazyCollection eager()

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

LazyCollection remember()

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

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

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

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

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

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

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

Enumerable collapse()

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

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

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

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

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

Enumerable crossJoin(array ...$arrays)

Перекрестное соединение заданных итерируемых объектов, возвращающее все возможные перестановки.

Enumerable countBy(callable|string $countBy = null)

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

Enumerable diff(mixed $items)

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

Enumerable diffUsing(mixed $items, callable $callback)

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

Enumerable diffAssoc(mixed $items)

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

Enumerable diffAssocUsing(mixed $items, callable $callback)

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

Enumerable diffKeys(mixed $items)

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

Enumerable diffKeysUsing(mixed $items, callable $callback)

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

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

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

Enumerable duplicatesStrict(callable|string|null $callback = null)

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

Enumerable except(mixed $keys)

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

Enumerable filter(callable $callback = null)

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

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

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

Enumerable flatten(int $depth = INF)

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

Enumerable flip()

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

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

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

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

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

Enumerable keyBy(callable|string $keyBy)

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

bool has(mixed $key)

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

bool hasAny(mixed $key)

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

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

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

Enumerable intersect(mixed $items)

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

Enumerable intersectByKeys(mixed $items)

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

bool isEmpty()

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

bool containsOneItem()

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

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

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

Enumerable keys()

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

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

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

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

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

Enumerable map(callable $callback)

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

Enumerable mapToDictionary(callable $callback)

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

Enumerable mapWithKeys(callable $callback)

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

Enumerable merge(mixed $items)

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

Enumerable mergeRecursive(mixed $items)

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

Enumerable combine(mixed $values)

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

Enumerable union(mixed $items)

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

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

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

Enumerable only(mixed $keys)

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

Enumerable concat(iterable $source)

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

Enumerable|mixed random(int|null $number = null)

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

Enumerable replace(mixed $items)

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

Enumerable replaceRecursive(mixed $items)

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

Enumerable reverse()

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

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

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

Enumerable shuffle(int|null $seed = null)

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

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

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

Enumerable skip(int $count)

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

Enumerable skipUntil(mixed $value)

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

Enumerable skipWhile(mixed $value)

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

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

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

Enumerable split(int $numberOfGroups)

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

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

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

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

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

Enumerable chunk(int $size)

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

LazyCollection splitIn(int $numberOfGroups)

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

Enumerable chunkWhile(callable $callback)

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

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

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

Enumerable sortDesc(int $options = SORT_REGULAR)

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

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

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

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

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

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

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

Enumerable sortKeysDesc(int $options = SORT_REGULAR)

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

LazyCollection sortKeysUsing(callable $callback)

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

Enumerable take(int $limit)

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

Enumerable takeUntil(mixed $value)

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

LazyCollection takeUntilTimeout(DateTimeInterface $timeout)

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

Enumerable takeWhile(mixed $value)

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

LazyCollection tapEach(callable $callback)

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

LazyCollection undot()

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

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

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

Enumerable values()

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

Enumerable zip(mixed $items)

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

Enumerable pad(int $size, mixed $value)

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

Traversable getIterator()

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

int count()

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

Traversable makeIterator(mixed $source)

Создать итератор из заданного источника.

array explodePluckParameters(string|array $value, string|array|null $key)

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

LazyCollection passthru(string $method, array $params)

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

int now()

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

Подробности

static EnumeratesValues make(mixed $items = [])

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

Параметры

mixed $items

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

EnumeratesValues

static EnumeratesValues wrap(mixed $value)

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

Параметры

mixed $value

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

EnumeratesValues

static array unwrap(array|EnumeratesValues $value)

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

Параметры

array|EnumeratesValues $value

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

array

static EnumeratesValues empty()

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

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

EnumeratesValues

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

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

Параметры

int $number
callable $callback

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

EnumeratesValues

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

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

Параметры

callable|string|null $callback

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

mixed

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

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

Параметры

mixed $key
mixed $operator
mixed $value

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

bool

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

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

Параметры

mixed $key
mixed $value

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

bool

void dd(mixed ...$args)

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

Параметры

mixed ...$args

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

void

$this dump()

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

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

$this

$this each(callable $callback)

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

Параметры

callable $callback

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

$this

EnumeratesValues eachSpread(callable $callback)

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

Параметры

callable $callback

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

EnumeratesValues

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

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

Параметры

string|callable $key
mixed $operator
mixed $value

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

bool

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

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

Параметры

string $key
mixed $operator
mixed $value

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

mixed

bool isNotEmpty()

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

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

bool

EnumeratesValues mapSpread(callable $callback)

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

Параметры

callable $callback

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

EnumeratesValues

EnumeratesValues mapToGroups(callable $callback)

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

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

Параметры

callable $callback

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

EnumeratesValues

EnumeratesValues flatMap(callable $callback)

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

Параметры

callable $callback

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

EnumeratesValues

EnumeratesValues mapInto(string $class)

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

Параметры

string $class

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

EnumeratesValues

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

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

Parameters

callable|string|null $callback

Return Value

mixed

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

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

Parameters

callable|string|null $callback

Return Value

mixed

EnumeratesValues forPage(int $page, int $perPage)

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

Parameters

int $page
int $perPage

Return Value

EnumeratesValues

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

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

Parameters

callable|string $key
mixed $operator
mixed $value

Return Value

EnumeratesValues

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

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

Parameters

callable|string|null $callback

Return Value

mixed

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

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

Parameters

bool|mixed $value
callable $callback
callable $default

Return Value

EnumeratesValues|mixed

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

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

Parameters

callable $callback
callable $default

Return Value

EnumeratesValues|mixed

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

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

Parameters

callable $callback
callable $default

Return Value

EnumeratesValues|mixed

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

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

Parameters

bool $value
callable $callback
callable $default

Return Value

EnumeratesValues|mixed

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

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

Parameters

callable $callback
callable $default

Return Value

EnumeratesValues|mixed

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

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

Parameters

callable $callback
callable $default

Return Value

EnumeratesValues|mixed

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

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

Parameters

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

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

Parameters

string $key
mixed $values
bool $strict

Return Value

EnumeratesValues
END_OF_DOCUMENT_MARKER

EnumeratesValues whereInStrict(string $key, mixed $values)

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

Параметры

string $key
mixed $values

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

EnumeratesValues

EnumeratesValues whereBetween(string $key, array $values)

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

Параметры

string $key
array $values

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

EnumeratesValues

EnumeratesValues whereNotBetween(string $key, array $values)

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

Параметры

string $key
array $values

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

EnumeratesValues

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

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

Параметры

string $key
mixed $values
bool $strict

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

EnumeratesValues

EnumeratesValues whereNotInStrict(string $key, mixed $values)

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

Параметры

string $key
mixed $values

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

EnumeratesValues

EnumeratesValues whereInstanceOf(string|string[] $type)

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

Параметры

string|string[] $type

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

EnumeratesValues

mixed pipe(callable $callback)

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

Параметры

callable $callback

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

mixed

mixed pipeInto(string $class)

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

Параметры

string $class

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

mixed

mixed pipeThrough(callable[] $pipes)

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

Параметры

callable[] $pipes

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

mixed

$this tap(callable $callback)

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

Параметры

callable $callback

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

$this

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

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

Параметры

callable $callback
mixed $initial

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

mixed

array reduceMany(callable $callback, mixed ...$initial) deprecated

deprecated

Используйте "reduceSpread" вместо этого

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

Параметры

callable $callback
mixed ...$initial

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

array

Исключения

UnexpectedValueException

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

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

Параметры

callable $callback
mixed ...$initial

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

array

Исключения

UnexpectedValueException

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

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

Параметры

callable $callback
mixed $initial

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

mixed

EnumeratesValues reject(callable|mixed $callback = true)

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

Параметры

callable|mixed $callback

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

EnumeratesValues

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

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

Параметры

string|callable|null $key

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

EnumeratesValues

Collection collect()

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

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

Collection

array toArray()

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

Значение результата

array

array jsonSerialize()

Преобразовать объект в формат, сериализуемый в JSON.

Значение результата

array

string toJson(int $options = 0)

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

Параметры

int $options

Значение результата

string

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

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

Параметры

int $flags

Значение результата

CachingIterator

string __toString()

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

Значение результата

string

$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 array getArrayableItems(mixed $items)

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

Параметры

mixed $items

Значение результата

array

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

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

Параметры

string $key
string|null $operator
mixed $value

Значение результата

Closure

protected bool useAsCallable(mixed $value)

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

Параметры

mixed $value

Значение результата

bool

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

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

Параметры

callable|string|null $value

Значение результата

callable

protected Closure equality(mixed $value)

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

Параметры

mixed $value

Значение результата

Closure

protected Closure negate(Closure $callback)

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

Параметры

Closure $callback

Значение результата

Closure

protected Closure identity()

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

Значение результата

Closure

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
END_OF_DOCUMENT_MARKER

mixed __call(string $method, array $parameters)

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

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

void __construct(mixed $source = null)

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

Параметры

mixed $source

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

void

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

Создает коллекцию с заданным диапазоном.

Параметры

int $from
int $to

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

Enumerable

array all()

Получить все элементы в перечислимом объекте.

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

array

LazyCollection eager()

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

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

LazyCollection

LazyCollection remember()

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

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

LazyCollection

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

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

Параметры

callable|string|null $callback

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

mixed

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

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

Параметры

string|array|null $key

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

mixed

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

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

Параметры

string|array|null $key

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

array|null

Enumerable collapse()

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

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

Enumerable

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

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

Параметры

mixed $key
mixed $operator
mixed $value

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

bool

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

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

Параметры

mixed $key
mixed $operator
mixed $value

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

bool

Enumerable crossJoin(array ...$arrays)

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

Параметры

array ...$arrays

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

Enumerable

Enumerable countBy(callable|string $countBy = null)

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

Параметры

callable|string $countBy

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

Enumerable

Enumerable diff(mixed $items)

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

Параметры

mixed $items

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

Enumerable

Enumerable diffUsing(mixed $items, callable $callback)

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

Параметры

mixed $items
callable $callback

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

Enumerable

Enumerable diffAssoc(mixed $items)

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

Параметры

mixed $items

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

Enumerable

Enumerable diffAssocUsing(mixed $items, callable $callback)

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

Параметры

mixed $items
callable $callback

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

Enumerable

Enumerable diffKeys(mixed $items)

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

Параметры

mixed $items

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

Enumerable

Enumerable diffKeysUsing(mixed $items, callable $callback)

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

Параметры

mixed $items
callable $callback

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

Enumerable

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

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

Параметры

callable|string|null $callback
bool $strict

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

Enumerable

Enumerable duplicatesStrict(callable|string|null $callback = null)

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

Параметры

callable|string|null $callback

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

Enumerable

Enumerable except(mixed $keys)

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

Параметры

mixed $keys

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

Enumerable

Enumerable filter(callable $callback = null)

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

Параметры

callable $callback

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

Enumerable

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

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

Параметры

callable $callback
mixed $default

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

mixed

Enumerable flatten(int $depth = INF)

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

Параметры

int $depth

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

Enumerable

Enumerable flip()

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

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

Enumerable

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

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

Параметры

mixed $key
mixed $default

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

mixed

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

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

Параметры

array|callable|string $groupBy
bool $preserveKeys

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

Enumerable

Enumerable keyBy(callable|string $keyBy)

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

Параметры

callable|string $keyBy

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

Enumerable

bool has(mixed $key)

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

Параметры

mixed $key

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

bool

bool hasAny(mixed $key)

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

Параметры

mixed $key

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

bool

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

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

Параметры

string $value
string|null $glue

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

string

Enumerable intersect(mixed $items)

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

Параметры

mixed $items

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

Enumerable

Enumerable intersectByKeys(mixed $items)

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

Параметры

mixed $items

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

Enumerable

bool isEmpty()

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

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

bool

bool containsOneItem()

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

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

bool

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

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

Параметры

string $glue
string $finalGlue

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

string

Enumerable keys()

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

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

Enumerable

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

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

Parameters

callable $callback
mixed $default

Return Value

mixed

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

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

Parameters

string|array $value
string|null $key

Return Value

Enumerable

Enumerable map(callable $callback)

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

Parameters

callable $callback

Return Value

Enumerable

Enumerable mapToDictionary(callable $callback)

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

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

Parameters

callable $callback

Return Value

Enumerable

Enumerable mapWithKeys(callable $callback)

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

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

Parameters

callable $callback

Return Value

Enumerable

Enumerable merge(mixed $items)

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

Parameters

mixed $items

Return Value

Enumerable

Enumerable mergeRecursive(mixed $items)

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

Parameters

mixed $items

Return Value

Enumerable

Enumerable combine(mixed $values)

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

Parameters

mixed $values

Return Value

Enumerable

Enumerable union(mixed $items)

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

Parameters

mixed $items

Return Value

Enumerable

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

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

Parameters

int $step
int $offset

Return Value

Enumerable

Enumerable only(mixed $keys)

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

Parameters

mixed $keys

Return Value

Enumerable

Enumerable concat(iterable $source)

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

Parameters

iterable $source

Return Value

Enumerable

Enumerable|mixed random(int|null $number = null)

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

Parameters

int|null $number

Return Value

Enumerable|mixed

Exceptions

InvalidArgumentException

Enumerable replace(mixed $items)

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

Parameters

mixed $items

Return Value

Enumerable

Enumerable replaceRecursive(mixed $items)

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

Parameters

mixed $items

Return Value

Enumerable

Enumerable reverse()

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

Return Value

Enumerable

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

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

Parameters

mixed $value
bool $strict

Return Value

mixed

Enumerable shuffle(int|null $seed = null)

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

Parameters

int|null $seed

Return Value

Enumerable

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

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

Параметры

int $size
int $step

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

LazyCollection

Enumerable skip(int $count)

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

Параметры

int $count

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

Enumerable

Enumerable skipUntil(mixed $value)

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

Параметры

mixed $value

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

Enumerable

Enumerable skipWhile(mixed $value)

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

Параметры

mixed $value

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

Enumerable

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

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

Параметры

int $offset
int|null $length

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

Enumerable

Enumerable split(int $numberOfGroups)

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

Параметры

int $numberOfGroups

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

Enumerable

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

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

Параметры

mixed $key
mixed $operator
mixed $value

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

mixed

Исключения

ItemNotFoundException
MultipleItemsFoundException

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

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

Параметры

mixed $key
mixed $operator
mixed $value

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

mixed

Исключения

ItemNotFoundException

Enumerable chunk(int $size)

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

Параметры

int $size

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

Enumerable

LazyCollection splitIn(int $numberOfGroups)

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

Параметры

int $numberOfGroups

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

LazyCollection

Enumerable chunkWhile(callable $callback)

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

Параметры

callable $callback

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

Enumerable

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

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

Параметры

callable|null|int $callback

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

Enumerable

Enumerable sortDesc(int $options = SORT_REGULAR)

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

Параметры

int $options

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

Enumerable

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

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

Параметры

callable|string $callback
int $options
bool $descending

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

Enumerable

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

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

Параметры

callable|string $callback
int $options

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

Enumerable

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

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

Параметры

int $options
bool $descending

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

Enumerable

Enumerable sortKeysDesc(int $options = SORT_REGULAR)

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

Параметры

int $options

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

Enumerable

LazyCollection sortKeysUsing(callable $callback)

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

Параметры

callable $callback

Значение, возвращаемое функцией

LazyCollection

Enumerable take(int $limit)

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

Параметры

int $limit

Значение, возвращаемое функцией

Enumerable

Enumerable takeUntil(mixed $value)

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

Параметры

mixed $value

Значение, возвращаемое функцией

Enumerable

LazyCollection takeUntilTimeout(DateTimeInterface $timeout)

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

Параметры

DateTimeInterface $timeout

Значение, возвращаемое функцией

LazyCollection

Enumerable takeWhile(mixed $value)

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

Параметры

mixed $value

Значение, возвращаемое функцией

Enumerable

LazyCollection tapEach(callable $callback)

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

Параметры

callable $callback

Значение, возвращаемое функцией

LazyCollection

LazyCollection undot()

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

Значение, возвращаемое функцией

LazyCollection

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

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

Параметры

string|callable|null $key
bool $strict

Значение, возвращаемое функцией

Enumerable

Enumerable values()

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

Значение, возвращаемое функцией

Enumerable

Enumerable zip(mixed $items)

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

например, new LazyCollection([1, 2, 3])->zip([4, 5, 6]); => [[1, 4], [2, 5], [3, 6]]

Параметры

mixed $items

Значение, возвращаемое функцией

Enumerable

Enumerable pad(int $size, mixed $value)

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

Параметры

int $size
mixed $value

Значение, возвращаемое функцией

Enumerable

Traversable getIterator()

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

Значение, возвращаемое функцией

Traversable

int count()

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

Значение, возвращаемое функцией

int

protected Traversable makeIterator(mixed $source)

Создать итератор из заданного источника.

Параметры

mixed $source

Значение, возвращаемое функцией

Traversable

protected array explodePluckParameters(string|array $value, string|array|null $key)

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

Параметры

string|array $value
string|array|null $key

Значение, возвращаемое функцией

array

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

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

Параметры

string $method
array $params

Значение, возвращаемое функцией

LazyCollection

protected int now()

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

Значение, возвращаемое функцией

int

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

Spec-Zone.ru

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