Ресурс
класс Ресурс расширяет JsonResource (Просмотреть исходный код)
Трейты
| ConditionallyLoadsAttributes | |
| DelegatesToResource | |
| ForwardsCalls |
Свойства
| смешанный | $resource | Экземпляр ресурса. | из JsonResource |
| массив | $with | Дополнительные данные, которые должны быть добавлены в массив ресурса верхнего уровня. | из JsonResource |
| массив | $additional | Дополнительные метаданные, которые должны быть добавлены в ответ ресурса. | из JsonResource |
| статическая строка | $wrap | Обёртка "data", которая должна быть применена. | из JsonResource |
Методы
| массив | 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|смешанный | 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 |
| 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 |
| статический JsonResource | make(смешанный ...$parameters) Создать новый экземпляр ресурса. | из JsonResource |
| статический AnonymousResourceCollection | collection(смешанный $resource) Создать новую анонимную коллекцию ресурсов. | из JsonResource |
| массив | resolve(Запрос|null $request = null) Преобразовать ресурс в массив. | из JsonResource |
| массив | toArray(Запрос $request) Преобразовать ресурс в массив. | из JsonResource |
| массив | with(Запрос $request) Получить дополнительные данные, которые должны быть возвращены вместе с массивом ресурса. | из JsonResource |
| $this | additional(array $data) Добавить дополнительные метаданные к ответу ресурса. | из JsonResource |
| void | withResponse(Запрос $request, JsonResponse $response) Настроить ответ для запроса. | из JsonResource |
| static void | wrap(string $value) Установить строку, которая должна обернуть внешний массив ресурса. | из JsonResource |
| static void | withoutWrapping() Отключить обёртку внешнего массива ресурса. | из JsonResource |
| JsonResponse | response(Запрос|null $request = null) Преобразовать ресурс в HTTP-ответ. | из JsonResource |
| Response | toResponse(Запрос $request) Создать HTTP-ответ, представляющий объект. | из JsonResource |
| массив | jsonSerialize() Подготовить ресурс к сериализации в формате JSON. | из JsonResource |
Подробности
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)
Выполнить обратный вызов, если заданная вспомогательная таблица была загружена.
protected MissingValue|смешанный whenPivotLoadedAs(строка $accessor, строка $table, смешанный $value, смешанный $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)
Получить модель для привязанного значения.
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/Resource.html
