Коллекция
класс Collection реализует ArrayAccess, Arrayable, Countable, IteratorAggregate, Jsonable, JsonSerializable (Просмотреть исходный код)
Трейты
| Macroable |
Свойства
| статический защищенный массив | $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 = []) Создать новый коллекцию. | |
| static Collection | make(mixed $items = []) Создать новый экземпляр коллекции, если значение не является коллекцией. | |
| array | all() Получить все элементы в коллекции. | |
| mixed | avg(string|null $key = null) Получить среднее значение заданного ключа. | |
| mixed | average(string|null $key = null) Псевдоним для метода «avg». | |
| mixed|null | median(null $key = null) Получить медиану заданного ключа. | |
| array | mode(null $key = null) Получить моду заданного ключа. | |
| Collection | collapse() Сжать коллекцию элементов в один массив. | |
| bool | contains(mixed $key, mixed $value = null) Определить, существует ли элемент в коллекции. | |
| Collection | diff(mixed $items) Получить элементы в коллекции, которые отсутствуют в заданных элементах. | |
| Collection | diffKeys(mixed $items) Получить элементы в коллекции, ключи которых отсутствуют в заданных элементах. | |
| $this | each(callable $callback) Выполнить обратный вызов над каждым элементом. | |
| Collection | every(int $step, int $offset) Создать новую коллекцию, содержащую каждый n-й элемент. | |
| Collection | except(mixed $keys) Получить все элементы, кроме тех, чьи ключи указаны. | |
| Collection | filter(callable $callback = null) Применить фильтр к каждому элементу. | |
| Collection | where(string $key, mixed $value, bool $strict = true) Фильтр элементов по заданной паре ключ-значение. | |
| Collection | whereLoose(string $key, mixed $value) Фильтр элементов по заданной паре ключ-значение с нестрогим сравнением. | |
| Collection | whereIn(string $key, array $values, bool $strict = true) Фильтр элементов по заданной паре ключ-значение. | |
| Collection | whereInLoose(string $key, array $values) Фильтр элементов по заданной паре ключ-значение с нестрогим сравнением. | |
| mixed | first(callable $callback = null, mixed $default = null) Получить первый элемент из коллекции. | |
| Collection | flatten(int $depth = INF) Получить сглаженный массив элементов в коллекции. | |
| Collection | flip() Перевернуть элементы в коллекции. | |
| $this | forget(string|array $keys) Удалить элемент из коллекции по ключу. | |
| mixed | get(mixed $key, mixed $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() Определить, пуста ли коллекция. | |
| 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) deprecated Псевдоним для метода «pluck». | |
| Collection | map(callable $callback) Применить отображение к каждому элементу. | |
| Collection | flatMap(callable $callback) Применить отображение к коллекции и сгладить результат на один уровень. | |
| mixed | max(string|null $key = null) Получить максимальное значение заданного ключа. |
| Коллекция | merge(mixed $items) Объединить коллекцию с заданными элементами. | |
| Коллекция | combine(mixed $values) Создать коллекцию, используя эту коллекцию для ключей и другую для значений. | |
| Коллекция | union(mixed $items) Объединить коллекцию с заданными элементами. | |
| mixed | min(string|null $key = null) Получить минимальное значение заданного ключа. | |
| Коллекция | only(mixed $keys) Получить элементы со специфицированными ключами. | |
| Коллекция | forPage(int $page, int $perPage) «Разбить» коллекцию на страницы, разделив её на меньшие коллекции. | |
| 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) Найти в коллекции заданное значение и вернуть соответствующий ключ, если поиск успешен. | |
| mixed | shift() Получить и удалить первый элемент из коллекции. | |
| Коллекция | shuffle(int $seed = null) Перемешать элементы в коллекции. | |
| Коллекция | slice(int $offset, int $length = null) Вырезать часть массива базовой коллекции. | |
| Коллекция | 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. |
Подробности
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 Collection make(mixed $items = [])
Создать новый экземпляр коллекции, если значение не является им уже.
array all()
Получить все элементы в коллекции.
mixed avg(string|null $key = null)
Получить среднее значение заданного ключа.
mixed average(string|null $key = null)
Псевдоним для метода «avg».
mixed|null median(null $key = null)
Получить медиану заданного ключа.
array mode(null $key = null)
Получить моду заданного ключа.
Collection collapse()
Сжать коллекцию элементов в один массив.
bool contains(mixed $key, mixed $value = null)
Определить, существует ли элемент в коллекции.
Collection diff(mixed $items)
Получить элементы в коллекции, отсутствующие в заданных элементах.
Collection diffKeys(mixed $items)
Получить элементы в коллекции, у которых ключи отсутствуют в заданных элементах.
$this each(callable $callback)
Выполнить обратный вызов для каждого элемента.
Collection every(int $step, int $offset)
Создать новую коллекцию, состоящую из каждого n-го элемента.
Collection except(mixed $keys)
Получить все элементы, за исключением тех, у которых указаны ключи.
Collection filter(callable $callback = null)
Применить фильтр к каждому элементу.
Collection where(string $key, mixed $value, bool $strict = true)
Фильтровать элементы по заданной паре ключ-значение.
Collection whereLoose(string $key, mixed $value)
Фильтрация элементов по заданной паре ключ-значение с использованием нестрогого сравнения.
Collection whereIn(string $key, array $values, bool $strict = true)
Фильтрация элементов по заданной паре ключ-значение.
Collection whereInLoose(string $key, array $values)
Фильтрация элементов по заданной паре ключ-значение с использованием нестрогого сравнения.
mixed first(callable $callback = null, mixed $default = null)
Получить первый элемент из коллекции.
Collection flatten(int $depth = INF)
Получить плоский массив элементов коллекции.
Collection flip()
Перевернуть элементы в коллекции.
$this forget(string|array $keys)
Удалить элемент из коллекции по ключу.
mixed get(mixed $key, mixed $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)
Объединить коллекцию с заданными элементами.
Collection combine(mixed $values)
Создать коллекцию, используя эту коллекцию для ключей и другую для значений.
Collection union(mixed $items)
Объединить коллекцию с заданными элементами.
mixed min(string|null $key = null)
Получить минимальное значение заданного ключа.
Collection only(mixed $keys)
Получить элементы с указанными ключами.
Collection forPage(int $page, int $perPage)
«Разбить» коллекцию на более мелкие, используя слайсинг.
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()
Получить и удалить первый элемент из коллекции.
Коллекция shuffle(int $seed = null)
Перемешать элементы в коллекции.
Коллекция slice(int $offset, int $length = null)
Вырезать фрагмент из массива коллекции.
Коллекция 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()
Сбросить ключи в базовом массиве.
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.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.2/Illuminate/Support/Collection.html
