Коллекция

класс Коллекция расширяет Коллекцию и реализует QueueableCollection (Просмотреть исходный код)

Трейты

Свойства

статический защищённый массив	$macros	Зарегистрированные строковые макросы.	из Macroable
защищённый массив	$items	Элементы, содержащиеся в коллекции.	из Коллекции

Методы

static void	macro(string $name, callable $macro) Зарегистрировать пользовательское макрокоманду.	from Macroable
static bool	hasMacro(string $name) Проверить, зарегистрирована ли макрокоманда.	from Macroable
static mixed	__callStatic(string $method, array $parameters) Динамически обработать вызовы к классу.	from Macroable
mixed	__call(string $method, array $parameters) Динамически обработать вызовы к классу.	from Macroable
void	__construct(mixed $items = []) Создать новую коллекцию.	from Collection
static Collection	make(mixed $items = []) Создать новый экземпляр коллекции, если значение не является коллекцией.	from Collection
array	all() Получить все элементы из коллекции.	from Collection
mixed	avg(string\|null $key = null) Получить среднее значение заданного ключа.	from Collection
mixed	average(string\|null $key = null) Псевдоним для метода "avg".	from Collection
mixed\|null	median(null $key = null) Получить медиану заданного ключа.	from Collection
array	mode(null $key = null) Получить моду заданного ключа.	from Collection
Collection	collapse() Сжать коллекцию элементов в один массив.
bool	contains(mixed $key, mixed $value = null) Определить, существует ли ключ в коллекции.
Collection	diff(mixed $items) Разница между коллекцией и заданными элементами.
Collection	diffKeys(mixed $items) Получить элементы в коллекции, ключи которых отсутствуют в заданных элементах.	from Collection
$this	each(callable $callback) Выполнить обратный вызов для каждого элемента.	from Collection
Collection	every(int $step, int $offset) Создать новую коллекцию, содержащую каждый n-й элемент.	from Collection
Collection	except(mixed $keys) Возвращает все модели в коллекции, кроме моделей со значениями указанных ключей.
Collection	filter(callable $callback = null) Применить фильтр к каждому элементу.	from Collection
Collection	where(string $key, mixed $value, bool $strict = true) Фильтровать элементы по заданной паре ключ-значение.	from Collection
Collection	whereLoose(string $key, mixed $value) Фильтровать элементы по заданной паре ключ-значение с использованием нестрогого сравнения.	from Collection
Collection	whereIn(string $key, array $values, bool $strict = true) Фильтровать элементы по заданной паре ключ-значение.	from Collection
Collection	whereInLoose(string $key, array $values) Фильтровать элементы по заданной паре ключ-значение с использованием нестрогого сравнения.	from Collection
mixed	first(callable $callback = null, mixed $default = null) Получить первый элемент из коллекции.	from Collection
Collection	flatten(int $depth = INF) Получить сплющенный массив элементов в коллекции.
Collection	flip() Перевернуть элементы в коллекции.
$this	forget(string\|array $keys) Удалить элемент из коллекции по ключу.	from Collection
mixed	get(mixed $key, mixed $default = null) Получить элемент из коллекции по ключу.	from Collection
Collection	groupBy(callable\|string $groupBy, bool $preserveKeys = false) Сгруппировать ассоциативный массив по полю или с помощью обратного вызова.	from Collection
Collection	keyBy(callable\|string $keyBy) Выполнить ключирование ассоциативного массива по полю или с помощью обратного вызова.	from Collection
bool	has(mixed $key) Определить, существует ли элемент в коллекции по ключу.	from Collection

