Spec-Zone.ru › Laravel 5.7

Коллекция

класс Collection реализует ArrayAccess, Arrayable, Countable, IteratorAggregate, Jsonable, JsonSerializable (Просмотреть исходный код)

Трейты

Macroable

Свойства

статический защищенный массив $macros Зарегистрированные строковые макросы. из Macroable
защищенный массив $items Элементы, содержащиеся в коллекции.
статический защищенный массив $proxies Методы, которые могут быть проксированы.

Методы

static void macro(string $name, object|callable $macro)

Зарегистрировать пользовательский макрос.

from Macroable
static void mixin(object $mixin)

Смешать другой объект в класс.

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 wrap(mixed $value)

Обернуть заданное значение в коллекцию, если применимо.

static array unwrap(array|Collection $value)

Получить базовые элементы из заданной коллекции, если применимо.

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)

Перекрестное объединение с заданными списками, возвращая все возможные перестановки.

void dd(...$args)

Вывести коллекцию и завершить скрипт.

$this dump()

Вывести коллекцию.

Collection diff(mixed $items)

Получить элементы в коллекции, отсутствующие в заданных элементах.

Collection diffUsing(mixed $items, callable $callback)

Получить элементы в коллекции, отсутствующие в заданных элементах.

Collection diffAssoc(mixed $items)

Получить элементы в коллекции, чьи ключи и значения отсутствуют в заданных элементах.

Collection diffAssocUsing(mixed $items, callable $callback)

Получить элементы в коллекции, чьи ключи и значения отсутствуют в заданных элементах.

Collection diffKeys(mixed $items)

Получить элементы в коллекции, чьи ключи отсутствуют в заданных элементах.

Collection diffKeysUsing(mixed $items, callable $callback)

Получить элементы в коллекции, чьи ключи отсутствуют в заданных элементах.

$this each(callable $callback)

Выполнить обратный вызов для каждого элемента.

Collection eachSpread(callable $callback)

Выполнить обратный вызов для каждого вложенного фрагмента элементов.

bool every(string|callable $key, mixed $operator = null, mixed $value = null)

Определить, проходят ли все элементы в коллекции заданный тест.

Collection except(Collection|mixed $keys)

Получить все элементы, кроме тех, у которых указаны ключи.

Collection filter(callable $callback = null)

Применить фильтр к каждому из элементов.

Collection|mixed when(bool $value, callable $callback, callable $default = null)

Применить обратный вызов, если значение истинно.

Collection|mixed unless(bool $value, callable $callback, callable $default = null)

Применить обратный вызов, если значение ложно.

Collection where(string $key, mixed $operator = null, mixed $value = null)

Фильтруйте элементы по заданной паре ключ-значение.

Closure operatorForWhere(string $key, string $operator = null, mixed $value = null)

Получить обратный вызов-проверяющий оператор.

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)

Фильтр элементов по заданной паре ключ-значение с использованием строгого сравнения.

Collection whereInstanceOf(string $type)

Отфильтровать элементы, удаляя все элементы, которые не соответствуют заданному типу.

mixed first(callable $callback = null, mixed $default = null)

Получить первый элемент из коллекции.

