Spec-Zone.ru › Laravel 5.5

Коллекция

класс Collection расширяет Collection и реализует QueueableCollection (Просмотреть исходный код)

Трейты

Macroable

Свойства

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

Методы

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

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

from Collection
static Collection make(mixed $items = [])

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

from Collection
static Collection wrap(mixed $value)

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

from Collection
static array unwrap(array|Collection $value)

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

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

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

from Collection
array all()

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

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

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

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

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

from Collection
mixed median(null $key = null)

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

from Collection
array|null mode(mixed $key = null)

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

from Collection
Collection collapse()

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

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

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

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

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

from Collection
Collection crossJoin(mixed $lists)

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

from Collection
void dd()

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

from Collection
$this dump()

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

from Collection
Collection diff(mixed $items)

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

Collection diffAssoc(mixed $items)

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

from Collection
Collection diffKeys(mixed $items)

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

from Collection
$this each(callable $callback)

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

from Collection
Collection eachSpread(callable $callback)

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

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

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

from Collection
Collection except(mixed $keys)

Возвращает все модели в коллекции, кроме моделей со специфицированными ключами.

Collection filter(callable $callback = null)

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

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

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

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

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

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

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

из Коллекции
Closure operatorForWhere(string $key, string $operator, mixed $value)

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

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

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

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

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

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

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

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

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

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

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

из Коллекции
mixed first(callable $callback = null, mixed $default = null)

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

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

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

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

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

$this forget(string|array $keys)

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

из Коллекции
mixed get(mixed $key, mixed $default = null)

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

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

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

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

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

из Коллекции
bool has(mixed $key)

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

из Коллекции
string implode(string $value, string $glue = null)

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

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

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

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

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

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

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

из Коллекции
mixed max(callable|string|null $callback = null)

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

из Collection
Collection merge(mixed $items)

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

Collection combine(mixed $values)

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

из Collection
Collection union(mixed $items)

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

из Collection
mixed min(callable|string|null $callback = null)

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

из Collection
Collection nth(int $step, int $offset)

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

из Collection
Collection only(mixed $keys)

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

Collection forPage(int $page, int $perPage)

Разбить коллекцию на страницы (срез).

из Collection
Collection partition(callable|string $callback)

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

из Collection
mixed pipe(callable $callback)

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

из Collection
mixed pop()

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

из Collection
$this prepend(mixed $value, mixed $key = null)

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

из Collection
$this push(mixed $value)

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

из Collection
$this concat(Traversable $source)

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

из Collection
mixed pull(mixed $key, mixed $default = null)

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

из Collection
$this put(mixed $key, mixed $value)

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

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

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

из Collection
mixed reduce(callable $callback, mixed $initial = null)

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

из Collection
Collection reject(callable|mixed $callback)

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

из Collection
Collection reverse()

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

из Collection
mixed search(mixed $value, bool $strict = false)

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

из Collection
mixed shift()

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

из Collection
Collection shuffle(int $seed = null)

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

из Collection
Collection slice(int $offset, int $length = null)

Выделить часть массива коллекции.

из Collection
Collection split(int $numberOfGroups)

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

из Collection
Collection chunk(int $size)

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

из Collection
Collection sort(callable $callback = null)

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

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

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

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

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

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

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

из Коллекция
mixed sum(callable|string|null $callback = null)

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

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

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

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

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

массив 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.

из Коллекция
static void proxy(string $method)

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

из Коллекция
mixed __get(string $key)

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

из Коллекция
Модель|Коллекция find(mixed $key, mixed $default = null)

Найти модель в коллекции по ключу.

$this load(mixed $relations)

Загрузить набор отношений в коллекцию.

$this add(mixed $item)

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

массив modelKeys()

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

Коллекция fresh(array|string $with = [])

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

$this makeHidden(array|string $attributes)

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

$this makeVisible(array|string $attributes)

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

массив getDictionary(ArrayAccess|array|null $items = null)

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

строка|null getQueueableClass()

Получить тип сущностей, которые находятся в очереди.

массив getQueueableIds()

Получить идентификаторы всех сущностей.

строка|null getQueueableConnection()

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

Подробности

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

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

Параметры

строка $name
объект|вызываемый $macro

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

void

static void mixin(object $mixin)

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

Параметры

объект $mixin

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

void

static bool hasMacro(string $name)

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

Параметры

строка $name

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

bool

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

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

Параметры

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

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

mixed

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Параметры

строка $method
массив $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)

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

Параметры

массив|Collection $value

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

массив

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

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

Параметры

int $number
вызываемый $callback

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

Collection

массив all()

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

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

массив

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

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

Параметры

вызываемый|строка|null $callback

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

mixed

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

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

Параметры

вызываемый|строка|null $callback

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

