Ресурс
класс Resource расширяет JsonResource (Просмотр исходного кода)
Трейты
| ConditionallyLoadsAttributes |
| DelegatesToResource |
Свойства
| mixed | $resource | Экземпляр ресурса. | из JsonResource |
| массив | $with | Дополнительные данные, которые должны быть добавлены в массив ресурса верхнего уровня. | из JsonResource |
| массив | $additional | Дополнительные метаданные, которые должны быть добавлены в ответ ресурса. | из JsonResource |
| статическая строка | $wrap | Обёртка "data", которая должна быть применена. | из JsonResource |
Методы
| массив | filter(массив $data) Отфильтровать предоставленные данные, удалив все необязательные значения. | из ConditionallyLoadsAttributes |
| массив | mergeData(массив $data, целое число $index, массив $merge, логическое значение $numericKeys) Объединить предоставленные данные по заданному индексу. | из ConditionallyLoadsAttributes |
| массив | removeMissingValues(массив $data, логическое значение $numericKeys = false) Удалить отсутствующие значения из отфильтрованных данных. | из ConditionallyLoadsAttributes |
| MissingValue|смешанное | when(логическое значение $condition, смешанное $value, смешанное $default = null) Получить значение на основе заданного условия. | из ConditionallyLoadsAttributes |
| MergeValue|смешанное | merge(смешанное $value) Объединить значение в массив. | из ConditionallyLoadsAttributes |
| MergeValue|смешанное | mergeWhen(логическое значение $condition, смешанное $value) Объединить значение на основе заданного условия. | из ConditionallyLoadsAttributes |
| MergeValue | attributes(массив $attributes) Объединить заданные атрибуты. | из ConditionallyLoadsAttributes |
| MissingValue|смешанное | whenLoaded(строка $relationship, смешанное $value = null, смешанное $default = null) Получить отношение, если оно было загружено. | из ConditionallyLoadsAttributes |
| MissingValue|смешанное | whenPivotLoaded(строка $table, смешанное $value, смешанное $default = null) Выполнить обратный вызов, если заданная таблица pivot была загружена. | из ConditionallyLoadsAttributes |
| смешанное | transform(смешанное $value, обратный_вызов $callback, смешанное $default = null) Преобразовать заданное значение, если оно присутствует. | из ConditionallyLoadsAttributes |
| смешанное | getRouteKey() Получить значение ключа маршрута ресурса. | из DelegatesToResource |
| строка | getRouteKeyName() Получить ключ маршрута для ресурса. | из DelegatesToResource |
| пустое значение | resolveRouteBinding(смешанное $value) Получить модель для привязанного значения. | из DelegatesToResource |
| логическое значение | offsetExists(смешанное $offset) Определить, существует ли заданный атрибут. | из DelegatesToResource |
| смешанное | offsetGet(смешанное $offset) Получить значение для заданного смещения. | из DelegatesToResource |
| пустое значение | offsetSet(смешанное $offset, смешанное $value) Установить значение для заданного смещения. | из DelegatesToResource |
| пустое значение | offsetUnset(смешанное $offset) Удалить значение для заданного смещения. | из DelegatesToResource |
| логическое значение | __isset(строка $key) Определить, существует ли атрибут в ресурсе. | из DelegatesToResource |
| пустое значение | __unset(строка $key) Удалить атрибут из ресурса. | из DelegatesToResource |
| смешанное | __get(строка $key) Динамическое получение свойств из базового ресурса. | из DelegatesToResource |
| смешанное | __call(строка $method, массив $parameters) Динамическая передача вызовов методов базовому ресурсу. | из DelegatesToResource |
| пустое значение | __construct(смешанное $resource) Создать новый экземпляр ресурса. | из JsonResource |
| статический JsonResource | make(смешанное $parameters) Создать новый экземпляр ресурса. | из JsonResource |
| статический AnonymousResourceCollection | collection(смешанное $resource) Создать новую анонимную коллекцию ресурсов. | из JsonResource |
| массив | resolve(Request|null $request = null) Обработать ресурс в массив. | из JsonResource |
| массив | toArray(Request $request) Преобразовать ресурс в массив. | из JsonResource |
| массив | with(Request $request) Получить дополнительные данные, которые должны быть возвращены с массивом ресурса. | из JsonResource |
| $this | additional(массив $data) Добавить дополнительные метаданные к ответу ресурса. | из JsonResource |
| void | сResponse(Запрос $request, ОтветJSON $response) Настроить ответ для запроса. | из JsonResource |
| static void | wrap(string $value) Установить строку, которая должна обернуть внешний массив ресурсов. | из JsonResource |
| static void | withoutWrapping() Отключить обертывание внешнего массива ресурсов. | из JsonResource |
| ОтветJSON | response(Запрос|null $request = null) Преобразовать ресурс в HTTP-ответ. | из JsonResource |
| Ответ | toResponse(Запрос $request) Создать HTTP-ответ, представляющий объект. | из JsonResource |
| array | jsonSerialize() Подготовить ресурс для сериализации в формате JSON. | из JsonResource |
Подробности
protected array filter(array $data)
Отфильтровать предоставленные данные, удалив любые необязательные значения.
protected array mergeData(array $data, int $index, array $merge, bool $numericKeys)
Объединить предоставленные данные в заданном индексе.
protected array removeMissingValues(array $data, bool $numericKeys = false)
Удалить отсутствующие значения из отфильтрованных данных.
protected ОтсутствующееЗначение|mixed when(bool $condition, mixed $value, mixed $default = null)
Получить значение на основе заданного условия.
protected ОбъединённоеЗначение|mixed merge(mixed $value)
Объединить значение в массив.
protected ОбъединённоеЗначение|mixed mergeWhen(bool $condition, mixed $value)
Объединить значение на основе заданного условия.
protected ОбъединённоеЗначение attributes(array $attributes)
Объединить заданные атрибуты.
protected ОтсутствующееЗначение|mixed whenLoaded(string $relationship, mixed $value = null, mixed $default = null)
Получить отношение, если оно было загружено.
protected ОтсутствующееЗначение|mixed whenPivotLoaded(string $table, mixed $value, mixed $default = null)
Выполнить обратный вызов, если заданная сводная таблица была загружена.
protected mixed transform(mixed $value, callable $callback, mixed $default = null)
Преобразовать заданное значение, если оно присутствует.
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-ответ.
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/Resource.html
