Коллекция

класс Collection расширяет Collection и реализует QueueableCollection (View source)

Трейты

Свойства

static protected array	$proxies	Методы, которые могут быть проксированы.	из EnumeratesValues
HigherOrderCollectionProxy только для чтения	$average		из EnumeratesValues
HigherOrderCollectionProxy только для чтения	$avg		из EnumeratesValues
HigherOrderCollectionProxy только для чтения	$contains		из 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 только для чтения	$sum		из EnumeratesValues
HigherOrderCollectionProxy только для чтения	$unique		из EnumeratesValues
HigherOrderCollectionProxy только для чтения	$until		из EnumeratesValues
static protected array	$macros	Зарегистрированные строковые макросы.	из Macroable
protected array	$items	Элементы, содержащиеся в коллекции.	из Collection

Методы

static EnumeratesValues	make(mixed $items = []) Создать новый экземпляр коллекции, если значение им не является.	из EnumeratesValues
static EnumeratesValues	wrap(mixed $value) Оборачивает заданное значение в коллекцию, если применимо.	из EnumeratesValues
static array	unwrap(array\|EnumeratesValues $value) Получить базовые элементы из заданной коллекции, если применимо.	из EnumeratesValues
mixed	average(callable\|string\|null $callback = null) Псевдоним для метода "avg".	из EnumeratesValues
bool	some(mixed $key, mixed $operator = null, mixed $value = null) Псевдоним для метода "contains".	из EnumeratesValues
bool	containsStrict(mixed $key, mixed $value = null) Определить, существует ли элемент, используя строгое сравнение.	из EnumeratesValues
void	dd(mixed ...$args) Вывести элементы и завершить сценарий.	из EnumeratesValues
$this	dump() Вывести элементы.	из EnumeratesValues
$this	each(callable $callback) Выполнить обратный вызов для каждого элемента.	из EnumeratesValues
EnumeratesValues	eachSpread(callable $callback) Выполнить обратный вызов для каждого вложенного фрагмента элементов.	из EnumeratesValues
bool	every(string\|callable $key, mixed $operator = null, mixed $value = null) Определить, удовлетворяют ли все элементы заданному тесту истинности.	из EnumeratesValues
mixed	firstWhere(string $key, mixed $operator = null, mixed $value = null) Получить первый элемент по заданной паре ключ-значение.	из EnumeratesValues
bool	isNotEmpty() Определить, не пуста ли коллекция.	из EnumeratesValues
EnumeratesValues	mapSpread(callable $callback) Применить отображение к каждому вложенному фрагменту элементов.	из EnumeratesValues
EnumeratesValues	mapToGroups(callable $callback) Применить групповое отображение к элементам.	из EnumeratesValues
EnumeratesValues	flatMap(callable $callback) Применить отображение к коллекции и сгладить результат на один уровень.	из EnumeratesValues
EnumeratesValues	mapInto(string $class) Преобразовать значения в новый класс.	из EnumeratesValues
mixed	min(callable\|string\|null $callback = null) Получить минимальное значение заданного ключа.	из EnumeratesValues
mixed	max(callable\|string\|null $callback = null) Получить максимальное значение заданного ключа.	из EnumeratesValues
EnumeratesValues	forPage(int $page, int $perPage) "Разбить на страницы" коллекцию, разделив ее на более мелкие коллекции.	из EnumeratesValues
EnumeratesValues	partition(callable\|string $key, mixed $operator = null, mixed $value = null) Разделить коллекцию на два массива с помощью заданного обратного вызова или ключа.	из EnumeratesValues
mixed	sum(callable\|string\|null $callback = null) Получить сумму заданных значений.	из EnumeratesValues
EnumeratesValues\|mixed	when(bool\|mixed $value, callable $callback = null, callable $default = null) Применить обратный вызов, если значение истинно.	из EnumeratesValues
EnumeratesValues\|mixed	whenEmpty(callable $callback, callable $default = null) Применить обратный вызов, если коллекция пуста.	из EnumeratesValues
EnumeratesValues\|mixed	whenNotEmpty(callable $callback, callable $default = null) Применить обратный вызов, если коллекция не пуста.	из EnumeratesValues
EnumeratesValues\|mixed	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 $type) Фильтровать элементы, удаляя элементы, которые не соответствуют заданному типу.	из EnumeratesValues
смешанный	pipe(callable $callback) Передать коллекцию в заданный обратный вызов и вернуть результат.	из EnumeratesValues
$this	tap(callable $callback) Передать коллекцию в заданный обратный вызов, а затем вернуть её.	из EnumeratesValues
EnumeratesValues	reject(callable\|смешанный $callback = true) Создать коллекцию всех элементов, которые не проходят заданный тест истинности.	из EnumeratesValues
EnumeratesValues	unique(string\|callable\|null $key = null, bool $strict = false) Возвратить только уникальные элементы из коллекции.
EnumeratesValues	uniqueStrict(string\|callable\|null $key = null) Возвратить только уникальные элементы из массива коллекции с использованием строгого сравнения.	из EnumeratesValues
EnumeratesValues	until(mixed $value) deprecated Взять элементы в коллекции до тех пор, пока не будет выполнено заданное условие.	из EnumeratesValues
Collection	collect() Собрать значения в коллекцию.	из EnumeratesValues
массив	toArray() Получить коллекцию элементов в виде простого массива.	из EnumeratesValues
массив	jsonSerialize() Преобразовать объект в что-то сериализуемое в JSON.	из EnumeratesValues
строка	toJson(int $options = 0) Получить коллекцию элементов в формате JSON.	из EnumeratesValues
CachingIterator	getCachingIterator(int $flags = CachingIterator::CALL_TOSTRING) Получить экземпляр CachingIterator.	из EnumeratesValues

