JsonResource

class JsonResource implements ArrayAccess, JsonSerializable, Responsable, UrlRoutable (View source)

Свойства

mixed	$resource	Экземпляр ресурса.
array	$with	Дополнительные данные, которые должны быть добавлены в массив ресурса верхнего уровня.
array	$additional	Дополнительные метаданные, которые должны быть добавлены в ответ ресурса.
static string\|null	$wrap	Обёртка "data", которая должна быть применена.

Трейты

ConditionallyLoadsAttributes

DelegatesToResource

ForwardsCalls

Методы

array	filter(array $data) Отфильтровать предоставленные данные, удалив все необязательные значения.	из ConditionallyLoadsAttributes
array	mergeData(array $data, int $index, array $merge, bool $numericKeys) Объединить предоставленные данные по указанному индексу.	из ConditionallyLoadsAttributes
array	removeMissingValues(array $data) Удалить отсутствующие значения из отфильтрованных данных.	из 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	whenAppended(string $attribute, mixed $value = null, mixed $default = null) Получить аксессор, если он был добавлен.	из ConditionallyLoadsAttributes
MissingValue\|mixed	whenLoaded(string $relationship, mixed $value = null, mixed $default = null) Получить отношение, если оно было загружено.	из ConditionallyLoadsAttributes
MissingValue\|mixed	whenPivotLoaded(string $table, mixed $value, mixed $default = null) Выполнить обратный вызов, если заданная таблица сводки была загружена.	из ConditionallyLoadsAttributes
MissingValue\|mixed	whenPivotLoadedAs(string $accessor, string $table, mixed $value, mixed $default = null) Выполнить обратный вызов, если заданная таблица сводки с пользовательским аксессором была загружена.	из ConditionallyLoadsAttributes
mixed	transform(mixed $value, callable $callback, mixed $default = null) Преобразовать заданное значение, если оно присутствует.	из ConditionallyLoadsAttributes
mixed	forwardCallTo(mixed $object, string $method, array $parameters) Перенаправить вызов метода заданному объекту.	из ForwardsCalls
mixed	forwardDecoratedCallTo(mixed $object, string $method, array $parameters) Перенаправить вызов метода заданному объекту, вернув $this, если перенаправленный вызов вернул себя.	из ForwardsCalls
static void	throwBadMethodCallException(string $method) Выбросить исключение плохого вызова метода для данного метода.	из ForwardsCalls
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
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\|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)

Отфильтровать заданные данные, удалив любые необязательные значения.

Параметры

array

$data

Возвращаемое значение

array

protected array mergeData(array $data, int $index, array $merge, bool $numericKeys)

Объединить заданные данные в заданном индексе.

Параметры

array	$data
int	$index
array	$merge
bool	$numericKeys

Возвращаемое значение

array

protected array removeMissingValues(array $data)

Удалить отсутствующие значения из отфильтрованных данных.

Параметры

array

$data

Возвращаемое значение

array

protected MissingValue|mixed when(bool $condition, mixed $value, mixed $default = null)

Получить значение на основе заданного условия.

Параметры

bool	$condition
mixed	$value
mixed	$default

Возвращаемое значение

MissingValue|mixed

protected MergeValue|mixed merge(mixed $value)

Объединить значение в массив.

Параметры

mixed

$value

Возвращаемое значение

MergeValue|mixed

protected MergeValue|mixed mergeWhen(bool $condition, mixed $value)

Объединить значение на основе заданного условия.

Параметры

bool	$condition
mixed	$value

Возвращаемое значение

MergeValue|mixed

protected MergeValue attributes(array $attributes)

Объединить заданные атрибуты.

Параметры

array

$attributes

Возвращаемое значение

MergeValue

protected MissingValue|mixed whenAppended(string $attribute, mixed $value = null, mixed $default = null)

Получить аксессор, когда он был добавлен.

Параметры

string	$attribute
mixed	$value
mixed	$default

Возвращаемое значение

MissingValue|mixed

protected MissingValue|mixed whenLoaded(string $relationship, mixed $value = null, mixed $default = null)

Получить отношение, если оно было загружено.

Параметры

string	$relationship
mixed	$value
mixed	$default

Возвращаемое значение

MissingValue|mixed

protected MissingValue|mixed whenPivotLoaded(string $table, mixed $value, mixed $default = null)

Выполнить обратный вызов, если заданная сводная таблица была загружена.

Параметры

string	$table
mixed	$value
mixed	$default

Возвращаемое значение

MissingValue|mixed

protected MissingValue|mixed whenPivotLoadedAs(string $accessor, string $table, mixed $value, mixed $default = null)

Выполнить обратный вызов, если заданная сводная таблица с пользовательским аксессором была загружена.

Parameters

string	$accessor
string	$table
mixed	$value
mixed	$default

Return Value

MissingValue|mixed

