Spec-Zone.ru › Laravel 5.6

Коллекция

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

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

Коллекция filter(вызываемый тип $callback = null)

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

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

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

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

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

из Коллекции
Коллекция where(строка $key, смешанный тип $operator, смешанный тип $value = null)

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

из Коллекции
Closure operatorForWhere(строка $key, строка $operator, смешанный тип $value = null)

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

из Коллекции
Коллекция whereStrict(строка $key, смешанный тип $value)

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

из Коллекции
Коллекция whereIn(строка $key, смешанный тип $values, булево $strict = false)

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

из Коллекции
Коллекция whereInStrict(строка $key, смешанный тип $values)

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

из Коллекции
Коллекция whereNotIn(строка $key, смешанный тип $values, булево $strict = false)

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

из Коллекции
Коллекция whereNotInStrict(строка $key, смешанный тип $values)

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

из Коллекции
Коллекция whereInstanceOf(строка $type)

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

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

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

из Коллекции
Коллекция firstWhere(строка $key, смешанный тип $operator, смешанный тип $value = null)

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

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

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

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

Меняет местами ключи и значения в коллекции.

$this forget(строка|массив $keys)

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

из Коллекции
смешанный тип get(смешанный тип $key, смешанный тип $default = null)

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

из Коллекции
Коллекция groupBy(вызываемый тип|строка $groupBy, булево $preserveKeys = false)

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

из Коллекции
Коллекция keyBy(вызываемый тип|строка $keyBy)

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

из Коллекции
булево has(смешанный тип $key)

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

из Коллекции
строка implode(строка $value, строка $glue = null)

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

из Коллекции
Коллекция intersect(смешанный тип $items)

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

Коллекция intersectByKeys(смешанный тип $items)

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

из Коллекции
булево isEmpty()

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

из Коллекции
булево isNotEmpty()

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

из Коллекции
булево useAsCallable(смешанный тип $value)

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

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

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

смешанный тип last(вызываемый тип $callback = null, смешанный тип $default = null)

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

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

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

Collection map(callable $callback)

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

Collection mapSpread(callable $callback)

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

from Collection
Collection mapToDictionary(callable $callback)

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

from Collection
Collection mapToGroups(callable $callback)

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

from Collection
Collection mapWithKeys(callable $callback)

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

from Collection
Collection flatMap(callable $callback)

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

from Collection
Collection mapInto(string $class)

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

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

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

from Collection
Collection merge(mixed $items)

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

Collection combine(mixed $values)

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

from Collection
Collection union(mixed $items)

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

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

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

from Collection
Collection nth(int $step, int $offset)

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

from Collection
Collection only(mixed $keys)

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

Collection forPage(int $page, int $perPage)

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

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

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

from Collection
mixed pipe(callable $callback)

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

from Collection
mixed pop()

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

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

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

from Collection
$this push(mixed $value)

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

from Collection
Collection concat(Traversable|array $source)

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

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

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

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

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

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

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

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

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

from Collection
Collection reject(callable|mixed $callback)

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

from Collection
Collection reverse()

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

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

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

from Collection
смешанный 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
Collection sortKeys(int $options = SORT_REGULAR, bool $descending = false)

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

из Collection
Collection sortKeysDesc(int $options = SORT_REGULAR)

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

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

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

из Collection
смешанный sum(callable|string|null $callback = null)

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

из Collection
Collection take(int $limit)

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

из Collection
$this tap(callable $callback)

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

из Collection
$this transform(callable $callback)

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

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

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

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

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

из Collection
Collection values()

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

из Collection
обратный вызов valueRetriever(string $value)

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

из Collection
Collection zip(mixed $items)

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

Collection pad(int $size, mixed $value)

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

массив toArray()

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

из Collection
массив jsonSerialize()

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

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

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

из Collection
ArrayIterator getIterator()

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

из Collection
CachingIterator getCachingIterator(int $flags = CachingIterator::CALL_TOSTRING)

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

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

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

из Collection
Collection toBase()

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

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

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

из Collection
смешанный offsetGet(mixed $key)

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

из Collection
void offsetSet(mixed $key, mixed $value)

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

из Collection
void offsetUnset(string $key)

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

из Collection
строка __toString()

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

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

Результат массива элементов из Collection или Arrayable.

из Collection
static void proxy(string $method)

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

из Collection
смешанный __get(string $key)

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

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

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

$this load(array|string $relations)

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

$this loadMissing(array|string $relations)

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

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

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

