Коллекция
класс Collection расширяет Collection (View source)
Свойства
| protected массив | $items | Элементы, содержащиеся в коллекции. | из Collection |
Методы
| void | __construct(array $items = array()) Создать новую коллекцию. | из Collection |
| static Collection | make(mixed $items) Создать новый экземпляр коллекции, если значение не является коллекцией. | из Collection |
| array | all() Получить все элементы коллекции. | из Collection |
| Collection | collapse() Сжать элементы коллекции в один массив. | из Collection |
| bool | contains(mixed $key) Определить, существует ли ключ в коллекции. | |
| Collection | diff(Collection|ArrayableInterface|array $items) Сравнить коллекцию с заданными элементами. | |
| $this | each(Closure $callback) Выполнить обратный вызов для каждого элемента. | из Collection |
| Collection | fetch(string $key) Получить вложенный элемент коллекции. | |
| Collection | filter(Closure $callback) Применить фильтр к каждому элементу. | из Collection |
| mixed|null | first(Closure $callback = null, mixed $default = null) Получить первый элемент коллекции. | из Collection |
| Collection | flatten() Получить сплющенную коллекцию элементов. | из Collection |
| Collection | flip() Перевернуть элементы коллекции. | из Collection |
| void | forget(mixed $key) Удалить элемент из коллекции по ключу. | из Collection |
| mixed | get(mixed $key, mixed $default = null) Получить элемент из коллекции по ключу. | из Collection |
| Collection | groupBy(callable|string $groupBy) Сгруппировать ассоциативный массив по полю или значению Closure. | из Collection |
| string | getGroupByKey(callable|string $groupBy, string $key, mixed $value) Получить значение ключа "группировки". | из Collection |
| Collection | keyBy(string $keyBy) Ключировать ассоциативный массив по полю. | из Collection |
| bool | has(mixed $key) Определить, существует ли элемент в коллекции по ключу. | из Collection |
| string | implode(string $value, string $glue = null) Объединить значения заданного ключа в строку. | из Collection |
| Collection | intersect(Collection|ArrayableInterface|array $items) Пересечь коллекцию с заданными элементами. | |
| bool | isEmpty() Определить, пуста ли коллекция. | из Collection |
| array | keys() Получить ключи элементов коллекции. | из Collection |
| mixed|null | last() Получить последний элемент коллекции. | из Collection |
| array | lists(string $value, string $key = null) Получить массив со значениями заданного ключа. | из Collection |
| Collection | map(Closure $callback) Применить отображение к каждому элементу. | из Collection |
| Collection | merge(Collection|ArrayableInterface|array $items) Объединить коллекцию с заданными элементами. | |
| mixed|null | pop() Получить и удалить последний элемент коллекции. | из Collection |
| void | prepend(mixed $value) Добавить элемент в начало коллекции. | из Collection |
| void | push(mixed $value) Добавить элемент в конец коллекции. | из Collection |
| mixed | pull(mixed $key, mixed $default = null) Извлечь элемент из коллекции. | из Collection |
| void | put(mixed $key, mixed $value) Поместить элемент в коллекцию по ключу. | из Collection |
| mixed | random(int $amount = 1) Получить один или несколько элементов случайным образом из коллекции. | из Collection |
| mixed | reduce(callable $callback, mixed $initial = null) Свести коллекцию к одному значению. | из Collection |
| Collection | reject(Closure|mixed $callback) Создать коллекцию всех элементов, которые не проходят заданный тест истинности. | из Collection |
| Collection | reverse() Инвертировать порядок элементов. | из Collection |
| mixed | search(mixed $value, bool $strict = false) Найти в коллекции заданное значение и вернуть соответствующий ключ, если поиск успешен. | из Collection |
| mixed|null | shift() Получить и удалить первый элемент из коллекции. | из Collection |
| $this | shuffle() Перемешать элементы в коллекции. | из Collection |
| Collection | slice(int $offset, int $length = null, bool $preserveKeys = false) Выделить подмассив из лежащего в основе массива коллекции. | из Collection |
| Collection | chunk(int $size, bool $preserveKeys = false) Разбить лежащий в основе массив коллекции на куски. | из Collection |
| $this | sort(Closure $callback) Отсортировать каждый элемент с помощью обратного вызова. | из Collection |
| $this | sortBy(Closure|string $callback, int $options = SORT_REGULAR, bool $descending = false) Отсортировать коллекцию с использованием указанного обратного вызова. | из Collection |
| $this | sortByDesc(Closure|string $callback, int $options = SORT_REGULAR) Отсортировать коллекцию в обратном порядке с использованием указанного обратного вызова. | из Collection |
| Collection | splice(int $offset, int $length, mixed $replacement = array()) Вырезать часть лежащего в основе массива коллекции. | из Collection |
| mixed | sum(Closure $callback = null) Получить сумму заданных значений. | из Collection |
| Collection | take(int $limit = null) Взять первые или последние {$limit} элементов. | из Collection |
| $this | transform(Closure $callback) Преобразовать каждый элемент в коллекции с помощью обратного вызова. | из Collection |
| Collection | unique() Вернуть только уникальные элементы из коллекции. | |
| Collection | values() Сбросить ключи в лежащем в основе массиве. | из Collection |
| Closure | valueRetriever(string $value) Получить обратный вызов для извлечения значения. | из Collection |
| array | toArray() Получить коллекцию элементов в виде простого массива. | из Collection |
| array | jsonSerialize() Преобразовать объект в формат, сериализуемый в JSON. | из Collection |
| string | toJson(int $options) Получить коллекцию элементов в формате JSON. | из Collection |
| ArrayIterator | getIterator() Получить итератор для элементов. | из Collection |
| CachingIterator | getCachingIterator(int $flags = CachingIterator::CALL_TOSTRING) Получить экземпляр CachingIterator. | из Collection |
| int | count() Подсчитать количество элементов в коллекции. | из Collection |
| bool | offsetExists(mixed $key) Определить, существует ли элемент по заданному смещению. | из Collection |
| mixed | offsetGet(mixed $key) Получить элемент по заданному смещению. | из Collection |
| void | offsetSet(mixed $key, mixed $value) Установить элемент по заданному смещению. | из Collection |
| void | offsetUnset(string $key) Удалить элемент по заданному смещению. | из Collection |
| string | __toString() Преобразовать коллекцию в её строковое представление. | из Collection |
| array | getArrayableItems(Collection|ArrayableInterface|array $items) Массив результатов элементов из Collection или ArrayableInterface. | из Collection |
| Model | find(mixed $key, mixed $default = null) Найти модель в коллекции по ключу. | |
| $this | load(mixed $relations) Загрузить набор отношений в коллекцию. | |
| $this | add(mixed $item) Добавить элемент в коллекцию. | |
| mixed | max(string $key) Получить максимальное значение заданного ключа. | |
| mixed | min(string $key) Получить минимальное значение заданного ключа. | |
| array | modelKeys() Получить массив первичных ключей | |
| Collection | only(mixed $keys) Возвращает только модели из коллекции с указанными ключами. | |
| Collection | except(mixed $keys) Возвращает все модели в коллекции, кроме моделей с указанными ключами. | |
| array | getDictionary(ArrayAccess|array $items = null) Получить словарь с ключами по первичным ключам. | |
| Collection | toBase() Получить базовый экземпляр коллекции Support из этой коллекции. |
Подробности
void __construct(array $items = array())
Создать новую коллекцию.
static Collection make(mixed $items)
Создать новый экземпляр коллекции, если значение не является коллекцией.
array all()
Получить все элементы в коллекции.
Collection collapse()
Сжать элементы коллекции в один массив.
bool contains(mixed $key)
Определить, существует ли ключ в коллекции.
Collection diff(Collection|ArrayableInterface|array $items)
Разность коллекций.
$this each(Closure $callback)
Выполнить обратный вызов для каждого элемента.
Collection fetch(string $key)
Получить вложенный элемент коллекции.
Collection filter(Closure $callback)
Применить фильтр к каждому элементу.
mixed|null first(Closure $callback = null, mixed $default = null)
Получить первый элемент из коллекции.
Collection flatten()
Получить сплюснутый массив элементов коллекции.
Collection flip()
Перевернуть элементы в коллекции.
void forget(mixed $key)
Удалить элемент из коллекции по ключу.
mixed get(mixed $key, mixed $default = null)
Получить элемент из коллекции по ключу.
Коллекция groupBy(callable|string $groupBy)
Группировать ассоциативный массив по полю или значению Closure.
protected string getGroupByKey(callable|string $groupBy, string $key, mixed $value)
Получить значение ключа "группировки".
Коллекция keyBy(string $keyBy)
Установить ключи ассоциативного массива по полю.
bool has(mixed $key)
Определить, существует ли элемент в коллекции по ключу.
string implode(string $value, string $glue = null)
Конкатенировать значения заданного ключа в строку.
Коллекция intersect(Коллекция|ArrayableInterface|array $items)
Пересечь коллекцию с заданными элементами.
bool isEmpty()
Определить, пуста ли коллекция.
array keys()
Получить ключи элементов коллекции.
mixed|null last()
Получить последний элемент из коллекции.
array lists(string $value, string $key = null)
Получить массив со значениями заданного ключа.
Коллекция merge(Коллекция|ArrayableInterface|array $items)
Объединить коллекцию с заданными элементами.
mixed|null pop()
Получить и удалить последний элемент из коллекции.
void prepend(mixed $value)
Добавить элемент в начало коллекции.
void push(mixed $value)
Добавить элемент в конец коллекции.
mixed pull(mixed $key, mixed $default = null)
Извлекает элемент из коллекции.
void put(mixed $key, mixed $value)
Поместить элемент в коллекцию по ключу.
mixed random(int $amount = 1)
Случайный выбор одного или нескольких элементов из коллекции.
mixed reduce(callable $callback, mixed $initial = null)
Свести коллекцию к одному значению.
Коллекция reject(Closure|mixed $callback)
Создать коллекцию, содержащую элементы, не удовлетворяющие заданному условию.
Коллекция reverse()
Изменить порядок элементов.
смешанный search(смешанный $value, bool $strict = false)
Поиск значения в коллекции и возврат соответствующего ключа при успехе.
смешанный|null shift()
Получение и удаление первого элемента из коллекции.
$this shuffle()
Перемешать элементы в коллекции.
Коллекция slice(int $offset, int $length = null, bool $preserveKeys = false)
Выделить часть массива коллекции.
Коллекция chunk(int $size, bool $preserveKeys = false)
Разбить массив коллекции на куски.
$this sort(Closure $callback)
Сортировать каждый элемент с помощью обратного вызова.
$this sortBy(Closure|string $callback, int $options = SORT_REGULAR, bool $descending = false)
Сортировать коллекцию с помощью заданного обратного вызова.
$this sortByDesc(Closure|string $callback, int $options = SORT_REGULAR)
Сортировать коллекцию в обратном порядке с помощью заданного обратного вызова.
Коллекция splice(int $offset, int $length, mixed $replacement = array())
Вставить фрагмент в массив коллекции.
смешанный sum(Closure $callback = null)
Вычислить сумму заданных значений.
Коллекция take(int $limit = null)
Получить первые или последние {$limit} элементы.
$this transform(Closure $callback)
Преобразовать каждый элемент в коллекции с помощью обратного вызова.
Коллекция unique()
Возвратить только уникальные элементы из коллекции.
Коллекция values()
Сбросить ключи в базовом массиве.
protected Closure valueRetriever(string $value)
Получить обратный вызов для извлечения значения.
массив toArray()
Получить коллекцию элементов в виде простого массива.
массив jsonSerialize()
Преобразовать объект в сериализуемый в JSON.
строка 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()
Преобразовать коллекцию в строковое представление.
protected array getArrayableItems(Collection|ArrayableInterface|array $items)
Возвращает массив элементов из Collection или ArrayableInterface.
Model find(mixed $key, mixed $default = null)
Найти модель в коллекции по ключу.
$this load(mixed $relations)
Загрузить набор отношений в коллекцию.
$this add(mixed $item)
Добавить элемент в коллекцию.
mixed max(string $key)
Получить максимальное значение заданного ключа.
mixed min(string $key)
Получить минимальное значение заданного ключа.
array modelKeys()
Получить массив первичных ключей.
Collection only(mixed $keys)
Возвращает только модели из коллекции с указанными ключами.
Collection except(mixed $keys)
Возвращает все модели в коллекции, кроме моделей с указанными ключами.
array getDictionary(ArrayAccess|array $items = null)
Получить словарь с ключами, основанными на первичных ключах.
Collection toBase()
Получить базовый экземпляр коллекции Support из этой коллекции.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/4.2/Illuminate/Database/Eloquent/Collection.html