string	implode(string $value, string $glue = null) Объединить значения заданного ключа в строку.	from Collection
Collection	intersect(mixed $items) Пересечь коллекцию с заданными элементами.
bool	isEmpty() Определить, пуста ли коллекция.	from Collection
bool	useAsCallable(mixed $value) Определить, является ли заданное значение вызываемым, но не строкой.	from Collection
Collection	keys() Получить ключи элементов коллекции.
mixed	last(callable $callback = null, mixed $default = null) Получить последний элемент из коллекции.	from Collection
Collection	pluck(string $value, string\|null $key = null) Получить массив со значениями заданного ключа.
Collection	lists(string $value, string\|null $key = null) ^deprecated Псевдоним для метода "pluck".	from Collection
Collection	map(callable $callback) Применить отображение к каждому элементу.	from Collection
Collection	flatMap(callable $callback) Применить отображение к коллекции и уплощить результат на один уровень.	from Collection
mixed	max(string\|null $key = null) Получить максимальное значение по заданному ключу.	from Collection
Collection	merge(mixed $items) Объединить коллекцию с заданными элементами.
Collection	combine(mixed $values) Создать коллекцию, используя эту коллекцию для ключей и другую для значений.	from Collection
Collection	union(mixed $items) Объединить коллекцию с заданными элементами.	from Collection
mixed	min(string\|null $key = null) Получить минимальное значение по заданному ключу.	from Collection
Collection	only(mixed $keys) Возвращает только модели из коллекции с указанными ключами.
Collection	forPage(int $page, int $perPage) «Разбить» коллекцию на меньшие подколлекции по страницам.	from Collection
mixed	pipe(callable $callback) Передать коллекцию в заданный обратный вызов и вернуть результат.	from Collection
mixed	pop() Получить и удалить последний элемент из коллекции.	from Collection
$this	prepend(mixed $value, mixed $key = null) Добавить элемент в начало коллекции.	from Collection
$this	push(mixed $value) Добавить элемент в конец коллекции.	from Collection
mixed	pull(mixed $key, mixed $default = null) Получить и удалить элемент из коллекции.	from Collection
$this	put(mixed $key, mixed $value) Добавить элемент в коллекцию по ключу.	from Collection
mixed	random(int $amount = 1) Получить один или несколько случайных элементов из коллекции.	from Collection
mixed	reduce(callable $callback, mixed $initial = null) Свести коллекцию к одному значению.	from Collection
Collection	reject(callable\|mixed $callback) Создать коллекцию из всех элементов, которые не проходят заданный тест истинности.	from Collection
Collection	reverse() Инвертировать порядок элементов.	from Collection
mixed	search(mixed $value, bool $strict = false) Искать значение в коллекции и возвращать соответствующий ключ, если поиск успешен.	from Collection
mixed	shift() Получить и удалить первый элемент из коллекции.	from Collection
Collection	shuffle(int $seed = null) Перемешать элементы в коллекции.	from Collection
Collection	slice(int $offset, int $length = null) Выделить часть массива коллекции.	from Collection

