Spec-Zone.ru › Laravel 5.4

Коллекция

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

Трейты

Macroable

Свойства

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

Методы

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

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

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

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

from Collection
Closure operatorForWhere(string $key, string $operator, mixed $value)

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

from Collection
Collection whereStrict(string $key, mixed $value)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

из Коллекции
mixed pipe(callable $callback)

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

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

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

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

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

из Коллекции
$this push(mixed $value)

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

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

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

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

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

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

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

массив toArray()

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

из Коллекции
массив jsonSerialize()

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

из Коллекции
строка toJson(int $options)

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

из Коллекции
ArrayIterator getIterator()

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

из Коллекции
CachingIterator getCachingIterator(int $flags = CachingIterator::CALL_TOSTRING)

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

из Коллекции
целое count()

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

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

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

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

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

из Коллекции
смешанный offsetGet(mixed $key)

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

из Коллекции
void offsetSet(mixed $key, mixed $value)

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

из Коллекции
void offsetUnset(string $key)

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

из Коллекции
строка __toString()

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

из Коллекции
массив getArrayableItems(mixed $items)

Возвращает массив элементов из коллекции или объекта, реализующего интерфейс Arrayable.

из Коллекции
статический void proxy(string $method)

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

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

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

Подробности

статический void macro(string $name, callable $macro)

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

Параметры

строка $name
callable $macro

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

void

статический логическое hasMacro(string $name)

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

Параметры

строка $name

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

логическое

статический смешанный __callStatic(string $method, array $parameters)

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

Параметры

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

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

смешанный

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

void __construct(mixed $items = [])

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

Параметры

mixed $items

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

void

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

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

Параметры

mixed $items

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

Коллекция

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

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

Параметры

int $number
callable $callback

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

Коллекция

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

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

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

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

Коллекция

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

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

Коллекция

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

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

Коллекция

Collection filter(callable $callback = null)

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

Параметры

callable $callback

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

Collection

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

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

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

Параметры

string $key
mixed $operator
mixed $value

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

Collection

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

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

Параметры

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 whereNotIn(string $key, mixed $values, bool $strict = false)

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

Параметры

string $key
mixed $values
bool $strict

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

Collection

Collection whereNotInStrict(string $key, mixed $values)

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

Параметры

string $key
mixed $values

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

Collection

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

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

Параметры

callable $callback
mixed $default

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

mixed

Collection flatten(int $depth = INF)

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

Параметры

int $depth

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

Collection

Collection flip()

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

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

Collection

$this forget(string|array $keys)

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

Параметры

string|array $keys

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

$this

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

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

Параметры

mixed $key
mixed $default

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

mixed

Collection groupBy(callable|string $groupBy, bool $preserveKeys = false)

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

Параметры

callable|string $groupBy
bool $preserveKeys

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

Collection

Collection keyBy(callable|string $keyBy)

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

Параметры

callable|string $keyBy

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

Collection

bool has(mixed $key)

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

Параметры

mixed $key

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

bool

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

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

Parameters

string $value
string $glue

Return Value

string

Collection intersect(mixed $items)

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

Parameters

mixed $items

Return Value

Collection

Collection intersectKey(mixed $items)

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

Parameters

mixed $items

Return Value

Collection

bool isEmpty()

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

Return Value

bool

bool isNotEmpty()

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

Return Value

bool

protected bool useAsCallable(mixed $value)

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

Parameters

mixed $value

Return Value

bool

Collection keys()

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

Return Value

Collection

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

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

Parameters

callable $callback
mixed $default

Return Value

mixed

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

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

Parameters

string|array $value
string|null $key

Return Value

Collection

Collection map(callable $callback)

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

Parameters

callable $callback

Return Value

Collection

Collection mapSpread(callable $callback)

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

Parameters

callable $callback

Return Value

Collection

Collection mapToGroups(callable $callback)

Применить группирующую функцию к элементам.

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

Parameters

callable $callback

Return Value

Collection

Collection mapWithKeys(callable $callback)

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

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

Parameters

callable $callback

Return Value

Collection

Collection flatMap(callable $callback)

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

Parameters

callable $callback

Return Value

Collection

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

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

Parameters

callable|string|null $callback

Return Value

mixed

Collection merge(mixed $items)

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

Parameters

mixed $items

Return Value

Collection

Collection combine(mixed $values)

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

Parameters

mixed $values

Return Value

Collection

Collection union(mixed $items)

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

Parameters

mixed $items

Return Value

Collection

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

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

Parameters

callable|string|null $callback

Return Value

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

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

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

Параметры

Traversable $source

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

Коллекция

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

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

Параметры

mixed $key
mixed $default

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

mixed

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

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

Параметры

mixed $key
mixed $value

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

$this

mixed random(int|null $number = null)

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

Параметры

int|null $number

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

mixed

Исключения

InvalidArgumentException

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

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

Параметры

callable $callback
mixed $initial

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

mixed

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

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

Параметры

callable|mixed $callback

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

Коллекция

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

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

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

Коллекция

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

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

Параметры

mixed $value
bool $strict

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

mixed

mixed shift()

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

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

mixed

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

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

Параметры

int $seed

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

Коллекция

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

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

Параметры

int $offset
int $length

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

Коллекция

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

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

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

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

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

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

Коллекция

bool offsetExists(mixed $key)

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

Параметры

mixed $key

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

bool

mixed offsetGet(mixed $key)

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

Параметры

mixed $key

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

mixed

void offsetSet(mixed $key, mixed $value)

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

Параметры

mixed $key
mixed $value

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

void

void offsetUnset(string $key)

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

Параметры

string $key

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

void

string __toString()

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

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

string

protected array getArrayableItems(mixed $items)

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

Параметры

mixed $items

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

array

static void proxy(string $method)

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

Параметры

string $method

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

void

mixed __get(string $key)

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

Параметры

string $key

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

mixed

Исключения

Исключение

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

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

Параметры

mixed $key
mixed $default

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

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

$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

array getQueueableIds()

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

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

array

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

Spec-Zone.ru

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