EnumeratesValues

trait EnumeratesValues (View source)

Свойства

protected bool	$escapeWhenCastingToString	Указывает, что строковое представление объекта должно быть экранировано при вызове __toString.
static protected 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 только для чтения	$some
HigherOrderCollectionProxy только для чтения	$sortBy
HigherOrderCollectionProxy только для чтения	$sortByDesc
HigherOrderCollectionProxy только для чтения	$skipUntil
HigherOrderCollectionProxy только для чтения	$skipWhile
HigherOrderCollectionProxy только для чтения	$sum
HigherOrderCollectionProxy только для чтения	$takeUntil
HigherOrderCollectionProxy только для чтения	$takeWhile
HigherOrderCollectionProxy только для чтения	$unique
HigherOrderCollectionProxy только для чтения	$until

Методы

static EnumeratesValues	make(mixed $items = []) Создайте новый экземпляр коллекции, если значение не является коллекцией.
static EnumeratesValues	wrap(mixed $value) Оборачивает заданное значение в коллекцию, если применимо.
static array	unwrap(array\|EnumeratesValues $value) Получить базовые элементы из заданной коллекции, если применимо.
static EnumeratesValues	empty() Создать новый экземпляр без элементов.
static EnumeratesValues	times(int $number, callable $callback = null) Создать новую коллекцию, вызвав обратный вызов заданное количество раз.
mixed	average(callable\|string\|null $callback = null) Псевдоним для метода "avg".
bool	some(mixed $key, mixed $operator = null, mixed $value = null) Псевдоним для метода "contains".
bool	containsStrict(mixed $key, mixed $value = null) Определить, существует ли элемент, используя строгое сравнение.
void	dd(mixed ...$args) Вывести элементы и завершить сценарий.
$this	dump() Вывести элементы.
$this	each(callable $callback) Выполнить обратный вызов над каждым элементом.
EnumeratesValues	eachSpread(callable $callback) Выполнить обратный вызов над каждым вложенным фрагментом элементов.
bool	every(string\|callable $key, mixed $operator = null, mixed $value = null) Определить, проходят ли все элементы заданный тест истинности.
mixed	firstWhere(string $key, mixed $operator = null, mixed $value = null) Получить первый элемент по заданной паре ключ-значение.
bool	isNotEmpty() Определить, не пуста ли коллекция.
EnumeratesValues	mapSpread(callable $callback) Выполнить отображение над каждым вложенным фрагментом элементов.
EnumeratesValues	mapToGroups(callable $callback) Выполнить групповое отображение над элементами.
EnumeratesValues	flatMap(callable $callback) Отобразить коллекцию и уплостить результат на один уровень.
EnumeratesValues	mapInto(string $class) Отобразить значения в новый класс.
mixed	min(callable\|string\|null $callback = null) Получить минимальное значение заданного ключа.
mixed	max(callable\|string\|null $callback = null) Получить максимальное значение заданного ключа.
EnumeratesValues	forPage(int $page, int $perPage) «Усечь» коллекцию, разделив её на более мелкие коллекции.
EnumeratesValues	partition(callable\|string $key, mixed $operator = null, mixed $value = null) Разделить коллекцию на два массива, используя заданный обратный вызов или ключ.
mixed	sum(callable\|string\|null $callback = null) Получить сумму заданных значений.
EnumeratesValues\|mixed	when(bool\|mixed $value, callable $callback = null, callable $default = null) Применить обратный вызов, если значение истинно.
EnumeratesValues\|mixed	whenEmpty(callable $callback, callable $default = null) Применить обратный вызов, если коллекция пуста.
EnumeratesValues\|mixed	whenNotEmpty(callable $callback, callable $default = null) Применить обратный вызов, если коллекция не пуста.
EnumeratesValues\|mixed	unless(bool $value, callable $callback, callable $default = null) Применить обратный вызов, если значение ложно.
EnumeratesValues\|mixed	unlessEmpty(callable $callback, callable $default = null) Применить обратный вызов, если коллекция не пуста.
EnumeratesValues\|mixed	unlessNotEmpty(callable $callback, callable $default = null) Применить обратный вызов, если коллекция пуста.
EnumeratesValues	where(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, mixed $values, bool $strict = false) Фильтровать элементы по заданной паре ключ-значение.
EnumeratesValues	whereInStrict(string $key, mixed $values) Фильтровать элементы по заданной паре ключ-значение с использованием строгого сравнения.
EnumeratesValues	whereBetween(string $key, array $values) Фильтровать элементы, таким образом, чтобы значение заданного ключа было между заданными значениями.
EnumeratesValues	whereNotBetween(string $key, array $values) Фильтровать элементы, таким образом, чтобы значение заданного ключа не было между заданными значениями.

