JsonResource
class JsonResource implements ArrayAccess, JsonSerializable, Responsable, UrlRoutable (View source)
Свойства
| ConditionallyLoadsAttributes |
| DelegatesToResource |
Свойства
| 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, 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 |
| mixed | transform(mixed $value, callable $callback, mixed $default = null) Преобразовать заданное значение, если оно присутствует. | из ConditionallyLoadsAttributes |
| 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) Преобразовать ресурс в массив. | |
| 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-ответ, представляющий объект. | |
| массив | jsonSerialize() Подготовить ресурс для сериализации в формате JSON. |
Подробности
protected массив filter(массив $data)
Отфильтровать заданные данные, удалив любые необязательные значения.
protected массив mergeData(массив $data, int $index, массив $merge, bool $numericKeys)
Объединить заданные данные в указанном индексе.
protected массив removeMissingValues(массив $data, bool $numericKeys = false)
Удалить отсутствующие значения из отфильтрованных данных.
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 смешанный тип transform(смешанный тип $value, вызываемый $callback, смешанный тип $default = null)
Преобразовать заданное значение, если оно присутствует.
смешанный тип getRouteKey()
Получить значение ключа маршрута ресурса.
строка getRouteKeyName()
Получить ключ маршрута для ресурса.
пустое значение resolveRouteBinding(смешанный тип $value)
Получить модель для привязанного значения.
логическое значение offsetExists(смешанный тип $offset)
Определить, существует ли данный атрибут.
смешанный тип offsetGet(смешанный тип $offset)
Получить значение для заданного смещения.
пустое значение offsetSet(смешанный тип $offset, смешанный тип $value)
Установить значение для заданного смещения.
пустое значение offsetUnset(смешанный тип $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-ответ.
array jsonSerialize()
Подготовить ресурс к сериализации JSON.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.6/Illuminate/Http/Resources/Json/JsonResource.html