protected mixed transform(mixed $value, callable $callback, mixed $default = null)

Преобразовать заданное значение, если оно присутствует.

Parameters

mixed	$value
callable	$callback
mixed	$default

Return Value

mixed

protected mixed forwardCallTo(mixed $object, string $method, array $parameters)

Перенаправить вызов метода заданному объекту.

Parameters

mixed	$object
string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

protected mixed forwardDecoratedCallTo(mixed $object, string $method, array $parameters)

Перенаправить вызов метода заданному объекту, вернув $this, если перенаправленный вызов вернул себя.

Parameters

mixed	$object
string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

static protected void throwBadMethodCallException(string $method)

Выбросить исключение плохого вызова метода для заданного метода.

Parameters

string

$method

Return Value

void

Exceptions

BadMethodCallException

mixed getRouteKey()

Получить значение ключа маршрута ресурса.

Return Value

mixed

string getRouteKeyName()

Получить ключ маршрута для ресурса.

Return Value

string

void resolveRouteBinding(mixed $value, string|null $field = null)

Получить модель для связанного значения.

Parameters

mixed	$value
string\|null	$field

Return Value

void

Exceptions

Exception

void resolveChildRouteBinding(string $childType, mixed $value, string|null $field = null)

Получить модель для связанного значения.

Parameters

string	$childType
mixed	$value
string\|null	$field

Return Value

void

Exceptions

Exception

bool offsetExists(mixed $offset)

Определить, существует ли заданный атрибут.

Parameters

mixed

$offset

Return Value

bool

mixed offsetGet(mixed $offset)

Получить значение для заданного смещения.

Parameters

mixed

$offset

Return Value

mixed

void offsetSet(mixed $offset, mixed $value)

Установить значение для заданного смещения.

Parameters

mixed	$offset
mixed	$value

Return Value

void

void offsetUnset(mixed $offset)

Удалить значение для заданного смещения.

Parameters

mixed

$offset

Return Value

void

bool __isset(string $key)

Определить, существует ли атрибут в ресурсе.

Parameters

string

$key

Return Value

bool

void __unset(string $key)

Удалить атрибут из ресурса.

Parameters

string

$key

Return Value

void

mixed __get(string $key)

Динамически получить свойства из базового ресурса.

Parameters

string

$key

Return Value

mixed

mixed __call(string $method, array $parameters)

Динамически передавать вызовы методов базовому ресурсу.

Parameters

string	$method
array	$parameters

Return Value

mixed

void __construct(mixed $resource)

Создать новый экземпляр ресурса.

Parameters

mixed

$resource

Return Value

void

static JsonResource make(mixed ...$parameters)

Создать новый экземпляр ресурса.

Parameters

mixed

...$parameters

Return Value

JsonResource

статический AnonymousResourceCollection collection(mixed $resource)

Создать новую коллекцию анонимных ресурсов.

Параметры

mixed

$resource

Возвращаемое значение

AnonymousResourceCollection

массив resolve(Запрос|null $request = null)

Разрешить ресурс в массив.

Параметры

Запрос|null

$request

Возвращаемое значение

массив

массив|Arrayable|JsonSerializable toArray(Запрос $request)

Преобразовать ресурс в массив.

Параметры

Запрос

$request

Возвращаемое значение

массив|Arrayable|JsonSerializable

строка toJson(int $options = 0)

Преобразовать экземпляр модели в JSON.

Параметры

int

$options

Возвращаемое значение

строка

Исключения

JsonEncodingException

массив with(Запрос $request)

Получить любые дополнительные данные, которые должны быть возвращены с массивом ресурсов.

Параметры

Запрос

$request

Возвращаемое значение

массив

$this additional(array $data)

Добавить дополнительные метаданные к ответу ресурса.

Параметры

массив

$data

Возвращаемое значение

$this

int jsonOptions()

Получить параметры сериализации JSON, которые должны быть применены к ответу ресурса.

Возвращаемое значение

int

void withResponse(Запрос $request, JsonResponse $response)

Настроить ответ для запроса.

Параметры

Запрос	$request
JsonResponse	$response

Возвращаемое значение

void

статический void wrap(string $value)

Установить строку, которая должна обернуть внешний массив ресурсов.

Параметры

строка

$value

Возвращаемое значение

void

статический void withoutWrapping()

Отключить обёртку внешнего массива ресурсов.

Возвращаемое значение

void

JsonResponse response(Запрос|null $request = null)

Преобразовать ресурс в HTTP-ответ.

Параметры

Запрос|null

$request

Возвращаемое значение

JsonResponse

Response toResponse(Запрос $request)

Создать HTTP-ответ, представляющий объект.

Параметры

Запрос

$request

Возвращаемое значение

Response

массив jsonSerialize()

Подготовить ресурс для сериализации в JSON.

Возвращаемое значение

массив

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Http/Resources/Json/JsonResource.html