EnumeratesValues

trait EnumeratesValues (View source)

Свойства

static protected array	$proxies	Методы, которые могут быть проксированы.
HigherOrderCollectionProxy только для чтения	$average
HigherOrderCollectionProxy только для чтения	$avg
HigherOrderCollectionProxy только для чтения	$contains
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 только для чтения	$sortBy
HigherOrderCollectionProxy только для чтения	$sortByDesc
HigherOrderCollectionProxy только для чтения	$sum
HigherOrderCollectionProxy только для чтения	$unique

Методы

static EnumeratesValues	make(mixed $items = []) Создать новый экземпляр коллекции, если значение не является коллекцией.
static EnumeratesValues	wrap(mixed $value) Оборачивает данное значение в коллекцию, если применимо.
static array	unwrap(array\|EnumeratesValues $value) Получить базовые элементы из заданной коллекции, если применимо.
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, 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 $type) Фильтрует элементы, удаляя те, которые не соответствуют заданному типу.
mixed	pipe(callable $callback) Передает коллекцию заданному обрамботке и возвращает результат.
$this	tap(callable $callback) Передает коллекцию заданному обрамботке и возвращает её.
EnumeratesValues	reject(callable\|mixed $callback = true) Создаёт коллекцию из всех элементов, которые не удовлетворяют заданному условию.
EnumeratesValues	unique(string\|callable\|null $key = null, bool $strict = false) Возвращает только уникальные элементы из массива коллекции.
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.
EnumeratesValues	countBy(callable\|null $callback = null) Подсчитать количество элементов в коллекции, используя заданное условие.
string	__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) Получить обратный вызов получения значения.

Подробности

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

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)

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

Parameters

callable

$callback

Return Value

EnumeratesValues

EnumeratesValues mapToGroups(callable $callback)

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

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

Parameters

callable

$callback

Return Value

EnumeratesValues

EnumeratesValues flatMap(callable $callback)

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

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)

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

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

Применить callback, если значение истинно.

Parameters

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

Return Value

EnumeratesValues|mixed

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

Применить callback, если коллекция пуста.

Parameters

callable	$callback
callable	$default

Return Value

EnumeratesValues|mixed

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

Применить callback, если коллекция не пуста.

Parameters

callable	$callback
callable	$default

Return Value

EnumeratesValues|mixed

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

Применить callback, если значение ложно.

Parameters

bool	$value
callable	$callback
callable	$default

Return Value

EnumeratesValues|mixed

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

Применить callback, если коллекция не пуста.

Parameters

callable	$callback
callable	$default

Return Value

EnumeratesValues|mixed

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

Применить callback, если коллекция пуста.

Parameters

callable	$callback
callable	$default

Return Value

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 $type)

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

Параметры

string

$type

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

EnumeratesValues

mixed pipe(callable $callback)

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

Параметры

callable

$callback

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

mixed

$this tap(callable $callback)

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

Параметры

callable

$callback

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

$this

EnumeratesValues reject(callable|mixed $callback = true)

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

Параметры

callable|mixed

$callback

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

EnumeratesValues

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

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

Параметры

string\|callable\|null	$key
bool	$strict

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

EnumeratesValues

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

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

Параметры

string|callable|null

$key

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

EnumeratesValues

Коллекция collect()

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

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

Коллекция

массив toArray()

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

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

массив

массив jsonSerialize()

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

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

массив

строка toJson(int $options = 0)

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

Параметры

int

$options

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

строка

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

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

Параметры

int

$flags

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

CachingIterator

EnumeratesValues countBy(callable|null $callback = null)

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

Параметры

callable|null

$callback

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

EnumeratesValues

строка __toString()

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

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

строка

статический void proxy(string $method)

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

Параметры

строка

$method

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

void

смешанный тип __get(string $key)

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

Параметры

строка

$key

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

смешанный тип

Исключения

Исключение

защищенный массив getArrayableItems(mixed $items)

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

Параметры

смешанный тип

$items

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

массив

защищенный Замыкание operatorForWhere(string $key, string|null $operator = null, mixed $value = null)

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

Параметры

строка	$key
строка\|null	$operator
смешанный тип	$value

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

Замыкание

защищенный логическое значение useAsCallable(mixed $value)

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

Параметры

смешанный тип

$value

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

логическое значение

защищенный обратный вызов valueRetriever(callable|string|null $value)

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

Параметры

обратный вызов|строка|null

$value

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

обратный вызов

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