EnumeratesValues

trait EnumeratesValues (View source)

Свойства

protected bool	$escapeWhenCastingToString	Указывает, что строковое представление объекта должно быть экранировано при вызове __toString.
static protected array<int,string>	$proxies	Методы, которые могут быть проксированы.
HigherOrderCollectionProxy только для чтения	$average
HigherOrderCollectionProxy только для чтения	$avg
HigherOrderCollectionProxy только для чтения	$contains
HigherOrderCollectionProxy только для чтения	$doesntContain
HigherOrderCollectionProxy только для чтения	$each
HigherOrderCollectionProxy только для чтения	$every
HigherOrderCollectionProxy только для чтения	$filter
HigherOrderCollectionProxy только для чтения	$first
HigherOrderCollectionProxy только для чтения	$flatMap
HigherOrderCollectionProxy только для чтения	$groupBy
HigherOrderCollectionProxy только для чтения	$keyBy
HigherOrderCollectionProxy только для чтения	$map
HigherOrderCollectionProxy только для чтения	$max
HigherOrderCollectionProxy только для чтения	$min
HigherOrderCollectionProxy только для чтения	$partition
HigherOrderCollectionProxy только для чтения	$reject
HigherOrderCollectionProxy только для чтения	$skipUntil
HigherOrderCollectionProxy только для чтения	$skipWhile
HigherOrderCollectionProxy только для чтения	$some
HigherOrderCollectionProxy только для чтения	$sortBy
HigherOrderCollectionProxy только для чтения	$sortByDesc
HigherOrderCollectionProxy только для чтения	$sum
HigherOrderCollectionProxy только для чтения	$takeUntil
HigherOrderCollectionProxy только для чтения	$takeWhile
HigherOrderCollectionProxy только для чтения	$unique
HigherOrderCollectionProxy только для чтения	$unless
HigherOrderCollectionProxy только для чтения	$until
HigherOrderCollectionProxy только для чтения	$when

Методы

$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) Описание отсутствует
static	unwrap($value) Описание отсутствует
static EnumeratesValues	empty() Создать новый экземпляр без элементов.
static	times($number, callable $callback = null) Описание отсутствует
float\|int\|null	average($callback = null) Псевдоним для метода «avg».
bool	some($key, mixed $operator = null, mixed $value = null) Псевдоним для метода «contains».
never	dd(mixed ...$args) Вывести элементы и завершить сценарий.
$this	dump() Вывести элементы.
$this	each(callable $callback) Выполнить обратный вызов над каждым элементом.
EnumeratesValues	eachSpread(callable $callback) Выполнить обратный вызов над каждым вложенным фрагментом элементов.
bool	every($key, mixed $operator = null, mixed $value = null) Определить, проходят ли все элементы заданный тест на истинность.
TValue\|null	firstWhere(callable\|string $key, mixed $operator = null, mixed $value = null) Получить первый элемент по заданной паре ключ-значение.
mixed	value(string $key, mixed $default = null) Получить значение одного ключа из первого соответствующего элемента в коллекции.
bool	isNotEmpty() Определить, не пуста ли коллекция.
mapSpread(callable $callback) Описание отсутствует
mapToGroups(callable $callback) Описание отсутствует
flatMap(callable $callback) Описание отсутствует
mapInto($class) Описание отсутствует
mixed	min($callback = null) Получить минимальное значение заданного ключа.
mixed	max($callback = null) Получить максимальное значение заданного ключа.
EnumeratesValues	forPage(int $page, int $perPage) «Разбить» коллекцию на более мелкие части.
partition($key, $operator = null, $value = null) Описание отсутствует
mixed	sum($callback = null) Получить сумму заданных значений.
$this\|TWhenEmptyReturnType	whenEmpty(callable $callback, callable $default = null) Применить обратный вызов, если коллекция пуста.
$this\|TWhenNotEmptyReturnType	whenNotEmpty(callable $callback, callable $default = null) Применить обратный вызов, если коллекция не пуста.
$this\|TUnlessEmptyReturnType	unlessEmpty(callable $callback, callable $default = null) Применить обратный вызов, если коллекция не пуста.
$this\|TUnlessNotEmptyReturnType	unlessNotEmpty(callable $callback, callable $default = null) Применить обратный вызов, если коллекция пуста.
EnumeratesValues	where(callable\|string $key, mixed $operator = null, mixed $value = null) Отфильтровать элементы по заданной паре ключ-значение.
EnumeratesValues	whereNull(string\|null $key = null) Отфильтровать элементы, где значение для данного ключа равно null.
EnumeratesValues	whereNotNull(string\|null $key = null) Отфильтровать элементы, где значение для данного ключа не равно null.
EnumeratesValues	whereStrict(string $key, mixed $value) Отфильтровать элементы по заданной паре ключ-значение с использованием строгого сравнения.
EnumeratesValues	whereIn(string $key, Arrayable\|iterable $values, bool $strict = false) Отфильтровать элементы по заданной паре ключ-значение.
EnumeratesValues	whereInStrict(string $key, Arrayable\|iterable $values) Отфильтровать элементы по заданной паре ключ-значение с использованием строгого сравнения.
EnumeratesValues	whereBetween(string $key, Arrayable\|iterable $values) Отфильтровать элементы таким образом, чтобы значение заданного ключа находилось между заданными значениями.
EnumeratesValues	whereNotBetween(string $key, Arrayable\|iterable $values) Отфильтровать элементы таким образом, чтобы значение заданного ключа не находилось между заданными значениями.
EnumeratesValues	whereNotIn(string $key, Arrayable\|iterable $values, bool $strict = false) Отфильтровать элементы по заданной паре ключ-значение.
EnumeratesValues	whereNotInStrict(string $key, Arrayable\|iterable $values) Отфильтровать элементы по заданной паре ключ-значение с использованием строгого сравнения.
whereInstanceOf($type) Описание отсутствует