string	__toString() Преобразовать коллекцию в её строковое представление.	из EnumeratesValues
static void	proxy(string $method) Добавить метод в список прокси-методов.	из EnumeratesValues
mixed	__get(string $key) Динамический доступ к прокси-коллекциям.	из EnumeratesValues
array	getArrayableItems(mixed $items) Получить массив элементов из коллекции или объекта 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 mixed	__callStatic(string $method, array $parameters) Динамическая обработка вызовов класса.	из Macroable
mixed	__call(string $method, array $parameters) Динамическая обработка вызовов класса.	из Macroable
void	__construct(mixed $items = []) Создание новой коллекции.	из Collection
static Enumerable	times(int $number, callable $callback = null) Создание новой коллекции, вызывая обратный вызов заданное количество раз.	из Collection
array	all() Получить все элементы коллекции.	из Collection
LazyCollection	lazy() Получить ленивую коллекцию для элементов этой коллекции.	из Collection
mixed	avg(callable\|string\|null $callback = null) Получить среднее значение заданного ключа.	из Collection
mixed	median(string\|array\|null $key = null) Получить медиану заданного ключа.	из Collection
array\|null	mode(string\|array\|null $key = null) Получить моду заданного ключа.	из Collection
Enumerable	collapse() Схлопнуть коллекцию элементов в один массив.
bool	contains(mixed $key, mixed $operator = null, mixed $value = null) Определить, существует ли ключ в коллекции.
Collection	crossJoin(mixed ...$lists) Выполнить кросс-соединение с заданными списками, возвращая все возможные перестановки.	из Collection
Enumerable	diff(mixed $items) Сравнить коллекцию с заданными элементами.
Enumerable	diffUsing(mixed $items, callable $callback) Получить элементы из коллекции, отсутствующие в заданных элементах, используя обратный вызов.	из Collection
Enumerable	diffAssoc(mixed $items) Получить элементы из коллекции, у которых ключи и значения отсутствуют в заданных элементах.	из Collection
Enumerable	diffAssocUsing(mixed $items, callable $callback) Получить элементы из коллекции, у которых ключи и значения отсутствуют в заданных элементах, используя обратный вызов.	из Collection

