Коллекция
класс 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(callable|string|null $callback = null) Получить среднее значение заданного ключа. | |
| mixed | average(callable|string|null $callback = null) Псевдоним для метода "avg". | |
| mixed | median(null $key = null) Получить медиану заданного ключа. | |
| array | mode(mixed $key = null) Получить моду заданного ключа. | |
| Collection | collapse() Сжать набор элементов в один массив. | |
| bool | contains(mixed $key, mixed $value = null) Определить, существует ли элемент в наборе. | |
| bool | containsStrict(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 $operator, mixed $value = null) Фильтрует элементы по заданной паре ключ-значение. | |
| Closure | operatorForWhere(string $key, string $operator, mixed $value) Получить обратный вызов проверки оператора. | |
| Collection | whereStrict(string $key, mixed $value) Фильтрует элементы по заданной паре ключ-значение с использованием строгого сравнения. | |
| Collection | whereIn(string $key, mixed $values, bool $strict = false) Фильтрует элементы по заданной паре ключ-значение. | |
| Collection | whereInStrict(string $key, mixed $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 | isNotEmpty() Определить, не пустой ли набор. | |
| bool | useAsCallable(mixed $value) Определить, является ли заданное значение вызываемым, но не строкой. | |
| Collection | keys() Получить ключи элементов набора. | |
| mixed | last(callable $callback = null, mixed $default = null) Получить последний элемент из набора. | |
| Collection | pluck(string $value, string|null $key = null) Получить значения заданного ключа. | |
| Collection | map(callable $callback) Применить отображение к каждому из элементов. |
| Collection | mapWithKeys(callable $callback) Применить ассоциативное отображение к каждому элементу. | |
| Collection | flatMap(callable $callback) Применить отображение к коллекции и уплостить результат на один уровень. | |
| mixed | max(callable|string|null $callback = null) Получить максимальное значение по заданному ключу. | |
| Collection | merge(mixed $items) Объединить коллекцию с заданными элементами. | |
| Collection | combine(mixed $values) Создать коллекцию, используя эту коллекцию для ключей и другую для значений. | |
| Collection | union(mixed $items) Объединить коллекцию с заданными элементами. | |
| mixed | min(callable|string|null $callback = null) Получить минимальное значение по заданному ключу. | |
| Collection | only(mixed $keys) Получить элементы со заданными ключами. | |
| Collection | forPage(int $page, int $perPage) «Разбить» коллекцию на страницы, отрезав часть элементов. | |
| Collection | 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) Получить сумму заданных значений. | |
| Collection | take(int $limit) Взять первые или последние {$limit} элементов. | |
| $this | transform(callable $callback) Преобразовать каждый элемент в коллекции с помощью обратного вызова. | |
| Collection | unique(string|callable|null $key = null, bool $strict = false) Возвратить только уникальные элементы из массива коллекции. | |
| Collection | uniqueStrict(string|callable|null $key = null) Возвратить только уникальные элементы из массива коллекции с помощью строгого сравнения. | |
| Collection | values() Сбросить ключи в базовом массиве. | |
| callable | valueRetriever(string $value) Получить функцию извлечения значений. | |
| Collection | 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() Подсчитать количество элементов в коллекции. | |
| Collection | toBase() Получить базовый экземпляр коллекции Support из этой коллекции. | |
| bool | offsetExists(mixed $key) Определить, существует ли элемент по заданному смещению. | |
| mixed | offsetGet(mixed $key) Получить элемент по заданному смещению. | |
| void | offsetSet(mixed $key, mixed $value) Установить элемент по заданному смещению. | |
| void | offsetUnset(string $key) Удалить элемент по заданному смещению. | |
| string | __toString() Преобразовать коллекцию в её строковое представление. | |
| array | getArrayableItems(mixed $items) Массив результатов элементов из Collection или 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(callable|string|null $callback = null)
Получить среднее значение заданного ключа.
mixed average(callable|string|null $callback = null)
Псевдоним для метода "avg".
mixed median(null $key = null)
Получить медиану заданного ключа.
array mode(mixed $key = null)
Получить моду заданного ключа.
Collection collapse()
Сжать коллекцию элементов в один массив.
bool contains(mixed $key, mixed $value = null)
Определить, существует ли элемент в коллекции.
bool containsStrict(mixed $key, mixed $value = null)
Определить, существует ли элемент в коллекции с использованием строгого сравнения.
Collection diff(mixed $items)
Получить элементы в коллекции, которые отсутствуют в заданных элементах.
Collection 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 Closure 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)
Получить сумму заданных значений.
Collection take(int $limit)
Взять первые или последние {$limit} элементов.
$this transform(callable $callback)
Преобразовать каждый элемент в коллекции с помощью обратного вызова.
Collection unique(string|callable|null $key = null, bool $strict = false)
Вернуть только уникальные элементы из массива коллекции.
Коллекция uniqueStrict(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]]
массив toArray()
Получить коллекцию элементов как обычный массив.
массив jsonSerialize()
Преобразовать объект в сериализуемый в JSON.
строка toJson(int $options)
Получить коллекцию элементов как JSON.
ArrayIterator getIterator()
Получить итератор для элементов.
CachingIterator getCachingIterator(int $flags = CachingIterator::CALL_TOSTRING)
Получить экземпляр CachingIterator.
целое число count()
Подсчитать количество элементов в коллекции.
Коллекция toBase()
Получить базовый экземпляр коллекции Support из этой коллекции.
булево offsetExists(mixed $key)
Определить, существует ли элемент по заданному смещению.
смешанный тип offsetGet(mixed $key)
Получить элемент по заданному смещению.
пустое значение offsetSet(mixed $key, mixed $value)
Установить элемент по заданному смещению.
пустое значение offsetUnset(string $key)
Удалить элемент по заданному смещению.
строка __toString()
Преобразовать коллекцию в строковое представление.
protected массив getArrayableItems(mixed $items)
Результирующий массив элементов из Коллекции или Arrayable.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.3/Illuminate/Support/Collection.html