Коллекция	chunk(int $size) Разбить массив коллекции на части.	из Коллекции
Коллекция	sort(callable $callback = null) Отсортировать элементы с помощью обратного вызова.	из Коллекции
Коллекция	sortBy(callable\|string $callback, int $options = SORT_REGULAR, bool $descending = false) Отсортировать коллекцию с помощью заданного обратного вызова.	из Коллекции
Коллекция	sortByDesc(callable\|string $callback, int $options = SORT_REGULAR) Отсортировать коллекцию в обратном порядке с помощью заданного обратного вызова.	из Коллекции
Коллекция	splice(int $offset, int\|null $length = null, mixed $replacement = []) Вставить часть массива коллекции.	из Коллекции
mixed	sum(callable\|string\|null $callback = null) Получить сумму заданных значений.	из Коллекции
Коллекция	take(int $limit) Взять первые или последние {$limit} элементов.	из Коллекции
$this	transform(callable $callback) Преобразовать каждый элемент в коллекции с помощью обратного вызова.	из Коллекции
Коллекция	unique(string\|callable\|null $key = null) Возвратить только уникальные элементы из коллекции.
Коллекция	values() Сбросить ключи в базовом массиве.	из Коллекции
callable	valueRetriever(string $value) Получить обратный вызов для извлечения значения.	из Коллекции
Коллекция	zip(mixed $items) Объединить коллекцию с одним или несколькими массивами.
array	toArray() Получить коллекцию элементов как обычный массив.	из Коллекции
array	jsonSerialize() Преобразовать объект в что-то сериализуемое в JSON.	из Коллекции
string	toJson(int $options) Получить коллекцию элементов в формате JSON.	из Коллекции
ArrayIterator	getIterator() Получить итератор для элементов.	из Коллекции
CachingIterator	getCachingIterator(int $flags = CachingIterator::CALL_TOSTRING) Получить экземпляр CachingIterator.	из Коллекции
int	count() Подсчитать количество элементов в коллекции.	из Коллекции
bool	offsetExists(mixed $key) Определить, существует ли элемент по заданному смещению.	из Коллекции
mixed	offsetGet(mixed $key) Получить элемент по заданному смещению.	из Коллекции
void	offsetSet(mixed $key, mixed $value) Установить элемент по заданному смещению.	из Коллекции
void	offsetUnset(string $key) Удалить элемент по заданному смещению.	из Коллекции
string	__toString() Преобразовать коллекцию в строковое представление.	из Коллекции
array	getArrayableItems(mixed $items) Результирующий массив элементов из Коллекции или Arrayable.	из Коллекции
Модель	find(mixed $key, mixed $default = null) Найти модель в коллекции по ключу.
$this	load(mixed $relations) Загрузить набор отношений в коллекцию.
$this	add(mixed $item) Добавить элемент в коллекцию.
array	modelKeys() Получить массив первичных ключей.
$this	makeHidden(array\|string $attributes) Скрыть указанные, обычно видимые, атрибуты для всей коллекции.
$this	makeVisible(array\|string $attributes) Сделать указанные, обычно скрытые, атрибуты видимыми для всей коллекции.
$this	withHidden(array\|string $attributes) ^deprecated Сделать указанные, обычно скрытые, атрибуты видимыми для всей коллекции.
array	getDictionary(ArrayAccess\|array\|null $items = null) Получить словарь, индексированный первичными ключами.
string\|null	getQueueableClass() Получить тип сущностей, которые будут помещаться в очередь.
array	getQueueableIds() Получить идентификаторы всех сущностей.

Коллекция

toBase()

Получить базовый экземпляр коллекции Support из этой коллекции.

Подробности

static void macro(string $name, callable $macro)

Зарегистрировать пользовательское макро.

Параметры

string	$name
callable	$macro

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

void

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 Коллекция make(mixed $items = [])

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

Параметры

mixed

$items

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

Коллекция

array all()

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

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

array

mixed avg(string|null $key = null)

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

Параметры

string|null

$key

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

mixed

mixed average(string|null $key = null)

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

Параметры

string|null

$key

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

mixed

mixed|null median(null $key = null)

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

Параметры

null

$key

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

mixed|null

array mode(null $key = null)

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

Параметры

null

$key

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

array

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

Сжать коллекцию элементов в один массив.

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

Коллекция

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

Определить, существует ли ключ в коллекции.

Параметры

mixed	$key
mixed	$value

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

bool

Коллекция diff(mixed $items)

Разница между коллекцией и заданными элементами.

Параметры

mixed

$items

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

Коллекция

Коллекция diffKeys(mixed $items)

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

Параметры

mixed

$items

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

Коллекция

$this each(callable $callback)

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

Параметры

callable

$callback

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

$this

Коллекция every(int $step, int $offset)

Создать новую коллекцию, состоящую из каждого n-го элемента.

Параметры

int	$step
int	$offset

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

Коллекция

Коллекция except(mixed $keys)

Возвращает все модели в коллекции, кроме моделей с указанными ключами.

Параметры

mixed

$keys

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

Коллекция

Коллекция filter(callable $callback = null)

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

Параметры

callable

$callback

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

Коллекция

END_OF_DOCUMENT_MARKER

Коллекция where(string $key, mixed $value, bool $strict = true)

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

Параметры

string	$key
mixed	$value
bool	$strict

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

Коллекция

Коллекция whereLoose(string $key, mixed $value)

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

Параметры

string	$key
mixed	$value

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

Коллекция

Коллекция whereIn(string $key, array $values, bool $strict = true)

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

Параметры

string	$key
array	$values
bool	$strict

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

Коллекция

Коллекция whereInLoose(string $key, array $values)

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

Параметры

string	$key
array	$values

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

