Spec-Zone.ru › Laravel 5.8

Коллекция

класс 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, bool $replace = true)

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

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

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

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

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

from Collection
Collection collapse()

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

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

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

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

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

from Collection
$this dump()

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

from Collection
Collection diff(mixed $items)

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

Collection diffUsing(mixed $items, callable $callback)

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

from Collection
Collection diffAssoc(mixed $items)

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

from Collection
Collection diffAssocUsing(mixed $items, callable $callback)

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

from Collection
Collection diffKeys(mixed $items)

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

from Collection
Collection diffKeysUsing(mixed $items, callable $callback)

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

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

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

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

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

из Коллекции
Closure duplicateComparator(bool $strict)

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

$this each(callable $callback)

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

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

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

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

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

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

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

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

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

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

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

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

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

из Коллекции
Коллекция|смешанный тип 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)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

из Коллекции
Коллекция concat(iterable $source)

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

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

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

из Коллекции
$this put(mixed $key, mixed $value)

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

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

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

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

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

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

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

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

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

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

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

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

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

из Коллекции
mixed search(mixed $value, bool $strict = false)

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

из Коллекции
mixed shift()

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

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

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

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

Разделить массив коллекции.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Разделить массив коллекции.

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

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

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

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

из Коллекции
$this tap(callable $callback)

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

из Коллекции
$this transform(callable $callback)

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

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

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

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

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

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

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

из Коллекции
callable valueRetriever(callable|string|null $value)

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

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

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

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

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

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

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

из Коллекции
$this add(mixed $item)

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

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

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

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

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

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

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

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

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

$this load(array|string $relations)

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

$this loadCount(array|string $relations)

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

$this loadMissing(array|string $relations)

Загрузить набор отношений в коллекцию, если они еще не загружены с помощью eager loading.

void loadMissingRelation(Коллекция $models, array $path)

Загрузить путь к отношению, если он еще не загружен с помощью eager loading.

$this loadMorph(string $relation, array $relations)

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

массив modelKeys()

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

Коллекция fresh(массив|строка $with = [])

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

$this makeHidden(массив|строка $attributes)

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

$this makeVisible(массив|строка $attributes)

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

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

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

строка|null getQueueableClass()

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

массив getQueueableIds()

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

массив getQueueableRelations()

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

строка|null getQueueableConnection()

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

Подробности

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

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

Параметры

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

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

void

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

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

Параметры

объект $mixin
булево $replace

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

void

Исключения

ReflectionException

static bool hasMacro(string $name)

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

Параметры

строка $name

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

bool

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

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

Параметры

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

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

массив

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

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

Параметры

целое $number
вызываемый $callback

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

Коллекция

массив all()

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

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

массив

смешанное avg(callable|string|null $callback = null)

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

Параметры

callable|строка|null $callback

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

смешанное

смешанное average(callable|string|null $callback = null)

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

Параметры

callable|строка|null $callback

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

смешанное

смешанное median(строка|массив|null $key = null)

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

Параметры

строка|массив|null $key

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

смешанное

массив|null mode(строка|массив|null $key = null)

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

Параметры

строка|массив|null $key

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

массив|null
END_OF_DOCUMENT_MARKER

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

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

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

Коллекция

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

Коллекция crossJoin(mixed ...$lists)

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

Параметры

mixed ...$lists

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

Коллекция

void dd(mixed ...$args)

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

Параметры

mixed ...$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

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

Коллекция

Коллекция duplicates(callable|null $callback = null, bool $strict = false)

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

Параметры

callable|null $callback
bool $strict

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

Коллекция

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

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

Параметры

callable|null $callback

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

Коллекция

protected Закрытие duplicateComparator(bool $strict)

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

Параметры

bool $strict

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

Закрытие

$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

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

Collection whereInStrict(string $key, mixed $values)

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

Параметры

string $key
mixed $values

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

Collection

Collection whereBetween(string $key, array $values)

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

Параметры

string $key
array $values

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

Collection
END_OF_DOCUMENT_MARKER

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

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

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

Коллекция

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

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

Коллекция

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

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

Параметры

int $step
int $offset

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

Коллекция

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

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

Параметры

mixed $keys

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

Коллекция

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

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

Параметры

int $page
int $perPage

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

Коллекция

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

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

Параметры

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

Исключения

ИсключениеНеверногоАргумента

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

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

Параметры

callable $callback
mixed $initial

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

mixed

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

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

Параметры

callable|mixed $callback

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

Коллекция

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

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

Параметры

mixed $items

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

Коллекция

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

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

Параметры

mixed $items

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

Коллекция

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

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

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

Коллекция

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

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

Параметры

mixed $value
bool $strict

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

mixed

mixed shift()

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

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

mixed

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

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

Параметры

int $seed

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

Коллекция

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

Вырезать фрагмент из базового массива коллекции.

Parameters

int $offset
int $length

Return Value

Collection

Collection split(int $numberOfGroups)

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

Parameters

int $numberOfGroups

Return Value

Collection

Collection chunk(int $size)

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

Parameters

int $size

Return Value

Collection

Collection sort(callable $callback = null)

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

Parameters

callable $callback

Return Value

Collection

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

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

Parameters

callable|string $callback
int $options
bool $descending

Return Value

Collection

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

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

Parameters

callable|string $callback
int $options

Return Value

Collection

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

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

Parameters

int $options
bool $descending

Return Value

Collection

Collection sortKeysDesc(int $options = SORT_REGULAR)

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

Parameters

int $options

Return Value

Collection

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

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

Parameters

int $offset
int|null $length
mixed $replacement

Return Value

Collection

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

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

Parameters

callable|string|null $callback

Return Value

mixed

Collection take(int $limit)

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

Parameters

int $limit

Return Value

Collection

$this tap(callable $callback)

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

Parameters

callable $callback

Return Value

$this

$this transform(callable $callback)

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

Parameters

callable $callback

Return Value

$this

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

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

Parameters

string|callable|null $key
bool $strict

Return Value

Collection

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

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

Parameters

string|callable|null $key

Return Value

Collection

Collection values()

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

Return Value

Collection

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

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

Parameters

callable|string|null $value

Return Value

callable

Collection zip(mixed $items)

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

Parameters

mixed $items

Return Value

Collection

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

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

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

Исключения

Исключение

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

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

Параметры

mixed $key
mixed $default

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

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

$this load(array|string $relations)

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

Параметры

array|string $relations

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

$this

$this loadCount(array|string $relations)

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

Параметры

array|string $relations

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

$this

$this loadMissing(array|string $relations)

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

Параметры

array|string $relations

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

$this

protected void loadMissingRelation(Collection $models, array $path)

Загрузить путь к отношению, если он еще не загружен с помощью eager loading.

Parameters

Collection $models
array $path

Return Value

void

$this loadMorph(string $relation, array $relations)

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

Parameters

string $relation
array $relations

Return Value

$this

array modelKeys()

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

Return Value

array

Collection fresh(array|string $with = [])

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

Parameters

array|string $with

Return Value

Collection

$this makeHidden(array|string $attributes)

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

Parameters

array|string $attributes

Return Value

$this

$this makeVisible(array|string $attributes)

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

Parameters

array|string $attributes

Return Value

$this

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

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

Parameters

ArrayAccess|array|null $items

Return Value

array

string|null getQueueableClass()

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

Return Value

string|null

Exceptions

LogicException

array getQueueableIds()

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

Return Value

array

array getQueueableRelations()

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

Return Value

array

string|null getQueueableConnection()

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

Return Value

string|null

Exceptions

LogicException

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

Spec-Zone.ru

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