Коллекция

класс Коллекция расширяет Коллекцию и реализует Интерфейс очереди (Просмотр исходного кода)

Трейты

Свойства

static protected array	$proxies	Методы, которые могут быть проксированы.	from EnumeratesValues
HigherOrderCollectionProxy только для чтения	$average		from EnumeratesValues
HigherOrderCollectionProxy только для чтения	$avg		from EnumeratesValues
HigherOrderCollectionProxy только для чтения	$contains		from EnumeratesValues
HigherOrderCollectionProxy только для чтения	$each		from EnumeratesValues
HigherOrderCollectionProxy только для чтения	$every		from EnumeratesValues
HigherOrderCollectionProxy только для чтения	$filter		from EnumeratesValues
HigherOrderCollectionProxy только для чтения	$first		from EnumeratesValues
HigherOrderCollectionProxy только для чтения	$flatMap		from EnumeratesValues
HigherOrderCollectionProxy только для чтения	$groupBy		from EnumeratesValues
HigherOrderCollectionProxy только для чтения	$keyBy		from EnumeratesValues
HigherOrderCollectionProxy только для чтения	$map		from EnumeratesValues
HigherOrderCollectionProxy только для чтения	$max		from EnumeratesValues
HigherOrderCollectionProxy только для чтения	$min		from EnumeratesValues
HigherOrderCollectionProxy только для чтения	$partition		from EnumeratesValues
HigherOrderCollectionProxy только для чтения	$reject		from EnumeratesValues
HigherOrderCollectionProxy только для чтения	$sortBy		from EnumeratesValues
HigherOrderCollectionProxy только для чтения	$sortByDesc		from EnumeratesValues
HigherOrderCollectionProxy только для чтения	$sum		from EnumeratesValues
HigherOrderCollectionProxy только для чтения	$unique		from EnumeratesValues
static protected array	$macros	Зарегистрированные строковые макросы.	from Macroable
protected array	$items	Элементы, содержащиеся в коллекции.	from Collection

Методы

static EnumeratesValues	make(mixed $items = []) Создать новый экземпляр коллекции, если значение ею не является.	from EnumeratesValues
static EnumeratesValues	wrap(mixed $value) Оборачивает заданное значение в коллекцию, если применимо.	from EnumeratesValues
static array	unwrap(array\|EnumeratesValues $value) Получить базовые элементы из заданной коллекции, если применимо.	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, 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\|mixed	unless(bool $value, callable $callback, callable $default = null) Применить обратный вызов, если значение ложно.	from EnumeratesValues

EnumeratesValues\|mixed	unlessEmpty(callable $callback, callable $default = null) Применить обратный вызов, если коллекция пустая.	from EnumeratesValues
EnumeratesValues\|mixed	unlessNotEmpty(callable $callback, callable $default = null) Применить обратный вызов, если коллекция не пустая.	from EnumeratesValues
EnumeratesValues	where(string $key, mixed $operator = null, mixed $value = null) Фильтровать элементы по заданной паре ключ-значение.	from EnumeratesValues
EnumeratesValues	whereNull(string\|null $key = null) Фильтровать элементы, где заданный ключ не равен null.	from EnumeratesValues
EnumeratesValues	whereNotNull(string\|null $key = null) Фильтровать элементы, где заданный ключ равен null.	from EnumeratesValues
EnumeratesValues	whereStrict(string $key, mixed $value) Фильтровать элементы по заданной паре ключ-значение с использованием строгого сравнения.	from EnumeratesValues
EnumeratesValues	whereIn(string $key, mixed $values, bool $strict = false) Фильтровать элементы по заданной паре ключ-значение.	from EnumeratesValues
EnumeratesValues	whereInStrict(string $key, mixed $values) Фильтровать элементы по заданной паре ключ-значение с использованием строгого сравнения.	from EnumeratesValues
EnumeratesValues	whereBetween(string $key, array $values) Фильтровать элементы, где значение заданного ключа находится между заданными значениями.	from EnumeratesValues
EnumeratesValues	whereNotBetween(string $key, array $values) Фильтровать элементы, где значение заданного ключа не находится между заданными значениями.	from EnumeratesValues
EnumeratesValues	whereNotIn(string $key, mixed $values, bool $strict = false) Фильтровать элементы по заданной паре ключ-значение.	from EnumeratesValues
EnumeratesValues	whereNotInStrict(string $key, mixed $values) Фильтровать элементы по заданной паре ключ-значение с использованием строгого сравнения.	from EnumeratesValues
EnumeratesValues	whereInstanceOf(string $type) Фильтровать элементы, удаляя элементы, которые не соответствуют заданному типу.	from EnumeratesValues
mixed	pipe(callable $callback) Передать коллекцию в заданный обратный вызов и вернуть результат.	from EnumeratesValues
$this	tap(callable $callback) Передать коллекцию в заданный обратный вызов, а затем вернуть её.	from EnumeratesValues
EnumeratesValues	reject(callable\|mixed $callback = true) Создать коллекцию всех элементов, которые не проходят заданный тест истинности.	from EnumeratesValues
EnumeratesValues	unique(string\|callable\|null $key = null, bool $strict = false) Возвратить только уникальные элементы из коллекции.
EnumeratesValues	uniqueStrict(string\|callable\|null $key = null) Возвратить только уникальные элементы из массива коллекции, используя строгое сравнение.	from EnumeratesValues
Collection	collect() Собрать значения в коллекцию.	from EnumeratesValues
array	toArray() Получить коллекцию элементов в виде обычного массива.	from EnumeratesValues
array	jsonSerialize() Преобразовать объект в сериализуемый в JSON.	from EnumeratesValues
string	toJson(int $options = 0) Получить коллекцию элементов в формате JSON.	from EnumeratesValues
CachingIterator	getCachingIterator(int $flags = CachingIterator::CALL_TOSTRING) Получить экземпляр CachingIterator.	from EnumeratesValues
EnumeratesValues	countBy(callable\|null $callback = null) Подсчитать количество элементов в коллекции, используя заданный тест истинности.	from EnumeratesValues

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

