Коллекция
класс Collection расширяет Collection и реализует QueueableCollection (Просмотреть исходный код)
Трейты
| Macroable |
Свойства
| статический защищенный массив | $macros | Зарегистрированные строковые макросы. | из Macroable |
| защищенный массив | $items | Элементы, содержащиеся в коллекции. | из Collection |
Методы
| static void | macro(string $name, callable $macro) Зарегистрировать пользовательскую макрокоманду. | из 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 Collection | make(mixed $items = []) Создать новый экземпляр коллекции, если значение не является коллекцией. | из Collection |
| array | all() Получить все элементы коллекции. | из Collection |
| mixed | avg(callable|string|null $callback = null) Получить среднее значение по заданному ключу. | из Collection |
| mixed | average(callable|string|null $callback = null) Псевдоним для метода "avg". | из Collection |
| mixed | median(null $key = null) Получить медиану по заданному ключу. | из Collection |
| array | mode(mixed $key = null) Получить моду по заданному ключу. | из Collection |
| Collection | collapse() Свести коллекцию элементов в один массив. | |
| bool | contains(mixed $key, mixed $value = null) Определить, существует ли ключ в коллекции. | |
| bool | containsStrict(mixed $key, mixed $value = null) Определить, существует ли элемент в коллекции с использованием строгого сравнения. | из Collection |
| Collection | diff(mixed $items) Выполнить разность коллекции с заданными элементами. | |
| Collection | diffKeys(mixed $items) Получить элементы из коллекции, ключи которых отсутствуют в заданных элементах. | из Collection |
| $this | each(callable $callback) Выполнить функцию обратного вызова для каждого элемента. | из Collection |
| Collection | every(int $step, int $offset) Создать новую коллекцию, содержащую каждый n-ый элемент. | из Collection |
| Collection | except(mixed $keys) Возвращает все модели в коллекции, кроме моделей с указанными ключами. | |
| Collection | filter(callable $callback = null) Применить фильтр к каждому элементу. | из Collection |
| Collection | where(string $key, mixed $operator, mixed $value = null) Фильтровать элементы по заданной паре ключ-значение. | из Collection |
| Closure | operatorForWhere(string $key, string $operator, mixed $value) Получить функцию проверки оператора. | из Collection |
| Collection | whereStrict(string $key, mixed $value) Фильтровать элементы по заданной паре ключ-значение с использованием строгого сравнения. | из Collection |
| Collection | whereIn(string $key, mixed $values, bool $strict = false) Фильтровать элементы по заданной паре ключ-значение. | из Collection |
| Collection | whereInStrict(string $key, mixed $values) Фильтровать элементы по заданной паре ключ-значение с использованием строгого сравнения. | из Collection |
| mixed | first(callable $callback = null, mixed $default = null) Получить первый элемент из коллекции. | из Collection |
| Collection | flatten(int $depth = INF) Получить сглаженный массив элементов из коллекции. | |
| Collection | flip() Перевернуть элементы в коллекции. | |
| $this | forget(string|array $keys) Удалить элемент из коллекции по ключу. | из Collection |
| mixed | get(mixed $key, mixed $default = null) Получить элемент из коллекции по ключу. | из Collection |
| Collection | groupBy(callable|string $groupBy, bool $preserveKeys = false) Сгруппировать ассоциативный массив по полю или с использованием обратного вызова. | из Collection |
| Коллекция | keyBy(callable|string $keyBy) Ключировать ассоциативный массив по полю или с помощью обратного вызова. | из Коллекции |
| bool | has(mixed $key) Определить, существует ли элемент в коллекции по ключу. | из Коллекции |
| string | implode(string $value, string $glue = null) Объединить значения заданного ключа в строку. | из Коллекции |
| Коллекция | intersect(mixed $items) Пересечь коллекцию с заданными элементами. | |
| bool | isEmpty() Определить, пуста ли коллекция. | из Коллекции |
| bool | isNotEmpty() Определить, не пуста ли коллекция. | из Коллекции |
| bool | useAsCallable(mixed $value) Определить, является ли данное значение вызываемым, но не строкой. | из Коллекции |
| Коллекция | keys() Получить ключи элементов коллекции. | |
| mixed | last(callable $callback = null, mixed $default = null) Получить последний элемент из коллекции. | из Коллекции |
| Коллекция | pluck(string $value, string|null $key = null) Получить массив со значениями заданного ключа. | |
| Коллекция | map(callable $callback) Применить отображение к каждому элементу. | |
| Коллекция | mapWithKeys(callable $callback) Применить ассоциативное отображение к каждому элементу. | из Коллекции |
| Коллекция | flatMap(callable $callback) Применить отображение к коллекции и сгладить результат на один уровень. | из Коллекции |
| mixed | max(callable|string|null $callback = null) Получить максимальное значение заданного ключа. | из Коллекции |
| Коллекция | merge(mixed $items) Объединить коллекцию с заданными элементами. | |
| Коллекция | combine(mixed $values) Создать коллекцию, используя эту коллекцию для ключей и другую для значений. | из Коллекции |
| Коллекция | union(mixed $items) Объединить коллекцию с заданными элементами. | из Коллекции |
| mixed | min(callable|string|null $callback = null) Получить минимальное значение заданного ключа. | из Коллекции |
| Коллекция | only(mixed $keys) Возвращает только модели из коллекции с указанными ключами. | |
| Коллекция | forPage(int $page, int $perPage) «Разбить» коллекцию на страницы, разбив ее на более мелкие коллекции. | из Коллекции |
| Коллекция | partition(callable|string $callback) Разделить коллекцию на два массива с помощью заданного обратного вызова или ключа. | из Коллекции |
| mixed | pipe(callable $callback) Передать коллекцию в заданный обратный вызов и вернуть результат. | из Коллекции |
| 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) Свести коллекцию к одному значению. | из Коллекции |
| Коллекция | reject(callable|mixed $callback) Создать коллекцию всех элементов, которые не проходят заданный тест истинности. | из Коллекции |
| Коллекция | reverse() Инвертировать порядок элементов. | из Коллекции |
| mixed | search(mixed $value, bool $strict = false) Поиск в коллекции заданного значения и возврат соответствующего ключа, если поиск успешен. | from Коллекция |
| mixed | shift() Получение и удаление первого элемента из коллекции. | from Коллекция |
| Коллекция | shuffle(int $seed = null) Перемешивание элементов в коллекции. | from Коллекция |
| Коллекция | slice(int $offset, int $length = null) Вырезка фрагмента массива коллекции. | from Коллекция |
| Коллекция | split(int $numberOfGroups) Разделение коллекции на определенное количество групп. | from Коллекция |
| Коллекция | chunk(int $size) Разбиение массива коллекции на части. | from Коллекция |
| Коллекция | sort(callable $callback = null) Сортировка каждого элемента с помощью обратного вызова. | from Коллекция |
| Коллекция | sortBy(callable|string $callback, int $options = SORT_REGULAR, bool $descending = false) Сортировка коллекции с использованием предоставленного обратного вызова. | from Коллекция |
| Коллекция | sortByDesc(callable|string $callback, int $options = SORT_REGULAR) Сортировка коллекции в обратном порядке с использованием данного обратного вызова. | from Коллекция |
| Коллекция | splice(int $offset, int|null $length = null, mixed $replacement = []) Вставка или замена части массива коллекции. | from Коллекция |
| mixed | sum(callable|string|null $callback = null) Получение суммы заданных значений. | from Коллекция |
| Коллекция | take(int $limit) Получение первых или последних {$limit} элементов. | from Коллекция |
| $this | transform(callable $callback) Преобразование каждого элемента в коллекции с помощью обратного вызова. | from Коллекция |
| Коллекция | unique(string|callable|null $key = null, bool $strict = false) Возвращение только уникальных элементов из коллекции. | |
| Коллекция | uniqueStrict(string|callable|null $key = null) Возвращение только уникальных элементов из массива коллекции, используя строгое сравнение. | from Коллекция |
| Коллекция | values() Сброс ключей в базовом массиве. | from Коллекция |
| callable | valueRetriever(string $value) Получение обратного вызова для извлечения значения. | from Коллекция |
| Коллекция | zip(mixed $items) Сжатие коллекции вместе с одним или несколькими массивами. | |
| array | toArray() Получение коллекции элементов в виде обычного массива. | from Коллекция |
| array | jsonSerialize() Преобразование объекта в сериализуемый в JSON формат. | from Коллекция |
| string | toJson(int $options) Получение коллекции элементов в формате JSON. | from Коллекция |
| ArrayIterator | getIterator() Получение итератора для элементов. | from Коллекция |
| CachingIterator | getCachingIterator(int $flags = CachingIterator::CALL_TOSTRING) Получение экземпляра CachingIterator. | from Коллекция |
| int | count() Подсчёт количества элементов в коллекции. | from Коллекция |
| Коллекция | toBase() Получение базового экземпляра коллекции Support из этой коллекции. | from Коллекция |
| bool | offsetExists(mixed $key) Определение наличия элемента по заданному смещению. | from Коллекция |
| mixed | offsetGet(mixed $key) Получение элемента по заданному смещению. | from Коллекция |
| void | offsetSet(mixed $key, mixed $value) Установка элемента по заданному смещению. | from Коллекция |
| void | offsetUnset(string $key) Удаление элемента по заданному смещению. | from Коллекция |
| string | __toString() Преобразование коллекции в строковое представление. | from Коллекция |
| массив | getArrayableItems(mixed $items) Массив элементов из коллекции или Arrayable. | из коллекции |
| Модель | find(mixed $key, mixed $default = null) Найти модель в коллекции по ключу. | |
| $this | load(mixed $relations) Загрузить набор отношений в коллекцию. | |
| $this | add(mixed $item) Добавить элемент в коллекцию. | |
| массив | modelKeys() Получить массив первичных ключей. | |
| $this | makeHidden(array|string $attributes) Скрыть заданные, обычно видимые, атрибуты во всей коллекции. | |
| $this | makeVisible(array|string $attributes) Сделать заданные, обычно скрытые, атрибуты видимыми во всей коллекции. | |
| массив | getDictionary(ArrayAccess|array|null $items = null) Получить словарь, индексированный первичными ключами. | |
| строка|null | getQueueableClass() Получить тип сущностей, которые находятся в очереди. | |
| массив | getQueueableIds() Получить идентификаторы всех сущностей. |
Подробности
static void macro(string $name, callable $macro)
Зарегистрировать пользовательское макро.
static bool hasMacro(string $name)
Проверяет, зарегистрировано ли макро.
static mixed __callStatic(string $method, array $parameters)
Динамически обрабатывает вызовы класса.
mixed __call(string $method, array $parameters)
Динамически обрабатывает вызовы класса.
void __construct(mixed $items = [])
Создать новую коллекцию.
static Коллекция make(mixed $items = [])
Создать новый экземпляр коллекции, если значение не является коллекцией.
массив all()
Получить все элементы в коллекции.
mixed avg(callable|string|null $callback = null)
Получить среднее значение по заданному ключу.
mixed average(callable|string|null $callback = null)
Псевдоним для метода "avg".
mixed median(null $key = null)
Получить медиану по заданному ключу.
массив mode(mixed $key = null)
Получить моду по заданному ключу.
Коллекция collapse()
Сжать коллекцию элементов в один массив.
bool contains(mixed $key, mixed $value = null)
Определить, существует ли ключ в коллекции.
bool containsStrict(mixed $key, mixed $value = null)
Определить, существует ли элемент в коллекции с использованием строгого сравнения.
Коллекция diff(mixed $items)
Выполнить разность коллекций с заданными элементами.
Коллекция diffKeys(mixed $items)
Получить элементы из коллекции, ключи которых отсутствуют в заданных элементах.
$this each(callable $callback)
Выполнить обратный вызов для каждого элемента.
Коллекция every(int $step, int $offset)
Создать новую коллекцию, состоящую из каждого n-ого элемента.
Коллекция except(mixed $keys)
Возвращает все модели в коллекции, за исключением моделей со специфицированными ключами.
Коллекция filter(callable $callback = null)
Применить фильтр к каждому элементу.
Коллекция where(string $key, mixed $operator, mixed $value = null)
Фильтр элементов по заданной паре ключ-значение.
protected Закрытие operatorForWhere(string $key, string $operator, mixed $value)
Получить обратный вызов проверки оператора.
Коллекция whereStrict(string $key, mixed $value)
Фильтр элементов по заданной паре ключ-значение с использованием строгого сравнения.
Коллекция whereIn(string $key, mixed $values, bool $strict = false)
Фильтр элементов по заданной паре ключ-значение.
Коллекция whereInStrict(string $key, mixed $values)
Фильтр элементов по заданной паре ключ-значение с использованием строгого сравнения.
mixed first(callable $callback = null, mixed $default = null)
Получить первый элемент из коллекции.
Коллекция flatten(int $depth = INF)
Получить сплющенную массив элементов из коллекции.
Коллекция flip()
Поменять местами элементы в коллекции.
$this forget(string|array $keys)
Удалить элемент из коллекции по ключу.
mixed get(mixed $key, mixed $default = null)
Получить элемент из коллекции по ключу.
Коллекция groupBy(callable|string $groupBy, bool $preserveKeys = false)
Сгруппировать ассоциативный массив по полю или с помощью обратного вызова.
Коллекция keyBy(callable|string $keyBy)
Установить ключ ассоциативного массива по полю или с помощью обратного вызова.
bool has(mixed $key)
Определить, существует ли элемент в коллекции по ключу.
string implode(string $value, string $glue = null)
Сконкатенировать значения заданного ключа в строку.
Коллекция intersect(mixed $items)
Пересечение коллекции с заданными элементами.
bool isEmpty()
Определяет, пуста ли коллекция.
bool isNotEmpty()
Определяет, не пуста ли коллекция.
protected bool useAsCallable(mixed $value)
Определяет, является ли заданное значение вызываемым, но не строкой.
Коллекция keys()
Получить ключи элементов коллекции.
mixed last(callable $callback = null, mixed $default = null)
Получить последний элемент из коллекции.
Коллекция pluck(string $value, string|null $key = null)
Получить массив со значениями заданного ключа.
Коллекция map(callable $callback)
Применить преобразование к каждому элементу коллекции.
Коллекция mapWithKeys(callable $callback)
Применить ассоциативное преобразование к каждому элементу коллекции.
Вызываемая функция должна возвращать ассоциативный массив с одной парой ключ/значение.
Коллекция flatMap(callable $callback)
Преобразовать коллекцию и сгладить результат на один уровень.
mixed max(callable|string|null $callback = null)
Получить максимальное значение заданного ключа.
Коллекция merge(mixed $items)
Объединить коллекцию с заданными элементами.
Коллекция combine(mixed $values)
Создать коллекцию, используя эту коллекцию для ключей и другую для значений.
Коллекция union(mixed $items)
Объединить коллекцию с заданными элементами.
mixed min(callable|string|null $callback = null)
Получить минимальное значение заданного ключа.
Коллекция only(mixed $keys)
Возвращает только модели из коллекции с указанными ключами.
Коллекция forPage(int $page, int $perPage)
Разбить коллекцию на страницы, вырезав куски.
Коллекция partition(callable|string $callback)
Разделить коллекцию на два массива с помощью заданной вызываемой функции или ключа.
mixed pipe(callable $callback)
Передать коллекцию в заданную вызываемую функцию и вернуть результат.
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(int $seed = null)
Перемешать элементы в коллекции.
Collection slice(int $offset, int $length = null)
Выделить фрагмент массива из лежащей в основе коллекции.
Collection split(int $numberOfGroups)
Разделить коллекцию на определенное количество групп.
Collection chunk(int $size)
Разбить массив из лежащей в основе коллекции на куски.
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)
Получить сумму заданных значений.
Коллекция take(int $limit)
Взять первые или последние {$limit} элементов.
$this transform(callable $callback)
Преобразовать каждый элемент в коллекции с помощью обратного вызова.
Коллекция unique(string|callable|null $key = null, bool $strict = false)
Возвратить только уникальные элементы из коллекции.
Коллекция uniqueStrict(string|callable|null $key = null)
Возвратить только уникальные элементы из массива коллекции, используя строгое сравнение.
Коллекция values()
Сбросить ключи в базовом массиве.
protected 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()
Подсчитать количество элементов в коллекции.
Коллекция toBase()
Получить базовый экземпляр коллекции Support из этой коллекции.
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 makeHidden(array|string $attributes)
Скрыть указанные, как правило, видимые атрибуты во всей коллекции.
$this makeVisible(array|string $attributes)
Сделать указанные, обычно скрытые, атрибуты видимыми во всей коллекции.
array getDictionary(ArrayAccess|array|null $items = null)
Получить словарь, индексированный первичными ключами.
string|null getQueueableClass()
Получить тип сущностей, которые будут помещены в очередь.
array getQueueableIds()
Получить идентификаторы всех сущностей.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.3/Illuminate/Database/Eloquent/Collection.html