mixed

mixed median(null $key = null)

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

Параметры

null $key

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

mixed

массив|null mode(mixed $key = null)

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

Параметры

mixed $key

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

массив|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
END_OF_DOCUMENT_MARKER

void dd()

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

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

void

$this dump()

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

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

$this

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

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

Параметры

mixed $items

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

Коллекция

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

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

Параметры

mixed $items

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

Коллекция

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

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

Параметры

mixed $items

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

Коллекция

$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, mixed $value = null)

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

Параметры

string $key
mixed $operator
mixed $value

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

Коллекция

protected Закрытие operatorForWhere(string $key, string $operator, mixed $value)

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

Параметры

string $key
string $operator
mixed $value

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

Закрытие

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

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

Параметры

string $key
mixed $value

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

Коллекция

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

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

Коллекция
END_OF_DOCUMENT_MARKER

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

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

Параметры

string $key
mixed $values

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

Коллекция

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

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

Параметры

callable $callback
mixed $default

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

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

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

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

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

Коллекция

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

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

Параметры

callable $callback
mixed $default

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

mixed

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

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

Параметры

string|array $value
string|null $key

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

Коллекция

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

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

Параметры

callable $callback

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

Коллекция

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

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

Параметры

callable $callback

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

Коллекция

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

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

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

Параметры

callable $callback

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

Коллекция

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

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

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

Параметры

callable $callback

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

Коллекция

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

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

Параметры

callable $callback

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

Коллекция

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

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

Параметры

string $class

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

Коллекция

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

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

Параметры

callable|string|null $callback

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

mixed

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

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

Параметры

mixed $items

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

Коллекция

Коллекция combine(mixed $values)

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

Параметры

mixed $values

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

Коллекция

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

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

Параметры

mixed $items

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

Коллекция

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

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

Параметры

callable|string|null $callback

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

mixed

Коллекция nth(int $step, int $offset)

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

Параметры

int $step
int $offset

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

Коллекция

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

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

Параметры

mixed $keys

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

Коллекция

Коллекция forPage(int $page, int $perPage)

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

Параметры

int $page
int $perPage

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

Коллекция

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

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

Параметры

callable|string $callback

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

Коллекция

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

$this concat(Traversable $source)

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

Параметры

Traversable $source

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

$this

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

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

Параметры

mixed $key
mixed $default

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

mixed
END_OF_DOCUMENT_MARKER

$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

Collection reject(callable|mixed $callback)

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

Параметры

callable|mixed $callback

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

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

Collection slice(int $offset, int $length = null)

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

Параметры

int $offset
int $length

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

Collection

Collection split(int $numberOfGroups)

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

Параметры

int $numberOfGroups

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

Collection

Collection chunk(int $size)

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

Параметры

int $size

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

Collection

Collection sort(callable $callback = null)

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

Параметры

callable $callback

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

Collection

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

Коллекция 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(string $value)

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

Параметры

string $value

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

callable

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

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

Параметры

mixed $items

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

Коллекция

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

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

Параметры

int $size
mixed $value

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

Коллекция

массив toArray()

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

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

массив

массив jsonSerialize()

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

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

массив

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

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

Параметры

int $options

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

строка

ArrayIterator getIterator()

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

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

ArrayIterator

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

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

Параметры

int $flags

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

CachingIterator

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

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

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

целое число

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

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

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

строка

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

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

Параметры

mixed $items

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

массив

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

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

Параметры

string $method

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

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

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

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

Параметры

string $key

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

смешанное значение

Исключения

Исключение

Модель|Коллекция find(mixed $key, mixed $default = null)

Найти модель в коллекции по ключу.

Параметры

mixed $key
mixed $default

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

Модель|Коллекция
END_OF_DOCUMENT_MARKER

$this load(mixed $relations)

Загрузить набор отношений в коллекцию.

Параметры

mixed $relations

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

$this

$this add(mixed $item)

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

Параметры

mixed $item

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

$this

array modelKeys()

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

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

array

Коллекция fresh(array|string $with = [])

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

Параметры

array|string $with

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

Коллекция

$this makeHidden(array|string $attributes)

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

Параметры

array|string $attributes

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

$this

$this makeVisible(array|string $attributes)

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

Параметры

array|string $attributes

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

$this

array getDictionary(ArrayAccess|array|null $items = null)

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

Параметры

ArrayAccess|array|null $items

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

array

string|null getQueueableClass()

Получить тип сущностей, которые находятся в очереди.

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

string|null

Исключения

LogicException

array getQueueableIds()

Получить идентификаторы всех сущностей.

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

array

string|null getQueueableConnection()

Получить соединение сущностей, находящихся в очереди.

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

string|null

Исключения

LogicException

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

Spec-Zone.ru

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