Enumerable	diffKeys(mixed $items) Получить элементы в коллекции, ключи которых отсутствуют в заданных элементах.	из Collection
Enumerable	diffKeysUsing(mixed $items, callable $callback) Получить элементы в коллекции, ключи которых отсутствуют в заданных элементах, используя обратный вызов.	из Collection
Enumerable	duplicates(callable\|null $callback = null, bool $strict = false) Получить дублирующиеся элементы из коллекции.	из Collection
Enumerable	duplicatesStrict(callable\|null $callback = null) Получить дублирующиеся элементы из коллекции, используя строгое сравнение.	из Collection
Closure	duplicateComparator(bool $strict) Получить функцию сравнения для обнаружения дубликатов.
Enumerable	except(mixed $keys) Возвращает все модели в коллекции, за исключением моделей с указанными ключами.
Enumerable	filter(callable $callback = null) Применить фильтр к каждому элементу.	из Collection
mixed	first(callable $callback = null, mixed $default = null) Получить первый элемент из коллекции, удовлетворяющий заданному условию.	из Collection
Collection	flatten(int $depth = INF) Получить плоский массив элементов из коллекции.
Enumerable	flip() Поменять местами ключи и значения в коллекции.
$this	forget(string\|array $keys) Удалить элемент из коллекции по ключу.	из Collection
mixed	get(mixed $key, mixed $default = null) Получить элемент из коллекции по ключу.	из Collection
Enumerable	groupBy(array\|callable\|string $groupBy, bool $preserveKeys = false) Сгруппировать ассоциативный массив по полю или с помощью обратного вызова.	из Collection
Enumerable	keyBy(callable\|string $keyBy) Установить ключи ассоциативного массива по полю или с помощью обратного вызова.	из Collection
bool	has(mixed $key) Определить, существует ли элемент в коллекции по ключу.	из Collection
string	implode(string $value, string\|null $glue = null) Объединить значения заданного ключа в строку.	из Collection
Enumerable	intersect(mixed $items) Пересечь коллекцию с заданными элементами.
Enumerable	intersectByKeys(mixed $items) Пересечь коллекцию с заданными элементами по ключу.	из Collection
bool	isEmpty() Определить, пуста ли коллекция.	из Collection
string	join(string $glue, string $finalGlue = '') Объединить все элементы из коллекции с использованием строки. Для конечных элементов можно использовать отдельную строку разделителя.	из Collection
Enumerable	keys() Получить ключи элементов коллекции.
mixed	last(callable $callback = null, mixed $default = null) Получить последний элемент из коллекции.	из Collection
Enumerable	pluck(string\|array $value, string\|null $key = null) Получить массив значений заданного ключа.
Enumerable	map(callable $callback) Применить отображение к каждому элементу.
Enumerable	mapToDictionary(callable $callback) Применить отображение словаря к элементам.	из Collection
Enumerable	mapWithKeys(callable $callback) Применить ассоциативное отображение к каждому элементу.
Enumerable	merge(mixed $items) Объединить коллекцию с заданными элементами.
Enumerable	mergeRecursive(mixed $items) Рекурсивно объединить коллекцию с заданными элементами.	из Collection
Enumerable	combine(mixed $values) Создать коллекцию, используя эту коллекцию для ключей и другую для значений.	из Collection
Enumerable	union(mixed $items) Объединить коллекцию с заданными элементами.	из Collection

