Коллекция
класс Collection реализует ArrayAccess, Arrayable, Countable, IteratorAggregate, Jsonable, JsonSerializable (Просмотреть исходный код)
Трейты
| Macroable |
Свойства
| статический защищенный массив | $macros | Зарегистрированные строковые макросы. | из Macroable |
| защищенный массив | $items | Элементы, содержащиеся в коллекции. | |
| статический защищенный массив | $proxies | Методы, которые можно использовать в качестве прокси. |
Методы
| 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 = []) Создать новый экземпляр коллекции, если значение ещё не является таковым. | |
| static Collection | times(int $number, callable $callback = null) Создать новую коллекцию, вызывая обратный вызов заданное количество раз. | |
| array | all() Получить все элементы коллекции. | |
| mixed | avg(callable|string|null $callback = null) Получить среднее значение заданного ключа. | |
| mixed | average(callable|string|null $callback = null) Псевдоним для метода "avg". | |
| mixed | median(null $key = null) Получить медиану заданного ключа. | |
| array|null | mode(mixed $key = null) Получить моду заданного ключа. | |
| Collection | collapse() Свернуть коллекцию элементов в один массив. | |
| bool | contains(mixed $key, mixed $operator = null, mixed $value = null) Определить, существует ли элемент в коллекции. | |
| bool | containsStrict(mixed $key, mixed $value = null) Определить, существует ли элемент в коллекции, используя строгое сравнение. | |
| Collection | crossJoin(mixed $lists) Перекрестное соединение с заданными списками, возвращающее все возможные перестановки. | |
| Collection | diff(mixed $items) Получить элементы коллекции, которые отсутствуют в заданных элементах. | |
| Collection | diffAssoc(mixed $items) Получить элементы коллекции, ключи и значения которых отсутствуют в заданных элементах. | |
| Collection | diffKeys(mixed $items) Получить элементы коллекции, ключи которых отсутствуют в заданных элементах. | |
| $this | each(callable $callback) Выполнить обратный вызов для каждого элемента. | |
| Collection | eachSpread(callable $callback) Выполнить обратный вызов для каждого вложенного фрагмента элементов. | |
| bool | every(string|callable $key, mixed $operator = null, mixed $value = null) Определить, проходят ли все элементы коллекции заданный тест. | |
| Collection | except(mixed $keys) Получить все элементы, кроме тех, у которых указанные ключи. | |
| Collection | filter(callable $callback = null) Запустить фильтр для каждого из элементов. | |
| mixed | when(bool $value, callable $callback, callable $default = null) Применить обратный вызов, если значение истинно. | |
| mixed | unless(bool $value, callable $callback, callable $default = 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) Отфильтровать элементы по заданной паре «ключ-значение», используя строгое сравнение. | |
| Collection | whereNotIn(string $key, mixed $values, bool $strict = false) Отфильтровать элементы по заданной паре «ключ-значение». | |
| Collection | whereNotInStrict(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) Конкатенация значений заданного ключа в строку. | |
| Коллекция | intersect(mixed $items) Пересечение коллекции с заданными элементами. | |
| Коллекция | intersectKey(mixed $items) Пересечение коллекции с заданными элементами по ключу. | |
| bool | isEmpty() Определить, пуста ли коллекция. | |
| bool | isNotEmpty() Определить, не пуста ли коллекция. | |
| bool | useAsCallable(mixed $value) Определить, является ли заданное значение вызываемым, но не строкой. | |
| Коллекция | keys() Получить ключи элементов коллекции. | |
| mixed | last(callable $callback = null, mixed $default = null) Получить последний элемент из коллекции. | |
| Коллекция | pluck(string|array $value, string|null $key = null) Получить значения заданного ключа. | |
| Коллекция | map(callable $callback) Выполнить отображение над каждым из элементов. | |
| Коллекция | mapSpread(callable $callback) Выполнить отображение над каждым вложенным фрагментом элементов. | |
| Коллекция | mapToGroups(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) Получить минимальное значение заданного ключа. | |
| Коллекция | nth(int $step, int $offset) Создать новую коллекцию, состоящую из каждого n-го элемента. | |
| Коллекция | 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) Добавить элемент в конец коллекции. | |
| Коллекция | concat(Traversable $source) Добавить все заданные элементы в коллекцию. | |
| mixed | pull(mixed $key, mixed $default = null) Получить и удалить элемент из коллекции. | |
| $this | put(mixed $key, mixed $value) Добавить элемент в коллекцию по ключу. | |
| mixed | random(int|null $number = null) Получить один или указанное количество элементов случайным образом из коллекции. | |
| 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) Выделить фрагмент из базового массива коллекции. | |
| Коллекция | split(int $numberOfGroups) Разделить коллекцию на определенное количество групп. | |
| Коллекция | 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 | tap(callable $callback) Передать коллекцию в заданный обратный вызов, а затем вернуть её. | |
| $this | transform(callable $callback) Преобразовать каждый элемент в коллекции с помощью обратного вызова. | |
| Коллекция | unique(string|callable|null $key = null, bool $strict = false) Возвратить только уникальные элементы из массива коллекции. | |
| Коллекция | uniqueStrict(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() Подсчитать количество элементов в коллекции. | |
| Коллекция | toBase() Получить базовый экземпляр коллекции Support из этой коллекции. | |
| булево значение | offsetExists(mixed $key) Определить, существует ли элемент по данному смещению. | |
| mixed | offsetGet(mixed $key) Получить элемент по заданному смещению. | |
| void | offsetSet(mixed $key, mixed $value) Установить элемент по заданному смещению. | |
| void | offsetUnset(string $key) Удалить элемент по заданному смещению. | |
| строка | __toString() Преобразовать коллекцию в её строковое представление. | |
| массив | getArrayableItems(mixed $items) Результат массива элементов из Коллекции или Arrayable. | |
| статический void | proxy(string $method) Добавить метод в список прокси-методов. | |
| mixed | __get(string $key) Динамический доступ к прокси-объектам коллекции. |
Подробности
статический void macro(string $name, callable $macro)
Зарегистрировать пользовательское макро.
статический bool hasMacro(string $name)
Проверяет, зарегистрировано ли макро.
статический mixed __callStatic(string $method, array $parameters)
Динамически обрабатывать вызовы к классу.
mixed __call(string $method, array $parameters)
Динамически обрабатывать вызовы к классу.
void __construct(mixed $items = [])
Создать новую коллекцию.
статический Коллекция make(mixed $items = [])
Создать новый экземпляр коллекции, если значение не является уже коллекцией.
статический Коллекция times(int $number, callable $callback = null)
Создать новую коллекцию, вызвав обратный вызов заданное количество раз.
массив all()
Получить все элементы в коллекции.
mixed avg(callable|string|null $callback = null)
Получить среднее значение заданного ключа.
mixed average(callable|string|null $callback = null)
Псевдоним для метода "avg".
mixed median(null $key = null)
Получить медиану заданного ключа.
array|null mode(mixed $key = null)
Получить моду заданного ключа.
Collection collapse()
Сжать коллекцию элементов в один массив.
bool contains(mixed $key, mixed $operator = null, mixed $value = null)
Определить, существует ли элемент в коллекции.
bool containsStrict(mixed $key, mixed $value = null)
Определить, существует ли элемент в коллекции с использованием строгого сравнения.
Collection crossJoin(mixed $lists)
Перекрестное соединение с заданными списками, возвращающее все возможные перестановки.
Collection diff(mixed $items)
Получить элементы в коллекции, которых нет в заданных элементах.
Collection diffAssoc(mixed $items)
Получить элементы в коллекции, у которых ключи и значения отсутствуют в заданных элементах.
Collection diffKeys(mixed $items)
Получить элементы в коллекции, у которых ключи отсутствуют в заданных элементах.
$this each(callable $callback)
Выполнить обратный вызов над каждым элементом.
Collection eachSpread(callable $callback)
Выполнить обратный вызов над каждым вложенным фрагментом элементов.
bool every(string|callable $key, mixed $operator = null, mixed $value = null)
Определить, проходят ли все элементы в коллекции заданный тест.
Collection except(mixed $keys)
Получить все элементы, кроме тех, чьи ключи указаны.
Collection filter(callable $callback = null)
Применить фильтр к каждому из элементов.
mixed when(bool $value, callable $callback, callable $default = null)
Применить обратный вызов, если значение истинно.
mixed unless(bool $value, callable $callback, callable $default = null)
Применить обратный вызов, если значение ложно.
Collection where(string $key, mixed $operator, mixed $value = null)
Фильтровать элементы по заданной паре ключ-значение.
protected 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)
Фильтровать элементы по заданной паре ключ-значение с использованием строгого сравнения.
Collection whereNotIn(string $key, mixed $values, bool $strict = false)
Фильтровать элементы по заданной паре ключ-значение.
Collection whereNotInStrict(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)
Пересечение коллекции с заданными элементами.
Collection intersectKey(mixed $items)
Пересечение коллекции с заданными элементами по ключу.
bool isEmpty()
Определить, пуста ли коллекция.
bool isNotEmpty()
Определить, не пуста ли коллекция.
protected bool useAsCallable(mixed $value)
Определить, является ли заданное значение вызываемым, но не строкой.
Коллекция keys()
Получить ключи элементов коллекции.
mixed last(callable $callback = null, mixed $default = null)
Получить последний элемент из коллекции.
Коллекция pluck(string|array $value, string|null $key = null)
Получить значения заданного ключа.
Коллекция map(callable $callback)
Применить функцию к каждому элементу.
Коллекция mapSpread(callable $callback)
Применить функцию к каждому вложенному фрагменту элементов.
Коллекция mapToGroups(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)
Получить минимальное значение заданного ключа.
Коллекция nth(int $step, int $offset)
Создать новую коллекцию, состоящую из каждого n-го элемента.
Коллекция 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)
Добавить элемент в конец коллекции.
Коллекция concat(Traversable $source)
Добавить все заданные элементы в коллекцию.
mixed pull(mixed $key, mixed $default = null)
Получить и удалить элемент из коллекции.
$this put(mixed $key, mixed $value)
Поместить элемент в коллекцию по ключу.
mixed random(int|null $number = null)
Получить один или заданное количество элементов случайным образом из коллекции.
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)
Вырезать часть массива базовой коллекции.
Коллекция split(int $numberOfGroups)
Разбить коллекцию на определенное количество групп.
Коллекция 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)
Получить сумму заданных значений.
Collection take(int $limit)
Взять первые или последние {$limit} элементов.
$this tap(callable $callback)
Передать коллекцию в заданный обратный вызов, а затем вернуть её.
$this transform(callable $callback)
Преобразовать каждый элемент в коллекции с помощью обратного вызова.
Collection unique(string|callable|null $key = null, bool $strict = false)
Возвратить только уникальные элементы из массива коллекции.
Collection uniqueStrict(string|callable|null $key = null)
Возвратить только уникальные элементы из массива коллекции, используя строгое сравнение.
Collection values()
Сбросить ключи в базовом массиве.
protected callable valueRetriever(string $value)
Получить обратный вызов для извлечения значений.
Collection 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()
Подсчитать количество элементов в коллекции.
Collection 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.
static void proxy(string $method)
Добавить метод в список проксированных методов.
mixed __get(string $key)
Динамический доступ к коллекционным прокси.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.4/Illuminate/Support/Collection.html
