JsonResource
class JsonResource implements ArrayAccess, JsonSerializable, Responsable, UrlRoutable (View source)
Свойства
| ConditionallyLoadsAttributes | |
| DelegatesToResource | |
| ForwardsCalls |
Свойства
| mixed | $resource | Экземпляр ресурса. | |
| array | $with | Дополнительные данные, которые должны быть добавлены к массиву ресурса верхнего уровня. | |
| array | $additional | Дополнительные метаданные, которые должны быть добавлены к ответу ресурса. | |
| static string | $wrap | Обёртка "данные", которая должна быть применена. |
Методы
| array | filter(array $data)
Отфильтровать заданные данные, удалив все необязательные значения. | из ConditionallyLoadsAttributes |
| array | mergeData(array $data, int $index, array $merge, bool $numericKeys)
Объединить заданные данные в указанном индексе. | из ConditionallyLoadsAttributes |
| array | removeMissingValues(array $data)
Удалить отсутствующие значения из отфильтрованных данных. | из 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)
Создать новый экземпляр ресурса. | |
| static AnonymousResourceCollection | collection(mixed $resource)
Создать новый анонимный набор ресурсов. | |
| array | resolve(Request|null $request = null)
Разрешить ресурс в массив. | |
| array | 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(array $data)
Отфильтровать предоставленные данные, удалив любые необязательные значения.
protected массив mergeData(array $data, int $index, array $merge, bool $numericKeys)
Объединить предоставленные данные в заданном индексе.
protected массив removeMissingValues(array $data)
Удалить отсутствующие значения из отфильтрованных данных.
protected MissingValue|смешанное when(bool $condition, mixed $value, mixed $default = null)
Получить значение на основе заданного условия.
protected MergeValue|смешанное merge(mixed $value)
Объединить значение в массив.
protected MergeValue|смешанное mergeWhen(bool $condition, mixed $value)
Объединить значение на основе заданного условия.
protected MergeValue attributes(array $attributes)
Объединить заданные атрибуты.
protected MissingValue|смешанное whenLoaded(string $relationship, mixed $value = null, mixed $default = null)
Получить отношение, если оно загружено.
protected MissingValue|смешанное whenPivotLoaded(string $table, mixed $value, mixed $default = null)
Выполнить обратный вызов, если указанная таблица связи загружена.
protected MissingValue|смешанное whenPivotLoadedAs(string $accessor, string $table, mixed $value, mixed $default = null)
Выполнить обратный вызов, если указанная таблица связи с пользовательским аксессором загружена.
protected смешанное transform(mixed $value, callable $callback, mixed $default = null)
Преобразовать заданное значение, если оно присутствует.
protected смешанное 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)
Преобразовать ресурс в массив.
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/6.x/Illuminate/Http/Resources/Json/JsonResource.html