Enumerable	nth(int $step, int $offset = 0) Создайте новый набор, состоящий из каждого n-го элемента.	из Коллекции
Enumerable	only(mixed $keys) Возвращает только модели из набора с указанными ключами.
mixed	pop() Получить и удалить последний элемент из набора.	из Коллекции
$this	prepend(mixed $value, mixed $key = null) Добавить элемент в начало набора.	из Коллекции
$this	push(mixed ...$values) Добавить один или несколько элементов в конец набора.	из Коллекции
Enumerable	concat(iterable $source) Добавить все заданные элементы в набор.	из Коллекции
mixed	pull(mixed $key, mixed $default = null) Получить и удалить элемент из набора.	из Коллекции
$this	put(mixed $key, mixed $value) Поместить элемент в набор по ключу.	из Коллекции
Enumerable\|mixed	random(int\|null $number = null) Получить один или указанное количество элементов случайным образом из набора.	из Коллекции
mixed	reduce(callable $callback, mixed $initial = null) Свести набор к одному значению.	из Коллекции
Enumerable	replace(mixed $items) Заменить элементы набора заданными элементами.	из Коллекции
Enumerable	replaceRecursive(mixed $items) Рекурсивно заменить элементы набора заданными элементами.	из Коллекции
Enumerable	reverse() Инвертировать порядок элементов.	из Коллекции
mixed	search(mixed $value, bool $strict = false) Поиск значения в наборе и возвращение соответствующего ключа, если поиск успешен.	из Коллекции
mixed	shift() Получить и удалить первый элемент из набора.	из Коллекции
Enumerable	shuffle(int\|null $seed = null) Перемешать элементы в наборе.	из Коллекции
Enumerable	skip(int $count) Пропустить первые {$count} элементов.	из Коллекции
Collection	skipUntil(mixed $value) Пропустить элементы в наборе до тех пор, пока не будет выполнено заданное условие.	из Коллекции
Collection	skipWhile(mixed $value) Пропустить элементы в наборе, пока выполняется заданное условие.	из Коллекции
Enumerable	slice(int $offset, int\|null $length = null) Выделить часть массива базовой коллекции.	из Коллекции
Enumerable	split(int $numberOfGroups) Разделить набор на определенное количество групп.	из Коллекции
Enumerable	chunk(int $size) Разбить набор на куски заданного размера.	из Коллекции
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) Отсортировать ключи набора в порядке убывания.	из Коллекции

Коллекция	splice(int $offset, int\|null $length = null, mixed $replacement = []) Вырезать часть массива базовой коллекции.	из Коллекции
Перечисляемый	take(int $limit) Взять первые или последние {$limit} элементы.	из Коллекции
Коллекция	takeUntil(mixed $value) Взять элементы из коллекции до тех пор, пока не будет выполнено заданное условие.	из Коллекции
Коллекция	takeWhile(mixed $value) Взять элементы из коллекции до тех пор, пока выполняется заданное условие.	из Коллекции
$this	transform(callable $callback) Преобразовать каждый элемент в коллекции с помощью обратного вызова.	из Коллекции
Перечисляемый	values() Сбросить ключи в базовом массиве.	из Коллекции
Коллекция	zip(mixed $items) Сжать коллекцию вместе с одним или несколькими массивами.
Перечисляемый	pad(int $size, mixed $value) Заполнить коллекцию до указанной длины значением.
ArrayIterator	getIterator() Получить итератор для элементов.	из Коллекции
int	count() Подсчитать количество элементов в коллекции.	из Коллекции
Перечисляемый	countBy(callable\|string $countBy = null) Подсчитать количество элементов в коллекции по полю или с помощью обратного вызова.	из Коллекции
$this	add(mixed $item) Добавить элемент в коллекцию.	из Коллекции
Коллекция	toBase() Получить базовый экземпляр коллекции Support из этой коллекции.	из Коллекции
bool	offsetExists(mixed $key) Определить, существует ли элемент по указанному смещению.	из Коллекции
mixed	offsetGet(mixed $key) Получить элемент по заданному смещению.	из Коллекции
void	offsetSet(mixed $key, mixed $value) Установить элемент по заданному смещению.	из Коллекции
void	offsetUnset(string $key) Удалить элемент по заданному смещению.	из Коллекции
Модель\|Коллекция\|null	find(mixed $key, mixed $default = null) Найти модель в коллекции по ключу.
$this	load(array\|string $relations) Загрузить набор отношений в коллекцию.
$this	loadCount(array\|string $relations) Загрузить набор подсчетов отношений в коллекцию.
$this	loadMissing(array\|string $relations) Загрузить набор отношений в коллекцию, если они еще не загружены жадно.
void	loadMissingRelation(Коллекция $models, array $path) Загрузить путь к отношению, если он еще не загружен жадно.
$this	loadMorph(string $relation, array $relations) Загрузить набор отношений в смешанную коллекцию отношений.
$this	loadMorphCount(string $relation, array $relations) Загрузить набор подсчетов отношений в смешанную коллекцию отношений.
array	modelKeys() Получить массив первичных ключей.
Коллекция	fresh(array\|string $with = []) Перезагрузить свежий экземпляр модели из базы данных для всех сущностей.
$this	makeHidden(array\|string $attributes) Скрыть указанные атрибуты, обычно видимые, для всей коллекции.
$this	makeVisible(array\|string $attributes) Сделать указанные атрибуты, обычно скрытые, видимыми во всей коллекции.
$this	append(array\|string $attributes) Добавить атрибут ко всей коллекции.
array	getDictionary(ArrayAccess\|array\|null $items = null) Получить словарь, индексированный первичными ключами.
string\|null	getQueueableClass() Получить тип сущностей, которые находятся в очереди.
array	getQueueableIds() Получить идентификаторы всех сущностей.
array	getQueueableRelations() Получить отношения сущностей, находящихся в очереди.
string\|null	getQueueableConnection() Получить соединение сущностей, находящихся в очереди.
Билдер	toQuery() Получить Eloquent-билдер запроса из коллекции.

