JsonResource
класс JsonResource реализует ArrayAccess, JsonSerializable, Responsable, UrlRoutable (Просмотреть исходный код)
Свойства
| ConditionallyLoadsAttributes | |
| DelegatesToResource | |
| ForwardsCalls | |
| Macroable |
Свойства
| статический защищённый массив | $macros | Зарегистрированные строковые макросы. | из Macroable |
| смешанный | $resource | Экземпляр ресурса. | |
| массив | $with | Дополнительные данные, которые должны быть добавлены в массив ресурса верхнего уровня. | |
| массив | $additional | Дополнительные метаданные, которые должны быть добавлены к ответу ресурса. | |
| статический строка|null | $wrap | Обёртка "данные", которая должна быть применена. |
Методы
| массив | filter(массив $data)
Фильтровать заданные данные, удаляя любые необязательные значения. | из ConditionallyLoadsAttributes |
| массив | mergeData(массив $data, целое $index, массив $merge, логическое $numericKeys)
Объединить заданные данные в заданном индексе. | из ConditionallyLoadsAttributes |
| массив | removeMissingValues(массив $data)
Удалить отсутствующие значения из отфильтрованных данных. | из ConditionallyLoadsAttributes |
| MissingValue|смешанный | when(логическое $condition, смешанный $value, смешанный $default = null)
Получить значение, если заданное «условие» истинно. | из ConditionallyLoadsAttributes |
| MissingValue|смешанный | unless(логическое $condition, смешанный $value, смешанный $default = null)
Получить значение, если заданное «условие» ложно. | из ConditionallyLoadsAttributes |
| MergeValue|смешанный | merge(смешанный $value)
Объединить значение в массив. | из ConditionallyLoadsAttributes |
| MergeValue|смешанный | mergeWhen(логическое $condition, смешанный $value)
Объединить значение, если заданное условие истинно. | из ConditionallyLoadsAttributes |
| MergeValue|смешанный | mergeUnless(логическое $condition, смешанный $value)
Объединить значение, если заданное условие ложно. | из ConditionallyLoadsAttributes |
| MergeValue | attributes(массив $attributes)
Объединить заданные атрибуты. | из ConditionallyLoadsAttributes |
| MissingValue|смешанный | whenHas(строка $attribute, смешанный $value = null, смешанный $default = null)
Получить атрибут, если он существует в ресурсе. | из ConditionallyLoadsAttributes |
| MissingValue|смешанный | whenNull(смешанный $value, смешанный $default = null)
Получить атрибут модели, если он равен null. | из ConditionallyLoadsAttributes |
| MissingValue|смешанный | whenNotNull(смешанный $value, смешанный $default = null)
Получить атрибут модели, если он не равен null. | из ConditionallyLoadsAttributes |
| MissingValue|смешанный | whenAppended(строка $attribute, смешанный $value = null, смешанный $default = null)
Получить аксессор, если он был добавлен. | из ConditionallyLoadsAttributes |
| MissingValue|смешанный | whenLoaded(строка $relationship, смешанный $value = null, смешанный $default = null)
Получить отношение, если оно было загружено. | из ConditionallyLoadsAttributes |
| MissingValue|смешанный | whenCounted(строка $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 |
| смешанный | forwardDecoratedCallTo(смешанный $object, строка $method, массив $parameters)
Передать вызов метода заданному объекту, возвращая $this, если переданный вызов вернул себя. | из ForwardsCalls |
| статический void | throwBadMethodCallException(строка $method)
Выбросить исключение плохого вызова метода для заданного метода. | из ForwardsCalls |
| статический void | macro(строка $name, объект|вызываемый $macro)
Зарегистрировать пользовательский макрос. | из Macroable |
| статический void | mixin(объект $mixin, логическое $replace = true)
Смешать другой объект в класс. | из Macroable |
| статический логическое | hasMacro(строка $name)
Проверяет, зарегистрирован ли макрос. | из Macroable |
| статический void | flushMacros()
Очистить существующие макросы. | из Macroable |
| static mixed | __callStatic(string $method, array $parameters)
Динамически обрабатывает вызовы класса. | из Macroable |
| mixed | __call(string $method, array $parameters)
Динамически обрабатывает вызовы класса. | из Macroable |
| mixed | getRouteKey()
Получить значение ключа маршрута ресурса. | из DelegatesToResource |
| string | getRouteKeyName()
Получить ключ маршрута для ресурса. | из DelegatesToResource |
| void | resolveRouteBinding(mixed $value, string|null $field = null)
Получить модель для связанного значения. | из DelegatesToResource |
| void | resolveChildRouteBinding(string $childType, mixed $value, string|null $field = null)
Получить модель для связанного значения. | из 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 |
| void | __construct(mixed $resource)
Создать новый экземпляр ресурса. | |
| static JsonResource | make(mixed ...$parameters)
Создать новый экземпляр ресурса. | |
| static AnonymousResourceCollection | collection(mixed $resource)
Создать новый анонимный набор ресурсов. | |
| array | resolve(Request|null $request = null)
Обработать ресурс в массив. | |
| array|Arrayable|JsonSerializable | toArray(Request $request)
Преобразовать ресурс в массив. | |
| string | toJson(int $options = 0)
Преобразовать экземпляр модели в JSON. | |
| array | with(Request $request)
Получить дополнительные данные, которые должны быть возвращены с массивом ресурса. | |
| $this | additional(array $data)
Добавить дополнительные метаданные к ответу ресурса. | |
| int | jsonOptions()
Получить параметры сериализации JSON, которые должны быть применены к ответу ресурса. | |
| 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)
Получить значение, если заданное «условие» истинно.
MissingValue|mixed unless(bool $condition, mixed $value, mixed $default = null)
Получить значение, если заданное «условие» ложно.
protected MergeValue|mixed merge(mixed $value)
Объединить значение в массив.
protected MergeValue|mixed mergeWhen(bool $condition, mixed $value)
Объединить значение, если заданное условие истинно.
protected MergeValue|mixed mergeUnless(bool $condition, mixed $value)
Объединить значение, если заданное условие ложно.
protected MergeValue attributes(array $attributes)
Объединить заданные атрибуты.
MissingValue|mixed whenHas(string $attribute, mixed $value = null, mixed $default = null)
Получить атрибут, если он существует в ресурсе.
protected MissingValue|mixed whenNull(mixed $value, mixed $default = null)
Получить атрибут модели, если он равен null.
protected MissingValue|mixed whenNotNull(mixed $value, mixed $default = null)
Получить атрибут модели, если он не равен null.
protected MissingValue|mixed whenAppended(string $attribute, mixed $value = null, mixed $default = null)
Получить аксессор, если он был добавлен.
protected MissingValue|mixed whenLoaded(string $relationship, mixed $value = null, mixed $default = null)
Получить отношение, если оно было загружено.
MissingValue|mixed whenCounted(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)
Передать вызов метода заданному объекту.
protected mixed forwardDecoratedCallTo(mixed $object, string $method, array $parameters)
Передать вызов метода заданному объекту, вернув $this, если переданный вызов вернул себя.
static protected void throwBadMethodCallException(string $method)
Выбросить исключение плохого вызова метода для данного метода.
static void macro(string $name, object|callable $macro)
Зарегистрировать пользовательский макрос.
static void mixin(object $mixin, bool $replace = true)
Смешать другой объект в класс.
static bool hasMacro(string $name)
Проверяет, зарегистрирован ли макрос.
static void flushMacros()
Очистить существующие макросы.
static mixed __callStatic(string $method, array $parameters)
Динамически обработать вызовы класса.
mixed __call(string $method, array $parameters)
Динамически обработать вызовы класса.
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)
Удалить атрибут в ресурсе.
смешанный тип __get(строка $key)
Динамически получить свойства из базового ресурса.
void __construct(смешанный тип $resource)
Создать новый экземпляр ресурса.
статический JsonResource make(смешанный тип ...$parameters)
Создать новый экземпляр ресурса.
статический AnonymousResourceCollection collection(смешанный тип $resource)
Создать новую коллекцию анонимных ресурсов.
массив resolve(Запрос|null $request = null)
Разрешить ресурс в массив.
массив|Arrayable|JsonSerializable toArray(Запрос $request)
Преобразовать ресурс в массив.
строка toJson(целое число $options = 0)
Преобразовать экземпляр модели в JSON.
массив with(Запрос $request)
Получить любые дополнительные данные, которые должны быть возвращены с массивом ресурсов.
$this additional(массив $data)
Добавить дополнительные метаданные к ответу ресурса.
целое число jsonOptions()
Получить параметры сериализации JSON, которые должны быть применены к ответу ресурса.
void withResponse(Запрос $request, JsonResponse $response)
Настроить ответ для запроса.
статический void wrap(строка $value)
Установить строку, которая должна обрамлять внешний массив ресурсов.
статический void withoutWrapping()
Отключить обрамление внешнего массива ресурсов.
JsonResponse response(Запрос|null $request = null)
Преобразовать ресурс в HTTP-ответ.
Ответ toResponse(Запрос $request)
Создать HTTP-ответ, представляющий объект.
массив jsonSerialize()
Подготовить ресурс для сериализации в JSON.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/9.x/Illuminate/Http/Resources/Json/JsonResource.html
