ResourceCollection
class ResourceCollection extends JsonResource implements IteratorAggregate (View source)
Особенности
| CollectsResources |
| ConditionallyLoadsAttributes |
| DelegatesToResource |
| ForwardsCalls |
Свойства
| mixed | $resource | Экземпляр ресурса. | из JsonResource |
| array | $with | Дополнительные данные, которые должны быть добавлены в массив ресурса верхнего уровня. | из JsonResource |
| array | $additional | Дополнительные метаданные, которые должны быть добавлены в ответ ресурса. | из JsonResource |
| static string | $wrap | Обёртка "data", которая должна быть применена. | из JsonResource |
| string | $collects | Ресурс, который собирает данный ресурс. | |
| Collection | $collection | Экземпляр отображённого набора. |
Методы
| array | filter(array $data) Фильтровать предоставленные данные, удаляя любые необязательные значения. | из ConditionallyLoadsAttributes |
| array | mergeData(array $data, int $index, array $merge, bool $numericKeys) Объединить предоставленные данные в указанном индексе. | из ConditionallyLoadsAttributes |
| array | removeMissingValues(array $data, bool $numericKeys = false) Удалить отсутствующие значения из отфильтрованных данных. | из ConditionallyLoadsAttributes |
| MissingValue|mixed | when(bool $condition, mixed $value, mixed $default = null) Получить значение на основе заданного условия. | из ConditionallyLoadsAttributes |
| MergeValue|mixed | merge(mixed $value) Объединить значение в массив. | из ConditionallyLoadsAttributes |
| MergeValue|mixed | mergeWhen(bool $condition, mixed $value) Объединить значение на основе заданного условия. | из ConditionallyLoadsAttributes |
| MergeValue | attributes(array $attributes) Объединить заданные атрибуты. | из ConditionallyLoadsAttributes |
| MissingValue|mixed | whenLoaded(string $relationship, mixed $value = null, mixed $default = null) Получить отношение, если оно было загружено. | из ConditionallyLoadsAttributes |
| MissingValue|mixed | whenPivotLoaded(string $table, mixed $value, mixed $default = null) Выполнить обратный вызов, если указанная таблица связей была загружена. | из ConditionallyLoadsAttributes |
| MissingValue|mixed | whenPivotLoadedAs(string $accessor, string $table, mixed $value, mixed $default = null) Выполнить обратный вызов, если указанная таблица связей с пользовательским аксессором была загружена. | из ConditionallyLoadsAttributes |
| mixed | transform(mixed $value, callable $callback, mixed $default = null) Преобразовать заданное значение, если оно присутствует. | из ConditionallyLoadsAttributes |
| mixed | forwardCallTo(mixed $object, string $method, array $parameters) Перенаправить вызов метода заданному объекту. | из ForwardsCalls |
| static void | throwBadMethodCallException(string $method) Выбросить исключение плохого вызова метода для данного метода. | из ForwardsCalls |
| mixed | getRouteKey() Получить значение ключа маршрута ресурса. | из DelegatesToResource |
| string | getRouteKeyName() Получить ключ маршрута для ресурса. | из DelegatesToResource |
| void | resolveRouteBinding(mixed $value) Получить модель для связанного значения. | из DelegatesToResource |
| bool | offsetExists(mixed $offset) Определить, существует ли заданный атрибут. | из DelegatesToResource |
| mixed | offsetGet(mixed $offset) Получить значение для заданного смещения. | из DelegatesToResource |
| void | offsetSet(mixed $offset, mixed $value) Установить значение для заданного смещения. | из DelegatesToResource |
| void | offsetUnset(mixed $offset) Удалить значение для заданного смещения. | из DelegatesToResource |
| bool | __isset(string $key) Определить, существует ли атрибут в ресурсе. | из DelegatesToResource |
| void | __unset(string $key) Удалить атрибут из ресурса. | из DelegatesToResource |
| mixed | __get(string $key) Динамически получить свойства из базового ресурса. | из DelegatesToResource |
| mixed | __call(string $method, array $parameters) Динамически передавать вызовы методов базовому ресурсу. | из DelegatesToResource |
| void | __construct(mixed $resource) Создать новый экземпляр ресурса. | |
| static JsonResource | make(mixed ...$parameters) Создать новый экземпляр ресурса. | из JsonResource |
| static AnonymousResourceCollection | collection(mixed $resource) Создать новый анонимный ресурс-коллекцию. | из JsonResource |
| массив | resolve(Request|null $request = null) Преобразовать ресурс в массив. | из JsonResource |
| массив | toArray(Request $request) Преобразовать ресурс в JSON-массив. | |
| массив | with(Request $request) Получить дополнительные данные, которые должны быть возвращены вместе с ресурсом. | из JsonResource |
| $this | additional(array $data) Добавить дополнительные метаданные к ответу ресурса. | из JsonResource |
| void | withResponse(Request $request, JsonResponse $response) Настроить ответ для запроса. | из JsonResource |
| static void | wrap(string $value) Установить строку, которая должна обернуть внешний массив ресурсов. | из JsonResource |
| static void | withoutWrapping() Отключить обёртку внешнего массива ресурсов. | из JsonResource |
| JsonResponse | response(Request|null $request = null) Преобразовать ресурс в HTTP-ответ. | из JsonResource |
| Response | toResponse(Request $request) Создать HTTP-ответ, который представляет объект. | |
| массив | jsonSerialize() Подготовить ресурс к сериализации в формате JSON. | из JsonResource |
| mixed | collectResource(mixed $resource) Преобразовать заданный коллекционный ресурс в отдельные ресурсы. | из CollectsResources |
| строка|null | collects() Получить ресурс, который собирает данный ресурс. | из CollectsResources |
| ArrayIterator | getIterator() Получить итератор для коллекции ресурсов. | из CollectsResources |
Подробности
protected массив filter(массив $data)
Фильтрует заданные данные, удаляя все необязательные значения.
protected массив mergeData(массив $data, целое $index, массив $merge, логическое $numericKeys)
Объединить заданные данные в заданном индексе.
protected массив removeMissingValues(массив $data, логическое $numericKeys = ложь)
Удалить отсутствующие значения из отфильтрованных данных.
protected MissingValue|mixed when(логическое $condition, mixed $value, mixed $default = null)
Получить значение на основе заданного условия.
protected MergeValue|mixed merge(mixed $value)
Объединить значение в массив.
protected MergeValue|mixed mergeWhen(логическое $condition, mixed $value)
Объединить значение на основе заданного условия.
protected MergeValue attributes(массив $attributes)
Объединить заданные атрибуты.
protected MissingValue|mixed whenLoaded(строка $relationship, mixed $value = null, mixed $default = null)
Получить отношение, если оно было загружено.
protected MissingValue|mixed whenPivotLoaded(строка $table, mixed $value, mixed $default = null)
Выполнить обратный вызов, если заданная сводная таблица была загружена.
protected MissingValue|mixed whenPivotLoadedAs(string $accessor, string $table, mixed $value, mixed $default = null)
Выполнить обратный вызов, если указанная сводная таблица с пользовательским аксессором была загружена.
protected mixed transform(mixed $value, callable $callback, mixed $default = null)
Преобразовать заданное значение, если оно присутствует.
protected mixed forwardCallTo(mixed $object, string $method, array $parameters)
Перенаправить вызов метода заданному объекту.
static protected void throwBadMethodCallException(string $method)
Выбросить исключение плохого вызова метода для заданного метода.
mixed getRouteKey()
Получить значение ключа маршрута ресурса.
string getRouteKeyName()
Получить ключ маршрута для ресурса.
void resolveRouteBinding(mixed $value)
Получить модель для связанного значения.
bool offsetExists(mixed $offset)
Определить, существует ли заданный атрибут.
mixed offsetGet(mixed $offset)
Получить значение для заданного смещения.
void offsetSet(mixed $offset, mixed $value)
Установить значение для заданного смещения.
void offsetUnset(mixed $offset)
Удалить значение для заданного смещения.
bool __isset(string $key)
Определить, существует ли атрибут в ресурсе.
void __unset(string $key)
Удалить атрибут из ресурса.
mixed __get(string $key)
Динамически получить свойства из базового ресурса.
mixed __call(string $method, array $parameters)
Динамически передавать вызовы методов базовому ресурсу.
void __construct(mixed $resource)
Создать новый экземпляр ресурса.
static JsonResource make(mixed ...$parameters)
Создать новый экземпляр ресурса.
static AnonymousResourceCollection collection(mixed $resource)
Создать новую коллекцию анонимных ресурсов.
array resolve(Request|null $request = null)
Разрешить ресурс в массив.
array toArray(Request $request)
Преобразовать ресурс в JSON-массив.
массив with(Запрос $request)
Получить дополнительные данные, которые должны быть возвращены с массивом ресурсов.
$this additional(массив $data)
Добавить дополнительные метаданные к ответу ресурса.
статический пусто wrap(строка $value)
Установить строку, которая должна обернуть внешний массив ресурсов.
статический пусто withoutWrapping()
Отключить обертывание внешнего массива ресурсов.
массив jsonSerialize()
Подготовить ресурс к сериализации в JSON.
защищённый смешанный collectResource(смешанный $resource)
Преобразовать данный коллекционный ресурс в отдельные ресурсы.
защищённый строка|null collects()
Получить ресурс, который собирает этот ресурс.
ArrayIterator getIterator()
Получить итератор для коллекции ресурсов.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.7/Illuminate/Http/Resources/Json/ResourceCollection.html