TPipeReturnType	pipe(callable $callback) Передать коллекцию заданному обработающему элементу и вернуть результат.
mixed	pipeInto(class-string $class) Передать коллекцию в новый класс.
mixed	pipeThrough(callable[] $callbacks) Пропустить коллекцию через серию вызываемых функций и вернуть результат.
TReduceReturnType	reduce(callable $callback, TReduceInitial $initial = null) Свести коллекцию к одному значению.
array	reduceSpread(callable $callback, mixed ...$initial) Свести коллекцию к нескольким агрегированным значениям.
EnumeratesValues	reject($callback = true) Создать коллекцию всех элементов, которые не проходят заданный логический тест.
$this	tap(callable $callback) Передать коллекцию заданному обработающему элементу и затем вернуть её.
EnumeratesValues	unique($key = null, bool $strict = false) Возвратить только уникальные элементы из массива коллекции.
EnumeratesValues	uniqueStrict($key = null) Возвратить только уникальные элементы из массива коллекции, используя строгое сравнение.
TValue>	collect() Собрать значения в коллекцию.
toArray() Без описания
array	jsonSerialize() Без описания
string	toJson(int $options = 0) Получить коллекцию элементов в формате JSON.
CachingIterator	getCachingIterator(int $flags = CachingIterator::CALL_TOSTRING) Получить экземпляр CachingIterator.
string	__toString() Преобразовать коллекцию в её строковое представление.
$this	escapeWhenCastingToString(bool $escape = true) Указать, что строковое представление модели должно быть экранировано при вызове __toString.
static void	proxy(string $method) Добавить метод в список проксируемых методов.
mixed	__get(string $key) Динамический доступ к прокси коллекций.
getArrayableItems($items) Без описания
Closure	operatorForWhere(callable\|string $key, string\|null $operator = null, mixed $value = null) Получить обратный вызов для проверки оператора.
bool	useAsCallable(mixed $value) Определить, является ли заданное значение вызываемым, но не строкой.
callable	valueRetriever(callable\|string\|null $value) Получить обратный вызов для получения значения.
equality(mixed $value) Создать функцию для проверки равенства элемента.
Closure	negate(Closure $callback) Создать функцию, использующую другую функцию, инвертируя её результат.
identity() Создать функцию, возвращающую то, что ей передано.