Enumerable	concat(iterable $source) Добавить все указанные элементы в коллекцию.	из Collection
mixed	pull(mixed $key, mixed $default = null) Получить и удалить элемент из коллекции.	из Collection
$this	put(mixed $key, mixed $value) Поместить элемент в коллекцию по ключу.	из Collection
Enumerable\|mixed	random(int\|null $number = null) Получить один или указанное количество элементов случайным образом из коллекции.	из Collection
mixed	reduce(callable $callback, mixed $initial = null) Свести коллекцию к одному значению.	из Collection
Enumerable	replace(mixed $items) Заменить элементы коллекции указанными элементами.	из Collection
Enumerable	replaceRecursive(mixed $items) Рекурсивно заменить элементы коллекции указанными элементами.	из Collection
Enumerable	reverse() Изменить порядок элементов на обратный.	из Collection
mixed	search(mixed $value, bool $strict = false) Найти в коллекции заданное значение и вернуть соответствующий ключ, если поиск успешен.	из Collection
mixed	shift() Получить и удалить первый элемент из коллекции.	из Collection
Enumerable	shuffle(int $seed = null) Перемешать элементы в коллекции.	из Collection
Enumerable	skip(int $count) Пропустить первые {$count} элементов.	из Collection
Enumerable	slice(int $offset, int $length = null) Разрезать массив базовой коллекции.	из Collection
Enumerable	split(int $numberOfGroups) Разделить коллекцию на заданное количество групп.	из Collection
Enumerable	chunk(int $size) Разбить коллекцию на части заданного размера.	из Collection
Enumerable	sort(callable $callback = null) Сортировать каждый элемент с помощью обратного вызова.	из Collection
Enumerable	sortBy(callable\|string $callback, int $options = SORT_REGULAR, bool $descending = false) Отсортировать коллекцию, используя заданный обратный вызов.	из Collection
Enumerable	sortByDesc(callable\|string $callback, int $options = SORT_REGULAR) Отсортировать коллекцию в обратном порядке, используя заданный обратный вызов.	из Collection
Enumerable	sortKeys(int $options = SORT_REGULAR, bool $descending = false) Отсортировать ключи коллекции.	из Collection
Enumerable	sortKeysDesc(int $options = SORT_REGULAR) Отсортировать ключи коллекции в обратном порядке.	из Collection
Collection	splice(int $offset, int\|null $length = null, mixed $replacement = []) Разрезать часть массива базовой коллекции.	из Collection
Enumerable	take(int $limit) Взять первые или последние {$limit} элементов.	из Collection
$this	transform(callable $callback) Преобразовать каждый элемент в коллекции, используя обратный вызов.	из Collection
Enumerable	values() Сбросить ключи в базовом массиве.	из Collection
Collection	zip(mixed $items) Объединить коллекцию с одним или несколькими массивами.
Enumerable	pad(int $size, mixed $value) Дополнить коллекцию до указанной длины значением.
ArrayIterator	getIterator() Получить итератор для элементов.	из Collection
int	count() Подсчитать количество элементов в коллекции.	из Collection
$this	add(mixed $item) Добавить элемент в коллекцию.	из Collection

Коллекция	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) Загрузить набор отношений в коллекцию, если они еще не загружены с помощью eager loading.
void	loadMissingRelation(Коллекция $models, array $path) Загрузить путь к отношению, если он еще не загружен с помощью eager loading.
$this	loadMorph(string $relation, array $relations) Загрузить набор отношений в смешанную коллекцию отношений.
array	modelKeys() Получить массив первичных ключей.
Коллекция	fresh(array\|string $with = []) Перезагрузить свежий экземпляр модели из базы данных для всех сущностей.
$this	makeHidden(array\|string $attributes) Скрыть указанные, обычно видимые, атрибуты во всей коллекции.
$this	makeVisible(array\|string $attributes) Сделать указанные, обычно скрытые, атрибуты видимыми во всей коллекции.
array	getDictionary(ArrayAccess\|array\|null $items = null) Получить словарь, индексированный первичными ключами.
string\|null	getQueueableClass() Получить тип сущностей, которые будут помещены в очередь.
array	getQueueableIds() Получить идентификаторы всех сущностей.
array	getQueueableRelations() Получить отношения сущностей, которые будут помещены в очередь.
string\|null	getQueueableConnection() Получить соединение сущностей, которые будут помещены в очередь.

Подробности

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)

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

Параметры

int	$page
int	$perPage

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

EnumeratesValues

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

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

Параметры

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

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

EnumeratesValues

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

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

Параметры

callable|string|null

$callback

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

mixed

EnumeratesValues|mixed when(bool|mixed $value, callable $callback, 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

END_OF_DOCUMENT_MARKER

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

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

EnumeratesValues countBy(callable|null $callback = null)

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

Параметры

callable|null

$callback

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

EnumeratesValues

string __toString()

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

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

string

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

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)

Создаёт новую коллекцию, вызывая callback заданное количество раз.

Параметры

int	$number
callable	$callback