Подробности

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

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)

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

Параметры

callable|string|null

$callback

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

mixed

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

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

Параметры

callable|string|null

$callback

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

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

EnumeratesValues whereInStrict(string $key, mixed $values)

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

Parameters

string	$key
mixed	$values

Return Value

EnumeratesValues

EnumeratesValues whereBetween(string $key, array $values)

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

Parameters

string	$key
array	$values

Return Value

EnumeratesValues

EnumeratesValues whereNotBetween(string $key, array $values)

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

Parameters

string	$key
array	$values

Return Value

EnumeratesValues

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

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

Parameters

string	$key
mixed	$values
bool	$strict

Return Value

EnumeratesValues

EnumeratesValues whereNotInStrict(string $key, mixed $values)

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

Parameters

string	$key
mixed	$values

Return Value

EnumeratesValues

EnumeratesValues whereInstanceOf(string $type)

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

Parameters

string

$type

Return Value

EnumeratesValues

mixed pipe(callable $callback)

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

Parameters

callable

$callback

Return Value

mixed

$this tap(callable $callback)

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

Parameters

callable

$callback

Return Value

$this

EnumeratesValues reject(callable|mixed $callback = true)

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

Parameters

callable|mixed

$callback

Return Value

EnumeratesValues

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

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

Parameters

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

Return Value

EnumeratesValues

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

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

Parameters

string|callable|null

$key

Return Value

EnumeratesValues

EnumeratesValues until(mixed $value) deprecated

deprecated

Используйте метод "takeUntil" напрямую.

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

Это псевдоним метода "takeUntil".

Parameters

mixed

$value

Return Value

EnumeratesValues

Collection collect()

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

Return Value

Collection

array toArray()

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

Return Value

array

array jsonSerialize()

Преобразовать объект в что-то сериализуемое в JSON.

Return Value

array

string toJson(int $options = 0)

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

Parameters

int

$options

Return Value

string

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

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

Parameters

int

$flags

Return Value

CachingIterator

string __toString()

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

Return Value

string

static void proxy(string $method)

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

Parameters

string

$method

Return Value

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

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 mixed __callStatic(string $method, array $parameters)

Динамическое обращение к классу.

Параметры

string	$method
array	$parameters

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

mixed

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

Динамическое обращение к классу.

Параметры

string	$method
array	$parameters

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

mixed

Исключения

BadMethodCallException

void __construct(mixed $items = [])

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

Параметры

mixed

$items

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

void

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

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

Параметры

int	$number
callable	$callback