Spec-Zone.ru › Laravel 5.8

Коллекция

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

Трейты

Macroable

Свойства

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

Методы

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

Зарегистрировать пользовательскую макрокоманду.

из Macroable
static void mixin(object $mixin, bool $replace = true)

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

из 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 = [])

Создать новый набор.

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(string|array|null $key = null)

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

array|null mode(string|array|null $key = null)

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

Collection collapse()

Свернуть набор элементов в один массив.

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

Псевдоним для метода «contains».

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

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

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

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

Collection crossJoin(mixed ...$lists)

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

void dd(mixed ...$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)

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

Collection duplicates(callable|null $callback = null, bool $strict = false)

Получить дублирующиеся элементы из набора.

Collection duplicatesStrict(callable|null $callback = null)

Получить дублирующиеся элементы из набора с использованием строгого сравнения.

Closure duplicateComparator(bool $strict)

Получить функцию сравнения для обнаружения дубликатов.

$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 whenEmpty(callable $callback, callable $default = null)

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

Collection|mixed whenNotEmpty(callable $callback, callable $default = null)

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

Коллекция|смешанный unless(bool $value, callable $callback, callable $default = null)

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

Коллекция|смешанный unlessEmpty(callable $callback, callable $default = null)

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

Коллекция|смешанный unlessNotEmpty(callable $callback, callable $default = null)

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

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

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

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

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

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

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

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

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

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

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

Коллекция whereBetween(string $key, array $values)

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

Коллекция whereNotBetween(string $key, array $values)

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

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

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

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

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

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

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

смешанный first(callable $callback = null, mixed $default = null)

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

смешанный firstWhere(string $key, mixed $operator = null, mixed $value = null)

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

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

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

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

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

$this forget(string|array $keys)

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

смешанный get(mixed $key, mixed $default = null)

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

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

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

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

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

bool has(mixed $key)

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

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

Объединить значения заданного ключа в строку.

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

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

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

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

bool isEmpty()

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

bool isNotEmpty()

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

bool useAsCallable(mixed $value)

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

string join(string $glue, string $finalGlue = '')

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

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

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

смешанный last(callable $callback = null, mixed $default = null)

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

Коллекция pluck(string|array $value, string|null $key = null)

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

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

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

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

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

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

Применить функцию-преобразователь для создания словаря из элементов.

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

Применить функцию-преобразователь для группировки элементов.

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

Применить функцию-преобразователь для создания ассоциативного массива из элементов.

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

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

Коллекция mapInto(string $class)

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

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

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

Collection merge(mixed $items)

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

Collection mergeRecursive(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(iterable $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 = true)

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

Collection replace(mixed $items)

Заменить элементы коллекции на заданные элементы.

Collection replaceRecursive(mixed $items)

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

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)

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

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

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

callable valueRetriever(callable|string|null $value)

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

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

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

Коллекция pad(int $size, mixed $value)

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

массив toArray()

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

массив jsonSerialize()

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

строка toJson(int $options = 0)

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

ArrayIterator getIterator()

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

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

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

целое count()

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

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

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

$this add(mixed $item)

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

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

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

логическое offsetExists(mixed $key)

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

смешанное offsetGet(mixed $key)

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

void offsetSet(mixed $key, mixed $value)

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

void offsetUnset(string $key)

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

строка __toString()

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

массив getArrayableItems(mixed $items)

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

static void proxy(string $method)

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

смешанное __get(string $key)

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

Подробности

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

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

Параметры

строка $name
объект|callable $macro

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

void

static void mixin(object $mixin, bool $replace = true)

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

Параметры

объект $mixin
логическое $replace

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

void

Исключения

ReflectionException

static логическое hasMacro(string $name)

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

Параметры

строка $name

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

логическое

static смешанное __callStatic(string $method, array $parameters)

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

Параметры

строка $method
массив $parameters

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

смешанное

Исключения

BadMethodCallException

смешанное __call(string $method, array $parameters)

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

Параметры

строка $method
массив $parameters

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

смешанное

Исключения

BadMethodCallException

void __construct(mixed $items = [])

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

Параметры

смешанное $items

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

void

static Коллекция make(mixed $items = [])

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

Параметры

смешанное $items

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

Коллекция

static Коллекция wrap(mixed $value)

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

Параметры

смешанное $value

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

Коллекция

static массив unwrap(array|Коллекция $value)

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

Параметры

массив|Коллекция $value

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

массив

static Коллекция times(int $number, callable $callback = null)

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

Параметры

целое $number
callable $callback

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