Подробности

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

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

Параметры

	$value
callable	$callback
callable	$default

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

$this|TWhenReturnType

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

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

Параметры

	$value
callable	$callback
callable	$default

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

$this|TUnlessReturnType

static make($items = [])

Без описания

Параметры

$items

static wrap($value)

Без описания

Параметры

$value

static unwrap($value)

Без описания

Параметры

$value

static EnumeratesValues empty()

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

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

EnumeratesValues

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

Без описания

Параметры

	$number
callable	$callback

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

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

Параметры

$callback

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

float|int|null

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

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

Параметры

	$key
mixed	$operator
mixed	$value

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

bool

never dd(mixed ...$args)

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

Параметры

mixed

...$args

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

never

END_OF_DOCUMENT_MARKER

$this dump()

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

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

$this

$this each(callable $callback)

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

Параметры

callable

$callback

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

$this

EnumeratesValues eachSpread(callable $callback)

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

Параметры

callable

$callback

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

EnumeratesValues

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

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

Параметры

	$key
mixed	$operator
mixed	$value

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

bool

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

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

Параметры

callable\|string	$key
mixed	$operator
mixed	$value

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

TValue|null

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

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

Параметры

string	$key
mixed	$default

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

mixed

bool isNotEmpty()

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

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

bool

mapSpread(callable $callback)

Без описания

Параметры

callable

$callback

mapToGroups(callable $callback)

Без описания

Параметры

callable

$callback

flatMap(callable $callback)

Без описания

Параметры

callable

$callback

mapInto($class)

Без описания

Параметры

$class

mixed min($callback = null)

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

Параметры

$callback

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

mixed

mixed max($callback = null)

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

Параметры

$callback

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

mixed

EnumeratesValues forPage(int $page, int $perPage)

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

Параметры

int	$page
int	$perPage

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

EnumeratesValues

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

Без описания

Параметры

	$key
	$operator
	$value

mixed sum($callback = null)

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

Параметры

$callback

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

mixed

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

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

Параметры

callable	$callback
callable	$default

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

$this|TWhenEmptyReturnType

$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

END_OF_DOCUMENT_MARKER

EnumeratesValues whereNull(string|null $key = null)

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

Параметры

string|null

$key

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

EnumeratesValues

EnumeratesValues whereNotNull(string|null $key = null)

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

Параметры

string|null

$key

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

EnumeratesValues

EnumeratesValues whereStrict(string $key, mixed $value)

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

Параметры

string	$key
mixed	$value

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

EnumeratesValues

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

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

Параметры

string	$key
Arrayable\|iterable	$values
bool	$strict

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

EnumeratesValues

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

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

Параметры

string	$key
Arrayable\|iterable	$values

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

EnumeratesValues

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

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

Параметры

string	$key
Arrayable\|iterable	$values

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

EnumeratesValues

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

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

Параметры

string	$key
Arrayable\|iterable	$values

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

EnumeratesValues

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

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

Параметры

string	$key
Arrayable\|iterable	$values
bool	$strict

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

EnumeratesValues

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

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

Параметры

string	$key
Arrayable\|iterable	$values

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

EnumeratesValues

whereInstanceOf($type)

Без описания

Параметры

$type

TPipeReturnType pipe(callable $callback)

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

Параметры

callable

$callback

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

TPipeReturnType

mixed pipeInto(class-string $class)

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

Параметры

class-string

$class

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

mixed

mixed pipeThrough(callable[] $callbacks)

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

Параметры

callable[]

$callbacks

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

mixed

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

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

Параметры

callable	$callback
TReduceInitial	$initial

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

TReduceReturnType

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

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

Параметры

callable	$callback
mixed	...$initial

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

array

Исключения

UnexpectedValueException

EnumeratesValues reject($callback = true)

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

Параметры

$callback

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

EnumeratesValues

$this tap(callable $callback)

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

Параметры

callable

$callback

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

$this

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

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

Параметры

	$key
bool	$strict

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

EnumeratesValues

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

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

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