Collection firstWhere(string $key, mixed $operator, mixed $value = 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 intersectByKeys(mixed $items)

Пересечь коллекцию с заданными элементами по ключу.

bool isEmpty()

Определить, пуста ли коллекция.

bool isNotEmpty()

Определить, не пуста ли коллекция.

bool useAsCallable(mixed $value)

Определить, является ли заданное значение вызываемым, но не строкой.

Collection keys()

Получить ключи элементов коллекции.

mixed last(callable $callback = null, mixed $default = null)

Получить последний элемент из коллекции.

Collection pluck(string|array $value, string|null $key = null)

Получить значения заданного ключа.

Collection map(callable $callback)

Применить отображение к каждому из элементов.

Collection mapSpread(callable $callback)

Применить отображение к каждой вложенной группе элементов.

Collection mapToDictionary(callable $callback)

Применить отображение словаря к элементам.

Collection mapToGroups(callable $callback)

Применить отображение группировки к элементам.

Collection mapWithKeys(callable $callback)

Применить ассоциативное отображение к каждому из элементов.

Collection flatMap(callable $callback)

Применить отображение к коллекции и сплющить результат на один уровень.

Collection mapInto(string $class)

Применить отображение значений в новый класс.

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 nth(int $step, int $offset = 0)

Создать новую коллекцию, состоящую из каждого n-го элемента.

Collection only(mixed $keys)

Получить элементы с указанными ключами.

Collection forPage(int $page, int $perPage)

«Разбить» коллекцию, разделив ее на меньшие коллекции.

Collection partition(callable|string $key, mixed $operator = null, mixed $value = null)

Разделить коллекцию на два массива, используя заданный обратный вызов или ключ.

mixed pipe(callable $callback)

Передать коллекцию в заданный обратный вызов и вернуть результат.

mixed pop()

Получить и удалить последний элемент из коллекции.

$this prepend(mixed $value, mixed $key = null)

Добавить элемент в начало коллекции.

$this push(mixed $value)

Добавить элемент в конец коллекции.

Collection concat(Traversable|array $source)

Добавить все заданные элементы в коллекцию.

mixed pull(mixed $key, mixed $default = null)

Получить и удалить элемент из коллекции.

$this put(mixed $key, mixed $value)

Поместить элемент в коллекцию по ключу.

Collection|mixed random(int|null $number = null)

Случайным образом получить один или заданное количество элементов из коллекции.

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 sortKeys(int $options = SORT_REGULAR, bool $descending = false)

Сортировать ключи коллекции.

Collection sortKeysDesc(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 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()

Сбросить ключи в базовом массиве.

callable valueRetriever(string $value)

Получить обратный вызов для извлечения значения.

Collection zip(mixed $items)

Объединить коллекцию с одним или несколькими массивами.

Collection pad(int $size, mixed $value)

Заполнить коллекцию до заданной длины значением.

array toArray()

Получить коллекцию элементов в виде обычного массива.

array jsonSerialize()

Преобразовать объект в сериализуемое JSON.

string toJson(int $options = 0)

Получить коллекцию элементов в формате 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 proxy(string $method)

Добавить метод в список прокси-методов.

mixed __get(string $key)

Динамический доступ к прокси-элементам коллекции.

Подробности

static void macro(string $name, object|callable $macro)

Регистрация пользовательского макроса.

Параметры

string $name
object|callable $macro

Возвращаемое значение

void

static void mixin(object $mixin)

Добавление другого объекта в класс.

Параметры

object $mixin

Возвращаемое значение

void

Исключения

ReflectionException

static bool hasMacro(string $name)

Проверка наличия зарегистрированного макроса.

Параметры

string $name

Возвращаемое значение

bool

static mixed __callStatic(string $method, array $parameters)

Динамическая обработка вызовов класса.

Параметры

string $method
array $parameters

Возвращаемое значение

mixed

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

Динамическая обработка вызовов класса.

Параметры

string $method
array $parameters

Возвращаемое значение

mixed

Исключения

BadMethodCallException

void __construct(mixed $items = [])

Создание новой коллекции.

Параметры

mixed $items

Возвращаемое значение

void

static Collection make(mixed $items = [])

Создание нового экземпляра коллекции, если значение не является коллекцией.

Параметры

mixed $items

Возвращаемое значение

Collection

static Collection wrap(mixed $value)

Обернуть заданное значение в коллекцию, если применимо.

Параметры

mixed $value

Возвращаемое значение

Collection

static array unwrap(array|Collection $value)

Получение базовых элементов из заданной коллекции, если применимо.

Параметры

array|Collection $value

Возвращаемое значение

array

static Collection times(int $number, callable $callback = null)

Создание новой коллекции, вызывая обратный вызов заданное количество раз.

Параметры

int $number
callable $callback

Возвращаемое значение

Collection

array all()

Получение всех элементов в коллекции.

Возвращаемое значение

array

mixed avg(callable|string|null $callback = null)

Получение среднего значения заданного ключа.

Параметры

callable|string|null $callback

Возвращаемое значение

mixed

mixed average(callable|string|null $callback = null)

Псевдоним для метода "avg".

Параметры

callable|string|null $callback

Возвращаемое значение

mixed

mixed median(null $key = null)

Получение медианы заданного ключа.

Параметры

null $key

Возвращаемое значение

mixed

array|null mode(mixed $key = null)

Получение моды заданного ключа.

Параметры

mixed $key

Возвращаемое значение

array|null

Collection collapse()

Сжатие коллекции элементов в один массив.

Возвращаемое значение

Collection

bool contains(mixed $key, mixed $operator = null, mixed $value = null)

Определение наличия элемента в коллекции.

Параметры

mixed $key
mixed $operator
mixed $value

Возвращаемое значение

bool

bool containsStrict(mixed $key, mixed $value = null)

Определение наличия элемента в коллекции с использованием строгого сравнения.

Параметры

mixed $key
mixed $value

Возвращаемое значение

bool

Collection crossJoin(mixed ...$lists)

Перекрестное объединение с заданными списками, возвращая все возможные перестановки.

Параметры

mixed ...$lists

Возвращаемое значение

Collection

void dd(...$args)

Вывод коллекции и завершение скрипта.

Параметры

...$args

Возвращаемое значение

void

$this dump()

Вывести коллекцию.

Возвращаемое значение

$this

Коллекция diff(mixed $items)

Получить элементы в коллекции, которых нет в заданных элементах.

Параметры

mixed $items

Возвращаемое значение

Коллекция

Коллекция diffUsing(mixed $items, callable $callback)

Получить элементы в коллекции, которых нет в заданных элементах.

Параметры

mixed $items
callable $callback

Возвращаемое значение

Коллекция

Коллекция diffAssoc(mixed $items)

Получить элементы в коллекции, у которых ключи и значения отсутствуют в заданных элементах.

Параметры

mixed $items

Возвращаемое значение

Коллекция

Коллекция diffAssocUsing(mixed $items, callable $callback)

Получить элементы в коллекции, у которых ключи и значения отсутствуют в заданных элементах.

Параметры

mixed $items
callable $callback

Возвращаемое значение

Коллекция

Коллекция diffKeys(mixed $items)

Получить элементы в коллекции, у которых ключи отсутствуют в заданных элементах.

Параметры

mixed $items

Возвращаемое значение

Коллекция

Коллекция diffKeysUsing(mixed $items, callable $callback)

Получить элементы в коллекции, у которых ключи отсутствуют в заданных элементах.

Параметры

mixed $items
callable $callback

Возвращаемое значение

Коллекция

$this each(callable $callback)

Выполнить обратный вызов над каждым элементом.

Параметры

callable $callback

Возвращаемое значение

$this

Коллекция eachSpread(callable $callback)

Выполнить обратный вызов над каждым вложенным фрагментом элементов.

Параметры

callable $callback

Возвращаемое значение

Коллекция

bool every(string|callable $key, mixed $operator = null, mixed $value = null)

Определить, проходят ли все элементы в коллекции заданный тест.

Параметры

string|callable $key
mixed $operator
mixed $value

Возвращаемое значение

bool

Коллекция except(Коллекция|mixed $keys)

Получить все элементы, кроме тех, у которых указаны ключи.

Параметры

Коллекция|mixed $keys

Возвращаемое значение

Коллекция

Коллекция filter(callable $callback = null)

Применить фильтр к каждому элементу.

Параметры

callable $callback

Возвращаемое значение

Коллекция

Коллекция|mixed when(bool $value, callable $callback, callable $default = null)

Применить обратный вызов, если значение истинно.

Параметры

bool $value
callable $callback
callable $default

Возвращаемое значение

Коллекция|mixed

Коллекция|mixed unless(bool $value, callable $callback, callable $default = null)

Применить обратный вызов, если значение ложно.

Параметры

bool $value
callable $callback
callable $default

Возвращаемое значение

Коллекция|mixed

Коллекция where(string $key, mixed $operator = null, mixed $value = null)

Фильтр элементов по заданной паре ключ-значение.

Параметры

string $key
mixed $operator
mixed $value

Возвращаемое значение

Коллекция

protected Замыкание operatorForWhere(string $key, string $operator = null, mixed $value = null)

Получить обратный вызов для проверки оператора.

Параметры

string $key
string $operator
mixed $value

Возвращаемое значение

Замыкание

Коллекция whereStrict(string $key, mixed $value)

Фильтр элементов по заданной паре ключ-значение с использованием строгого сравнения.

Параметры

string $key
mixed $value

Возвращаемое значение

Коллекция
END_OF_DOCUMENT_MARKER

Коллекция whereIn(string $key, mixed $values, bool $strict = false)

Фильтрация элементов по заданной паре ключ-значение.

Параметры

string $key
mixed $values
bool $strict

Возвращаемое значение

Коллекция

Коллекция whereInStrict(string $key, mixed $values)

Фильтрация элементов по заданной паре ключ-значение с жёстким сравнением.

Параметры

string $key
mixed $values

Возвращаемое значение

Коллекция

Коллекция whereNotIn(string $key, mixed $values, bool $strict = false)

Фильтрация элементов по заданной паре ключ-значение.

Параметры

string $key
mixed $values
bool $strict

Возвращаемое значение

Коллекция

Коллекция whereNotInStrict(string $key, mixed $values)

Фильтрация элементов по заданной паре ключ-значение с жёстким сравнением.

Параметры

string $key
mixed $values

Возвращаемое значение

Коллекция

Коллекция whereInstanceOf(string $type)

Фильтрация элементов, удаляя те, которые не соответствуют заданному типу.

Параметры

string $type

Возвращаемое значение

Коллекция

mixed first(callable $callback = null, mixed $default = null)

Получение первого элемента из коллекции.

Параметры

callable $callback
mixed $default

Возвращаемое значение

mixed

Коллекция firstWhere(string $key, mixed $operator, mixed $value = null)

Получение первого элемента по заданной паре ключ-значение.

Параметры

string $key
mixed $operator
mixed $value

Возвращаемое значение

Коллекция

Коллекция flatten(int $depth = INF)

Получение плоского массива элементов из коллекции.

Параметры

int $depth

Возвращаемое значение

Коллекция

Коллекция flip()

Переворачивание элементов в коллекции.

Возвращаемое значение

Коллекция

$this forget(string|array $keys)

Удаление элемента из коллекции по ключу.

Параметры

string|array $keys

Возвращаемое значение

$this

mixed get(mixed $key, mixed $default = null)

Получение элемента из коллекции по ключу.

Параметры

mixed $key
mixed $default

Возвращаемое значение

mixed

Коллекция groupBy(callable|string $groupBy, bool $preserveKeys = false)

Группировка ассоциативного массива по полю или с помощью обратного вызова.

Параметры

callable|string $groupBy
bool $preserveKeys

Возвращаемое значение

Коллекция

Коллекция keyBy(callable|string $keyBy)

Установка ключей в ассоциативный массив по полю или с помощью обратного вызова.

Параметры

callable|string $keyBy

Возвращаемое значение

Коллекция

bool has(mixed $key)

Определение наличия элемента в коллекции по ключу.

Параметры

mixed $key

Возвращаемое значение

bool

string implode(string $value, string $glue = null)

Конкатенация значений заданного ключа в строку.

Параметры

string $value
string $glue

Возвращаемое значение

string

Коллекция intersect(mixed $items)

Пересечение коллекции с заданными элементами.

Параметры

mixed $items

Возвращаемое значение

Коллекция

Коллекция intersectByKeys(mixed $items)

Пересечение коллекции с заданными элементами по ключу.

Параметры

mixed $items

Возвращаемое значение

Коллекция

bool isEmpty()

Определение пустоты коллекции.

Возвращаемое значение

bool

bool isNotEmpty()

Определение непорожности коллекции.

Возвращаемое значение

bool

protected bool useAsCallable(mixed $value)

Определить, является ли данное значение вызываемым, но не строкой.

Параметры

mixed $value

Возвращаемое значение

bool

Collection keys()

Получить ключи элементов коллекции.

Возвращаемое значение

Collection

mixed last(callable $callback = null, mixed $default = null)

Получить последний элемент из коллекции.

Параметры

callable $callback
mixed $default

Возвращаемое значение

mixed

Collection pluck(string|array $value, string|null $key = null)

Получить значения заданного ключа.

Параметры

string|array $value
string|null $key

Возвращаемое значение

Collection

Collection map(callable $callback)

Применить отображение к каждому из элементов.

Параметры

callable $callback

Возвращаемое значение

Collection

Collection mapSpread(callable $callback)

Применить отображение к каждому вложенному фрагменту элементов.

Параметры

callable $callback

Возвращаемое значение

Collection

Collection mapToDictionary(callable $callback)

Применить отображение словаря к элементам.

Обратный вызов должен возвращать ассоциативный массив с одной парой ключ/значение.

Параметры

callable $callback

Возвращаемое значение

Collection

Collection mapToGroups(callable $callback)

Применить отображение группировки к элементам.

Обратный вызов должен возвращать ассоциативный массив с одной парой ключ/значение.

Параметры

callable $callback

Возвращаемое значение

Collection

Collection mapWithKeys(callable $callback)

Применить отображение с ключами к каждому элементу.

Обратный вызов должен возвращать ассоциативный массив с одной парой ключ/значение.

Параметры

callable $callback

Возвращаемое значение

Collection

Collection flatMap(callable $callback)

Применить отображение к коллекции и сплющить результат на один уровень.

Параметры

callable $callback

Возвращаемое значение

Collection

Collection mapInto(string $class)

Применить отображение значений в новый класс.

Параметры

string $class

Возвращаемое значение

Collection

mixed max(callable|string|null $callback = null)

Получить максимальное значение заданного ключа.

Параметры

callable|string|null $callback

Возвращаемое значение

mixed

Collection merge(mixed $items)

Объединить коллекцию с заданными элементами.

Параметры

mixed $items

Возвращаемое значение

Collection

Collection combine(mixed $values)

Создать коллекцию, используя эту коллекцию для ключей и другую для значений.

Параметры

mixed $values

Возвращаемое значение

Collection

Collection union(mixed $items)

Объединить коллекцию с заданными элементами.

Параметры

mixed $items

Возвращаемое значение

Collection

mixed min(callable|string|null $callback = null)

Получить минимальное значение заданного ключа.

Параметры

callable|string|null $callback

Возвращаемое значение

mixed

Collection nth(int $step, int $offset = 0)

Создать новую коллекцию, состоящую из каждого n-го элемента.

Параметры

int $step
int $offset

Возвращаемое значение

Collection

Collection only(mixed $keys)

Получить элементы со значениями указанных ключей.

Параметры

mixed $keys

Возвращаемое значение

Collection

Collection forPage(int $page, int $perPage)

«Разбить на страницы» коллекцию, разделив ее на более мелкие коллекции.

Параметры

int $page
int $perPage

Возвращаемое значение

Collection
END_OF_DOCUMENT_MARKER

Коллекция partition(callable|string $key, mixed $operator = null, mixed $value = null)

Разделить коллекцию на два массива с помощью заданного обратного вызова или ключа.

Параметры

callable|string $key
mixed $operator
mixed $value

Возвращаемое значение

Коллекция

mixed pipe(callable $callback)

Передать коллекцию в заданный обратный вызов и вернуть результат.

Параметры

callable $callback

Возвращаемое значение

mixed

mixed pop()

Получить и удалить последний элемент из коллекции.

Возвращаемое значение

mixed

$this prepend(mixed $value, mixed $key = null)

Добавить элемент в начало коллекции.

Параметры

mixed $value
mixed $key

Возвращаемое значение

$this

$this push(mixed $value)

Добавить элемент в конец коллекции.

Параметры

mixed $value

Возвращаемое значение

$this

Коллекция concat(Traversable|array $source)

Добавить все заданные элементы в коллекцию.

Параметры

Traversable|array $source

Возвращаемое значение

Коллекция

mixed pull(mixed $key, mixed $default = null)

Получить и удалить элемент из коллекции.

Параметры

mixed $key
mixed $default

Возвращаемое значение

mixed

$this put(mixed $key, mixed $value)

Добавить элемент в коллекцию по ключу.

Параметры

mixed $key
mixed $value

Возвращаемое значение

$this

Коллекция|mixed random(int|null $number = null)

Получить один или заданное количество случайных элементов из коллекции.

Параметры

int|null $number

Возвращаемое значение

Коллекция|mixed

Исключения

InvalidArgumentException

mixed reduce(callable $callback, mixed $initial = null)

Свести коллекцию к одному значению.

Параметры

callable $callback
mixed $initial

Возвращаемое значение

mixed

Коллекция reject(callable|mixed $callback)

Создать коллекцию из всех элементов, которые не удовлетворяют заданному условию.

Параметры

callable|mixed $callback

Возвращаемое значение

Коллекция

Коллекция reverse()

Инвертировать порядок элементов.

Возвращаемое значение

Коллекция

mixed search(mixed $value, bool $strict = false)

Поиск значения в коллекции и возврат соответствующего ключа при успехе.

Параметры

mixed $value
bool $strict

Возвращаемое значение

mixed

mixed shift()

Получить и удалить первый элемент из коллекции.

Возвращаемое значение

mixed

Коллекция shuffle(int $seed = null)

Перемешать элементы в коллекции.

Параметры

int $seed

Возвращаемое значение

Коллекция

Коллекция slice(int $offset, int $length = null)

Извлечение части массива коллекции.

Параметры

int $offset
int $length

Возвращаемое значение

Коллекция

Коллекция split(int $numberOfGroups)

Разделить коллекцию на определенное количество групп.

Параметры

int $numberOfGroups

Возвращаемое значение

Коллекция

Коллекция chunk(int $size)

Разбить коллекцию на части.

Параметры

int $size

Возвращаемое значение

Коллекция

Коллекция sort(callable $callback = null)

Сортировка элементов с помощью обратного вызова.

Параметры

callable $callback

Возвращаемое значение

Коллекция

Collection sortBy(callable|string $callback, int $options = SORT_REGULAR, bool $descending = false)

Сортировать коллекцию с использованием заданного обратного вызова.

Параметры

callable|string $callback
int $options
bool $descending

Возвращаемое значение

Collection

Collection sortByDesc(callable|string $callback, int $options = SORT_REGULAR)

Сортировать коллекцию в порядке убывания с использованием заданного обратного вызова.

Параметры

callable|string $callback
int $options

Возвращаемое значение

Collection

Collection sortKeys(int $options = SORT_REGULAR, bool $descending = false)

Сортировать ключи коллекции.

Параметры

int $options
bool $descending

Возвращаемое значение

Collection

Collection sortKeysDesc(int $options = SORT_REGULAR)

Сортировать ключи коллекции в порядке убывания.

Параметры

int $options

Возвращаемое значение

Collection

Collection splice(int $offset, int|null $length = null, mixed $replacement = [])

Вырезать часть массива лежащего в основе коллекции.

Параметры

int $offset
int|null $length
mixed $replacement

Возвращаемое значение

Collection

mixed sum(callable|string|null $callback = null)

Получить сумму заданных значений.

Параметры

callable|string|null $callback

Возвращаемое значение

mixed

Collection take(int $limit)

Взять первые или последние {$limit} элементы.

Параметры

int $limit

Возвращаемое значение

Collection

$this tap(callable $callback)

Передать коллекцию заданному обратному вызову, а затем вернуть её.

Параметры

callable $callback

Возвращаемое значение

$this

$this transform(callable $callback)

Преобразовать каждый элемент в коллекции с помощью обратного вызова.

Параметры

callable $callback

Возвращаемое значение

$this

Collection unique(string|callable|null $key = null, bool $strict = false)

Возвратить только уникальные элементы из массива коллекции.

Параметры

string|callable|null $key
bool $strict

Возвращаемое значение

Collection

Collection uniqueStrict(string|callable|null $key = null)

Возвратить только уникальные элементы из массива коллекции, используя строгое сравнение.

Параметры

string|callable|null $key

Возвращаемое значение

Collection

Collection values()

Сбросить ключи в массиве лежащем в основе.

Возвращаемое значение

Collection

protected callable valueRetriever(string $value)

Получить обратный вызов для извлечения значения.

Параметры

string $value

Возвращаемое значение

callable

Collection zip(mixed $items)

Объединить коллекцию с одним или несколькими массивами.

Например: new Collection([1, 2, 3])->zip([4, 5, 6]); => [[1, 4], [2, 5], [3, 6]]

Параметры

mixed $items

Возвращаемое значение

Collection

Collection pad(int $size, mixed $value)

Заполнить коллекцию до указанной длины значением.

Параметры

int $size
mixed $value

Возвращаемое значение

Collection

array toArray()

Получить коллекцию элементов как обычный массив.

Возвращаемое значение

array

array jsonSerialize()

Преобразовать объект в то, что может быть сериализовано в JSON.

Возвращаемое значение

array

string toJson(int $options = 0)

Получить коллекцию элементов в формате JSON.

Параметры

int $options

Возвращаемое значение

string

ArrayIterator getIterator()

Получить итератор для элементов.

Возвращаемое значение

ArrayIterator

CachingIterator getCachingIterator(int $flags = CachingIterator::CALL_TOSTRING)

Получить экземпляр CachingIterator.

Параметры

int $flags

Возвращаемое значение

CachingIterator

int count()

Подсчитать количество элементов в коллекции.

Возвращаемое значение

int

Коллекция toBase()

Получить базовый экземпляр коллекции Support из этой коллекции.

Возвращаемое значение

Коллекция

bool offsetExists(mixed $key)

Определить, существует ли элемент по указанному смещению.

Параметры

mixed $key

Возвращаемое значение

bool

mixed offsetGet(mixed $key)

Получить элемент по заданному смещению.

Параметры

mixed $key

Возвращаемое значение

mixed

void offsetSet(mixed $key, mixed $value)

Установить элемент по заданному смещению.

Параметры

mixed $key
mixed $value

Возвращаемое значение

void

void offsetUnset(string $key)

Удалить элемент по заданному смещению.

Параметры

string $key

Возвращаемое значение

void

string __toString()

Преобразовать коллекцию в строковое представление.

Возвращаемое значение

string

protected array getArrayableItems(mixed $items)

Массив результатов элементов из коллекции или Arrayable.

Параметры

mixed $items

Возвращаемое значение

array

static void proxy(string $method)

Добавить метод в список проксируемых методов.

Параметры

string $method

Возвращаемое значение

void

mixed __get(string $key)

Динамический доступ к прокси коллекций.

Параметры

string $key

Возвращаемое значение

mixed

Исключения

Исключение

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.7/Illuminate/Support/Collection.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API