Коллекция

mixed first(callable $callback = null, mixed $default = null)

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

Параметры

callable	$callback
mixed	$default

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

mixed

Коллекция flatten(int $depth = INF)

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

Параметры

int

$depth

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

Коллекция

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

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

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

Коллекция

$this forget(string|array $keys)

Удалить элемент из коллекции по ключу.

Параметры

string|array

$keys

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

$this

mixed get(mixed $key, mixed $default = null)

Получить элемент из коллекции по ключу.

Параметры

mixed	$key
mixed	$default

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

mixed

Коллекция groupBy(callable|string $groupBy, bool $preserveKeys = false)

Сгруппировать ассоциативный массив по полю или с помощью обратного вызова.

Параметры

callable\|string	$groupBy
bool	$preserveKeys

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

Коллекция

Коллекция keyBy(callable|string $keyBy)

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

Параметры

callable|string

$keyBy

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

Коллекция

bool has(mixed $key)

Определить, существует ли элемент в коллекции по ключу.

Параметры

mixed

$key

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

bool

string implode(string $value, string $glue = null)

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

Параметры

string	$value
string	$glue

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

string

Коллекция intersect(mixed $items)

Пересечь коллекцию с заданными элементами.

Параметры

mixed

$items

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

Коллекция

bool isEmpty()

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

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

bool

protected bool useAsCallable(mixed $value)

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

Параметры

mixed

$value

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

bool

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

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

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

Коллекция

mixed last(callable $callback = null, mixed $default = null)

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

Параметры

callable	$callback
mixed	$default

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

mixed

Коллекция pluck(string $value, string|null $key = null)

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

Параметры

string	$value
string\|null	$key

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

Коллекция

Collection lists(string $value, string|null $key = null) ^deprecated

^deprecated

since version 5.2. Use the "pluck" method directly.

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

Parameters

string	$value
string\|null	$key

Return Value

Collection

Collection map(callable $callback)

Применить функцию к каждому элементу.

Parameters

callable

$callback

Return Value

Collection

Collection flatMap(callable $callback)

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

Parameters

callable

$callback

Return Value

Collection

mixed max(string|null $key = null)

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

Parameters

string|null

$key

Return Value

mixed

Collection merge(mixed $items)

Объединить коллекцию с заданными элементами.

Parameters

mixed

$items

Return Value

Collection

Collection combine(mixed $values)

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

Parameters

mixed

$values

Return Value

Collection

Collection union(mixed $items)

Объединить коллекцию с заданными элементами.

Parameters

mixed

$items

Return Value

Collection

mixed min(string|null $key = null)

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

Parameters

string|null

$key

Return Value

mixed

Collection only(mixed $keys)

Возвращает только модели из коллекции с указанными ключами.

Parameters

mixed

$keys

Return Value

Collection

Collection forPage(int $page, int $perPage)

Разделить коллекцию на страницы.

Parameters

int	$page
int	$perPage

Return Value

Collection

mixed pipe(callable $callback)

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

Parameters

callable

$callback

Return Value

mixed

mixed pop()

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

Return Value

mixed

$this prepend(mixed $value, mixed $key = null)

Добавить элемент в начало коллекции.

Parameters

mixed	$value
mixed	$key

Return Value

$this

$this push(mixed $value)

Добавить элемент в конец коллекции.

Parameters

mixed

$value

Return Value

$this

mixed pull(mixed $key, mixed $default = null)

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

Parameters

mixed	$key
mixed	$default

Return Value

mixed

$this put(mixed $key, mixed $value)

Добавить элемент в коллекцию по ключу.

Parameters

mixed	$key
mixed	$value

Return Value

$this

mixed random(int $amount = 1)

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

Parameters

int

$amount

Return Value

mixed

Exceptions

InvalidArgumentException

mixed reduce(callable $callback, mixed $initial = null)

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

Parameters

callable	$callback
mixed	$initial

Return Value

mixed

Collection reject(callable|mixed $callback)

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

Parameters

callable|mixed

$callback

Return Value

Collection

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

Изменить порядок элементов.

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

Коллекция

