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