Коллекция
класс Collection реализует ArrayAccess, ArrayableInterface, Countable, IteratorAggregate, JsonableInterface, JsonSerializable (Просмотреть исходный код)
Свойства
| защищенное массив | $items | Элементы, содержащиеся в коллекции. |
Методы
| void | __construct(array $items = array()) Создать новую коллекцию. | |
| static Collection | make(mixed $items) Создать новый экземпляр коллекции, если значение не является коллекцией. | |
| array | all() Получить все элементы из коллекции. | |
| Collection | collapse() Сгруппировать элементы коллекции в один массив. | |
| bool | contains(mixed $value) Определить, существует ли элемент в коллекции. | |
| 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) Получить элемент из коллекции по ключу. | |
| Collection | groupBy(callable|string $groupBy) Сгруппировать ассоциативный массив по полю или значению Closure. | |
| string | getGroupByKey(callable|string $groupBy, string $key, mixed $value) Получить значение ключа "группировки". | |
| Collection | keyBy(string $keyBy) Установить ключи ассоциативного массива по полю. | |
| bool | has(mixed $key) Определить, существует ли элемент в коллекции по ключу. | |
| string | implode(string $value, string $glue = null) Сконкатенировать значения заданного ключа в строку. | |
| Collection | intersect(Collection|ArrayableInterface|array $items) Пересечь коллекцию с заданными элементами. | |
| bool | isEmpty() Определить, пустая ли коллекция. | |
| array | keys() Получить ключи элементов коллекции. | |
| mixed|null | last() Получить последний элемент из коллекции. | |
| array | lists(string $value, string $key = null) Получить массив со значениями заданного ключа. | |
| Collection | map(Closure $callback) Применить функцию ко всем элементам. | |
| Collection | merge(Collection|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) Свести коллекцию к одному значению. | |
| Collection | reject(Closure|mixed $callback) Создать коллекцию из элементов, которые не удовлетворяют заданному условию. | |
| Collection | reverse() Перевернуть порядок элементов. | |
| mixed | search(mixed $value, bool $strict = false) Найти значение в коллекции и вернуть соответствующий ключ, если найдено. | |
| mixed|null | shift() Получить и удалить первый элемент из коллекции. | |
| $this | shuffle() Перемешать элементы в коллекции. | |
| Collection | slice(int $offset, int $length = null, bool $preserveKeys = false) Выделить часть массива коллекции. | |
| Collection | 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) Отсортировать коллекцию по убыванию с использованием заданного замыкания. | |
| Collection | splice(int $offset, int $length, mixed $replacement = array()) Вставить часть в массив основной коллекции. | |
| mixed | sum(Closure $callback = null) Получить сумму заданных значений. | |
| Collection | take(int $limit = null) Взять первые или последние {$limit} элементов. | |
| $this | transform(Closure $callback) Преобразовать каждый элемент в коллекции с помощью обратного вызова. | |
| Collection | unique() Возвратить только уникальные элементы из массива коллекции. | |
| Collection | values() Сбросить ключи в базовом массиве. | |
| Closure | valueRetriever(string $value) Получить обратный вызов для извлечения значения. | |
| 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(Collection|ArrayableInterface|array $items) Результативный массив элементов из Collection или ArrayableInterface. |
Подробности
void __construct(array $items = array())
Создать новую коллекцию.
static Collection make(mixed $items)
Создать новый экземпляр коллекции, если значение не является коллекцией.
array all()
Получить все элементы в коллекции.
Collection collapse()
Сжать элементы коллекции в один массив.
bool contains(mixed $value)
Определить, существует ли элемент в коллекции.
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)
Получить первый элемент из коллекции.
Коллекция flatten()
Получить плоский массив элементов коллекции.
Коллекция 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(Коллекция|ИнтерфейсArrayable|array $items)
Пересечение коллекции с заданными элементами.
bool isEmpty()
Определить, пустая ли коллекция.
array keys()
Получить ключи элементов коллекции.
mixed|null last()
Получить последний элемент из коллекции.
array lists(string $value, string $key = null)
Получить массив со значениями заданного ключа.
Коллекция merge(Коллекция|ИнтерфейсArrayable|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()
Перевернуть порядок элементов.
mixed search(mixed $value, bool $strict = false)
Найти в коллекции заданное значение и вернуть соответствующий ключ, если поиск успешен.
mixed|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())
Вставить часть базового массива коллекции.
mixed sum(Closure $callback = null)
Получить сумму заданных значений.
Коллекция take(int $limit = null)
Взять первые или последние {$limit} элементов.
$this transform(Closure $callback)
Преобразовать каждый элемент в коллекции с помощью обратного вызова.
Коллекция unique()
Возвратить только уникальные элементы из массива коллекции.
Коллекция values()
Сбросить ключи в базовом массиве.
protected Closure valueRetriever(string $value)
Получить обратный вызов для извлечения значения.
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()
Преобразовать коллекцию в строковое представление.
protected array getArrayableItems(Collection|ArrayableInterface|array $items)
Получить массив элементов из Collection или ArrayableInterface.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/4.2/Illuminate/Support/Collection.html