Коллекция
END_OF_DOCUMENT_MARKER

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(string|array|null $key = null)

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

Параметры

string|array|null $key

Значение возврата

mixed

array|null mode(string|array|null $key = null)

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

Параметры

string|array|null $key

Значение возврата

array|null

Collection collapse()

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

Значение возврата

Collection

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

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

Параметры

mixed $key
mixed $operator
mixed $value

Значение возврата

bool

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(mixed ...$args)

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

Параметры

mixed ...$args

Значение возврата

void

$this dump()

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

Значение возврата

$this

Collection diff(mixed $items)

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

Параметры

mixed $items

Значение возврата

Collection

Collection diffUsing(mixed $items, callable $callback)

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

Параметры

mixed $items
callable $callback

Значение возврата

Collection

Collection diffAssoc(mixed $items)

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

Параметры

mixed $items

Значение возврата

Collection

Collection diffAssocUsing(mixed $items, callable $callback)

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

Параметры

mixed $items
callable $callback

Значение возврата

Collection

Collection diffKeys(mixed $items)

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

Параметры

mixed $items

Значение возврата

Collection

Collection diffKeysUsing(mixed $items, callable $callback)

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

Параметры

mixed $items
callable $callback

Значение возврата

Collection

Collection duplicates(callable|null $callback = null, bool $strict = false)

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

Параметры

callable|null $callback
bool $strict

Значение возврата

Collection

Collection duplicatesStrict(callable|null $callback = null)

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

Параметры

callable|null $callback

Значение возврата

Collection
END_OF_DOCUMENT_MARKER

protected Closure duplicateComparator(bool $strict)

Получить функцию сравнения для обнаружения дубликатов.

Параметры

bool $strict

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

Closure

$this each(callable $callback)

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

Параметры

callable $callback

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

$this

Collection eachSpread(callable $callback)

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

Параметры

callable $callback

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

Collection

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

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

Параметры

string|callable $key
mixed $operator
mixed $value

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

bool

Collection except(Collection|mixed $keys)

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

Параметры

Collection|mixed $keys

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

Collection

Collection filter(callable $callback = null)

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

Параметры

callable $callback

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

Collection

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

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

Параметры

bool $value
callable $callback
callable $default

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

Collection|mixed

Collection|mixed whenEmpty(callable $callback, callable $default = null)

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

Параметры

callable $callback
callable $default

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

Collection|mixed

Collection|mixed whenNotEmpty(callable $callback, callable $default = null)

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

Параметры

callable $callback
callable $default

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

Collection|mixed

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

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

Параметры

bool $value
callable $callback
callable $default

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

Collection|mixed

Collection|mixed unlessEmpty(callable $callback, callable $default = null)

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

Параметры

callable $callback
callable $default

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

Collection|mixed

Collection|mixed unlessNotEmpty(callable $callback, callable $default = null)

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

Параметры

callable $callback
callable $default

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

Collection|mixed

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

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

Параметры

string $key
mixed $operator
mixed $value

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

Collection

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

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

Параметры

string $key
string $operator
mixed $value

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

Closure

Collection whereStrict(string $key, mixed $value)

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

Параметры

string $key
mixed $value

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

Collection

Collection whereIn(string $key, mixed $values, bool $strict = false)

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

Параметры

string $key
mixed $values
bool $strict

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

Collection
END_OF_DOCUMENT_MARKER

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

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

Параметры

string $key
mixed $values

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

Коллекция

Коллекция whereBetween(string $key, array $values)

Фильтрует элементы таким образом, что значение заданного ключа находится между заданными значениями.

Параметры

string $key
array $values

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

Коллекция

Коллекция whereNotBetween(string $key, array $values)

Фильтрует элементы так, что значение заданного ключа не находится между заданными значениями.

Параметры

string $key
array $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

mixed firstWhere(string $key, mixed $operator = null, mixed $value = null)

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

Параметры

string $key
mixed $operator
mixed $value

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

mixed

Коллекция 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(array|callable|string $groupBy, bool $preserveKeys = false)

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

Параметры

array|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

string join(string $glue, string $finalGlue = '')

Объединить все элементы коллекции с использованием строки. Для последних элементов можно использовать отдельную строку склеивания.

Параметры

string $glue
string $finalGlue

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