смешанный тип search(смешанный тип $value, bool $strict = false)

Поиск значения в коллекции и возврат соответствующего ключа, если поиск успешен.

Параметры

смешанный тип	$value
bool	$strict

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

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

смешанный тип shift()

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

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

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

Коллекция shuffle(int $seed = null)

Перемешать элементы в коллекции.

Параметры

int

$seed

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

Коллекция

Коллекция slice(int $offset, int $length = null)

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

Параметры

int	$offset
int	$length

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

Коллекция

Коллекция chunk(int $size)

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

Параметры

int

$size

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

Коллекция

Коллекция sort(callable $callback = null)

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

Параметры

callable

$callback

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

Коллекция

Коллекция sortBy(callable|string $callback, int $options = SORT_REGULAR, bool $descending = false)

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

Параметры

callable\|string	$callback
int	$options
bool	$descending

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

Коллекция

Коллекция sortByDesc(callable|string $callback, int $options = SORT_REGULAR)

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

Параметры

callable\|string	$callback
int	$options

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

Коллекция

Коллекция splice(int $offset, int|null $length = null, mixed $replacement = [])

Заменить часть массива коллекции.

Параметры

int	$offset
int\|null	$length
смешанный тип	$replacement

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

Коллекция

смешанный тип sum(callable|string|null $callback = null)

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

Параметры

callable|string|null

$callback

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

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

Коллекция take(int $limit)

Взять первые или последние {$limit} элементов.

Параметры

int

$limit

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

Коллекция

$this transform(callable $callback)

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

Параметры

callable

$callback

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

$this

Коллекция unique(string|callable|null $key = null)

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

Параметры

string|callable|null

$key

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

Коллекция

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

Сбросить ключи в массиве.

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

Коллекция

protected callable valueRetriever(string $value)

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

Параметры

string

$value

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

callable

Коллекция zip(смешанный тип $items)

Объединить коллекцию с одним или несколькими массивами.

Параметры

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

$items

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

Коллекция

массив toArray()

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

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

массив

массив jsonSerialize()

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

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

массив

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

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

Параметры

int

$options

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

строка

ArrayIterator getIterator()

Получить итератор для элементов.

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

ArrayIterator

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

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

Параметры

int

$flags

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

CachingIterator

int count()

Подсчитать количество элементов в коллекции.

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

int

bool offsetExists(mixed $key)

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

Параметры

mixed

$key

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

bool

mixed offsetGet(mixed $key)

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

Параметры

mixed

$key

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

mixed

void offsetSet(mixed $key, mixed $value)

Установить элемент по заданному смещению.

Параметры

mixed	$key
mixed	$value

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

void

void offsetUnset(string $key)

Удалить элемент по заданному смещению.

Параметры

string

$key

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

void

string __toString()

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

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

string

protected array getArrayableItems(mixed $items)

Массив результатов элементов из Collection или Arrayable.

Параметры

mixed

$items

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

array

Model find(mixed $key, mixed $default = null)

Найти модель в коллекции по ключу.

Параметры

mixed	$key
mixed	$default

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

Model

$this load(mixed $relations)

Загрузить набор отношений в коллекцию.

Параметры

mixed

$relations

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

$this

$this add(mixed $item)

Добавить элемент в коллекцию.

Параметры

mixed

$item

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

$this

array modelKeys()

Получить массив первичных ключей.

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

array

$this makeHidden(array|string $attributes)

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

Параметры

array|string

$attributes

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

$this

$this makeVisible(array|string $attributes)

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

Параметры

array|string

$attributes

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

$this

$this withHidden(array|string $attributes) ^deprecated

^deprecated

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

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

Параметры

array|string

$attributes

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

$this

array getDictionary(ArrayAccess|array|null $items = null)

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

Параметры

ArrayAccess|array|null

$items

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

array

string|null getQueueableClass()

Получить тип сущностей, которые планируются в очереди.

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

string|null

array getQueueableIds()

Получить идентификаторы всех сущностей.

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

array

Collection toBase()

Получить базовый экземпляр коллекции Support из этой коллекции.

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

Collection

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.2/Illuminate/Database/Eloquent/Collection.html