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