$this loadMorph(string $relation, array $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()

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

массив getQueueableRelations()

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

строка|null getQueueableConnection()

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

Подробности

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

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

Параметры

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

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

void

static void mixin(object $mixin)

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

Параметры

объект $mixin

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

void

Исключения

ReflectionException

static bool hasMacro(string $name)

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

Параметры

строка $name

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

bool

static mixed __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

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

Коллекция
END_OF_DOCUMENT_MARKER

static array unwrap(array|Collection $value)

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

Параметры

array|Collection $value

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

array

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

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

Параметры

int $number
callable $callback

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

Collection

array all()

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

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

array

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

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

Параметры

callable|string|null $callback

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

mixed

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

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

Параметры

callable|string|null $callback

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

mixed

mixed median(null $key = null)

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

Параметры

null $key

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

mixed

array|null mode(mixed $key = null)

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

Параметры

mixed $key

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

array|null

Collection collapse()

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

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

Collection

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

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

Параметры

mixed $key
mixed $operator
mixed $value

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

bool

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

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

Параметры

mixed $key
mixed $value

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

bool

Collection crossJoin(mixed $lists)

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

Параметры

mixed $lists

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

Collection

void dd($args)

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

Параметры

$args

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

void

$this dump()

Вывести набор.

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

$this

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

$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 Closure operatorForWhere(string $key, string $operator, mixed $value = null)

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

Параметры

string $key
string $operator
mixed $value

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

Closure

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

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

Коллекция

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

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

Параметры

string $key
mixed $values

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

Коллекция

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

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

Параметры

string $type

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

Коллекция

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

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

Параметры

callable $callback
mixed $default

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

mixed

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

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

Параметры

string $key
mixed $operator
mixed $value

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

Коллекция

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

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

Параметры

int $depth

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

Коллекция

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

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

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

Коллекция

$this forget(string|array $keys)

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

Параметры

string|array $keys

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

$this

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

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

Параметры

mixed $key
mixed $default

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

mixed

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

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

Параметры

callable|string $groupBy
bool $preserveKeys

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

Коллекция

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

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

Параметры

callable|string $keyBy

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

Коллекция

bool has(mixed $key)

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

Параметры

mixed $key

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

bool

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

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

Параметры

string $value
string $glue

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

string

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

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

Параметры

mixed $items

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

Коллекция

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

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

Параметры

mixed $items

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

Коллекция

bool isEmpty()

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

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

bool

bool isNotEmpty()

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

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

bool

protected bool useAsCallable(mixed $value)

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

Параметры

mixed $value

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

bool

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

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

Коллекция

Коллекция 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 $key, mixed $operator = null, mixed $value = null)

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

Параметры

callable|string $key
mixed $operator
mixed $value

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

Коллекция

mixed pipe(callable $callback)

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

Параметры

callable $callback

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

mixed

mixed pop()

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

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

mixed

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

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

Параметры

mixed $value
mixed $key

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

$this

$this push(mixed $value)

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

Параметры

mixed $value

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

$this

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

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

Параметры

Traversable|array $source

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

Коллекция

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

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

Параметры

mixed $key
mixed $default

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

mixed

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

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

Параметры

mixed $key
mixed $value

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

$this

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

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

Parameters

int|null $number

Return Value

Collection|mixed

Exceptions

InvalidArgumentException

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

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

Parameters

callable $callback
mixed $initial

Return Value

mixed

Collection reject(callable|mixed $callback)

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

Parameters

callable|mixed $callback

Return Value

Collection

Collection reverse()

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

Return Value

Collection

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

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

Parameters

mixed $value
bool $strict

Return Value

mixed

mixed shift()

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

Return Value

mixed

Collection shuffle(int $seed = null)

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

Parameters

int $seed

Return Value

Collection

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)

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

Параметры

callable $callback

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

$this

$this transform(callable $callback)

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

Параметры

callable $callback

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

$this

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

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

Параметры

string|callable|null $key
bool $strict

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

Collection

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

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

Параметры

string|callable|null $key

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

Collection

Collection values()

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

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

Collection

protected callable valueRetriever(string $value)

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

Параметры

string $value

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

callable

Collection zip(mixed $items)

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

Параметры

mixed $items

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

Collection

Collection pad(int $size, mixed $value)

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

Параметры

int $size
mixed $value

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

Collection

array toArray()

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

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

array

array jsonSerialize()

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

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

array

string toJson(int $options)

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

Параметры

int $options

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

string

ArrayIterator getIterator()

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

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

ArrayIterator

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

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

Параметры

int $flags

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

CachingIterator

int count()

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

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

int

Collection toBase()

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

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

Collection

bool offsetExists(mixed $key)

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

Параметры

mixed $key

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

bool

mixed offsetGet(mixed $key)

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

Параметры

mixed $key

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

mixed

void offsetSet(mixed $key, mixed $value)

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

Параметры

mixed $key
mixed $value

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

void

void offsetUnset(string $key)

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

Параметры

string $key

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

void

string __toString()

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

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

string

protected array getArrayableItems(mixed $items)

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

Параметры

mixed $items

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

array

static void proxy(string $method)

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

Параметры

string $method

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

void
END_OF_DOCUMENT_MARKER

смешанный __get(строка $key)

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

Параметры

строка $key

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

смешанный

Исключения

Исключение

Модель|Коллекция find(смешанный $key, смешанный $default = null)

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

Параметры

смешанный $key
смешанный $default

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

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

$this load(массив|строка $relations)

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

Параметры

массив|строка $relations

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

$this

$this loadMissing(массив|строка $relations)

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

Параметры

массив|строка $relations

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

$this

protected void loadMissingRelation(Коллекция $models, массив $path)

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

Параметры

Коллекция $models
массив $path

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

void

$this loadMorph(строка $relation, массив $relations)

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

Параметры

строка $relation
массив $relations

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

$this

$this add(смешанный $item)

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

Параметры

смешанный $item

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

$this

массив modelKeys()

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

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

массив

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

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

Параметры

массив|строка $with

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

Коллекция

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

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

Параметры

массив|строка $attributes

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

$this

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

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

Параметры

массив|строка $attributes

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

$this

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

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

Параметры

ArrayAccess|массив|null $items

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

массив

строка|null getQueueableClass()

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

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

строка|null

Исключения

LogicException

массив getQueueableIds()

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

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

массив

массив getQueueableRelations()

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

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

массив

строка|null getQueueableConnection()

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

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

строка|null

Исключения

LogicException

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

Spec-Zone.ru

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