string

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 mergeRecursive(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

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

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

Параметры

callable|string $key
mixed $operator
mixed $value

Значение результата

Collection

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

Collection concat(iterable $source)

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

Параметры

iterable $source

Значение результата

Collection

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

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

Параметры

mixed $key
mixed $default

Значение результата

mixed

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

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

Параметры

mixed $key
mixed $value

Значение результата

$this

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

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

Параметры

int|null $number

Значение результата

Collection|mixed

Исключения

InvalidArgumentException

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

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

Параметры

callable $callback
mixed $initial

Значение результата

mixed

Collection reject(callable|mixed $callback = true)

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

Параметры

callable|mixed $callback

Значение результата

Collection

Collection replace(mixed $items)

Заменить элементы набора заданными элементами.

Параметры

mixed $items

Значение результата

Collection

Collection replaceRecursive(mixed $items)

Рекурсивно заменить элементы набора заданными элементами.

Параметры

mixed $items

Значение результата

Collection

Collection reverse()

Перевернуть порядок элементов.

Значение результата

Collection

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

Искать в наборе заданное значение и вернуть соответствующий ключ, если поиск успешен.

Параметры

mixed $value
bool $strict

Значение результата

mixed

mixed shift()

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

Значение результата

mixed

Collection shuffle(int $seed = null)

Перемешать элементы в наборе.

Параметры

int $seed

Значение результата

Collection

Коллекция 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

Значение возврата

Коллекция

Коллекция sortBy(callable|string $callback, int $options = SORT_REGULAR, bool $descending = false)

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

Параметры

callable|string $callback
int $options
bool $descending

Значение возврата

Коллекция

Коллекция sortByDesc(callable|string $callback, int $options = SORT_REGULAR)

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

Параметры

callable|string $callback
int $options

Значение возврата

Коллекция

Коллекция sortKeys(int $options = SORT_REGULAR, bool $descending = false)

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

Параметры

int $options
bool $descending

Значение возврата

Коллекция

Коллекция sortKeysDesc(int $options = SORT_REGULAR)

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

Параметры

int $options

Значение возврата

Коллекция

Коллекция splice(int $offset, int|null $length = null, mixed $replacement = [])

Вставить часть базового массива коллекции.

Параметры

int $offset
int|null $length
mixed $replacement

Значение возврата

Коллекция

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

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

Параметры

callable|string|null $callback

Значение возврата

mixed

Коллекция take(int $limit)

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

Параметры

int $limit

Значение возврата

Коллекция

$this tap(callable $callback)

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

Параметры

callable $callback

Значение возврата

$this

$this transform(callable $callback)

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

Параметры

callable $callback

Значение возврата

$this

Коллекция unique(string|callable|null $key = null, bool $strict = false)

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

Параметры

string|callable|null $key
bool $strict

Значение возврата

Коллекция

Коллекция uniqueStrict(string|callable|null $key = null)

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

Параметры

string|callable|null $key

Значение возврата

Коллекция

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

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

Значение возврата

Коллекция

protected callable valueRetriever(callable|string|null $value)

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

Параметры

callable|string|null $value

Значение возврата

callable

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

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

e.g. new Collection([1, 2, 3])->zip([4, 5, 6]); => [[1, 4], [2, 5], [3, 6]]

Параметры

mixed $items

Значение возврата

Коллекция

Коллекция pad(int $size, mixed $value)

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

Параметры

int $size
mixed $value

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

Коллекция

массив toArray()

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

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

массив

массив jsonSerialize()

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

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

массив

строка toJson(int $options = 0)

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

Параметры

int $options

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

строка

ArrayIterator getIterator()

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

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

ArrayIterator

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

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

Параметры

int $flags

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

CachingIterator

целое число count()

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

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

целое число

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

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

Параметры

callable|null $callback

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

Коллекция

$this add(mixed $item)

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

Параметры

mixed $item

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

$this

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

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

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

Коллекция

логическое значение offsetExists(mixed $key)

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

Параметры

mixed $key

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

логическое значение

смешанный тип offsetGet(mixed $key)

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

Параметры

mixed $key

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

смешанный тип

пустое значение offsetSet(mixed $key, mixed $value)

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

Параметры

mixed $key
mixed $value

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

пустое значение

пустое значение offsetUnset(string $key)

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

Параметры

string $key

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

пустое значение

строка __toString()

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

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

строка

защищённый массив getArrayableItems(mixed $items)

Получить массив элементов из коллекции или объекта Arrayable.

Параметры

mixed $items

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

массив

статический пустое значение proxy(string $method)

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

Параметры

string $method

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

пустое значение

смешанный тип __get(string $key)

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

Параметры

string $key

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

смешанный тип

Исключения

Исключение

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

Spec-Zone.ru

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