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