EnumeratesValues	whereNotIn(string $key, mixed $values, bool $strict = false) Фильтр элементов по заданной паре ключ-значение.
EnumeratesValues	whereNotInStrict(string $key, mixed $values) Фильтр элементов по заданной паре ключ-значение с использованием строгого сравнения.
EnumeratesValues	whereInstanceOf(string\|string[] $type) Фильтр элементов, удаляя те, которые не соответствуют заданному типу(ам).
mixed	pipe(callable $callback) Передать коллекцию в заданный обратный вызов и вернуть результат.
mixed	pipeInto(string $class) Передать коллекцию в новый класс.
mixed	pipeThrough(callable[] $pipes) Передать коллекцию через ряд вызовов-фильтров и вернуть результат.
$this	tap(callable $callback) Передать коллекцию в заданный обратный вызов, а затем вернуть её.
mixed	reduce(callable $callback, mixed $initial = null) Свести коллекцию к одному значению.
array	reduceMany(callable $callback, mixed ...$initial) deprecated Свести коллекцию к нескольким агрегированным значениям.
array	reduceSpread(callable $callback, mixed ...$initial) Свести коллекцию к нескольким агрегированным значениям.
mixed	reduceWithKeys(callable $callback, mixed $initial = null) Свести ассоциативную коллекцию к одному значению.
EnumeratesValues	reject(callable\|mixed $callback = true) Создать коллекцию всех элементов, которые не проходят заданный тест истинности.
EnumeratesValues	uniqueStrict(string\|callable\|null $key = null) Возвратить только уникальные элементы из массива коллекции с использованием строгого сравнения.
Collection	collect() Собрать значения в коллекцию.
array	toArray() Получить коллекцию элементов как обычный массив.
array	jsonSerialize() Преобразовать объект в что-то сериализуемое в JSON.
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) Динамически получить доступ к прокси-коллекциям.
array	getArrayableItems(mixed $items) Массив результатов элементов из Collection или Arrayable.
Closure	operatorForWhere(string $key, string\|null $operator = null, mixed $value = null) Получить обратный вызов-проверяльщик оператора.
bool	useAsCallable(mixed $value) Определить, является ли заданное значение вызываемым, но не строкой.
callable	valueRetriever(callable\|string\|null $value) Получить обратный вызов для извлечения значения.
Closure	equality(mixed $value) Создать функцию для проверки равенства элемента.
Closure	negate(Closure $callback) Создать функцию, используя другую функцию, инвертируя её результат.
Closure	identity() Создать функцию, которая возвращает то, что ей передано.

Подробности

static EnumeratesValues make(mixed $items = [])

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

Parameters

mixed

$items

Return Value

EnumeratesValues

static EnumeratesValues wrap(mixed $value)

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

Parameters

mixed

$value

Return Value

EnumeratesValues

static array unwrap(array|EnumeratesValues $value)

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

Parameters

array|EnumeratesValues

$value

Return Value

array

static EnumeratesValues empty()

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

Return Value

EnumeratesValues

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

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

Parameters

int	$number
callable	$callback

Return Value

EnumeratesValues

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

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

Parameters

callable|string|null

$callback

Return Value

mixed

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

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

Parameters

mixed	$key
mixed	$operator
mixed	$value

Return Value

bool

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

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

Parameters

mixed	$key
mixed	$value

Return Value

bool

void dd(mixed ...$args)

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

Parameters

mixed

...$args

Return Value

void

$this dump()

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

Return Value

$this

$this each(callable $callback)

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

Parameters

callable

$callback

Return Value

$this

EnumeratesValues eachSpread(callable $callback)

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

Parameters

callable

$callback

Return Value

EnumeratesValues

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

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

Parameters

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

Return Value

bool

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

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

Parameters

string	$key
mixed	$operator
mixed	$value

Return Value

mixed

bool isNotEmpty()

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

Return Value

bool

EnumeratesValues mapSpread(callable $callback)

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

Parameters

callable

$callback

Return Value

EnumeratesValues

EnumeratesValues mapToGroups(callable $callback)

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

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

Parameters

callable

$callback

Return Value

EnumeratesValues

EnumeratesValues flatMap(callable $callback)

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

Parameters

callable

$callback

Return Value

EnumeratesValues

EnumeratesValues mapInto(string $class)

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

Parameters

string

$class

Return Value

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)

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

Параметры

bool\|mixed	$value
callable	$callback
callable	$default

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

EnumeratesValues|mixed

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

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

Параметры

callable	$callback
callable	$default

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

EnumeratesValues|mixed

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

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

Параметры

callable	$callback
callable	$default

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

EnumeratesValues|mixed

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

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

Параметры

bool	$value
callable	$callback
callable	$default

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

EnumeratesValues|mixed

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

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

Параметры

callable	$callback
callable	$default

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

EnumeratesValues|mixed

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

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

Параметры

callable	$callback
callable	$default

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

EnumeratesValues|mixed

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

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

Параметры

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

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

Параметры

string	$key
mixed	$values
bool	$strict

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

EnumeratesValues

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

Исключения

Exception

protected array getArrayableItems(mixed $items)

Получение массива элементов из коллекции или объекта 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

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