JsonResource

класс JsonResource реализует ArrayAccess, JsonSerializable, Responsable, UrlRoutable (View source)

Черты

Свойства

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

Методы

array	filter(array $data) Отфильтровать заданные данные, удалив все необязательные значения.	from ConditionallyLoadsAttributes
array	mergeData(array $data, int $index, array $merge, bool $numericKeys) Объединить заданные данные по заданному индексу.	from ConditionallyLoadsAttributes
array	removeMissingValues(array $data, bool $numericKeys = false) Удалить отсутствующие значения из отфильтрованных данных.	from ConditionallyLoadsAttributes
MissingValue\|mixed	when(bool $condition, mixed $value, mixed $default = null) Получить значение на основе заданного условия.	from ConditionallyLoadsAttributes
MergeValue\|mixed	merge(mixed $value) Объединить значение в массив.	from ConditionallyLoadsAttributes
MergeValue\|mixed	mergeWhen(bool $condition, mixed $value) Объединить значение на основе заданного условия.	from ConditionallyLoadsAttributes
MergeValue	attributes(array $attributes) Объединить заданные атрибуты.	from ConditionallyLoadsAttributes
MissingValue\|mixed	whenLoaded(string $relationship, mixed $value = null, mixed $default = null) Получить связь, если она загружена.	from ConditionallyLoadsAttributes
MissingValue\|mixed	whenPivotLoaded(string $table, mixed $value, mixed $default = null) Выполнить обратный вызов, если заданная сводная таблица загружена.	from ConditionallyLoadsAttributes
MissingValue\|mixed	whenPivotLoadedAs(string $accessor, string $table, mixed $value, mixed $default = null) Выполнить обратный вызов, если заданная сводная таблица с настраиваемым аксессором загружена.	from ConditionallyLoadsAttributes
mixed	transform(mixed $value, callable $callback, mixed $default = null) Преобразовать заданное значение, если оно присутствует.	from ConditionallyLoadsAttributes
mixed	forwardCallTo(mixed $object, string $method, array $parameters) Перенаправить вызов метода на заданный объект.	from ForwardsCalls
static void	throwBadMethodCallException(string $method) Выбросить исключение о неправильном вызове метода для данного метода.	from ForwardsCalls
mixed	getRouteKey() Получить значение ключа маршрута ресурса.	from DelegatesToResource
string	getRouteKeyName() Получить ключ маршрута для ресурса.	from DelegatesToResource
void	resolveRouteBinding(mixed $value) Получить модель для связанного значения.	from DelegatesToResource
bool	offsetExists(mixed $offset) Определить, существует ли данный атрибут.	from DelegatesToResource
mixed	offsetGet(mixed $offset) Получить значение для заданного смещения.	from DelegatesToResource
void	offsetSet(mixed $offset, mixed $value) Установить значение для заданного смещения.	from DelegatesToResource
void	offsetUnset(mixed $offset) Сбросить значение для заданного смещения.	from DelegatesToResource
bool	__isset(string $key) Определить, существует ли атрибут в ресурсе.	from DelegatesToResource
void	__unset(string $key) Сбросить атрибут в ресурсе.	from DelegatesToResource
mixed	__get(string $key) Динамически получить свойства из базового ресурса.	from DelegatesToResource
mixed	__call(string $method, array $parameters) Динамически передать вызовы методов в базовый ресурс.	from DelegatesToResource
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.

Details

protected array filter(array $data)

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

Parameters

array

$data

Return Value

array

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

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

Parameters

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

Return Value

array

protected array removeMissingValues(array $data, bool $numericKeys = false)

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

Parameters

array	$data
bool	$numericKeys

Return Value

array

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

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

Parameters

bool	$condition
mixed	$value
mixed	$default

Return Value

MissingValue|mixed

protected MergeValue|mixed merge(mixed $value)

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

Parameters

mixed

$value

Return Value

MergeValue|mixed

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

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

Parameters

bool	$condition
mixed	$value

Return Value

MergeValue|mixed

protected MergeValue attributes(array $attributes)

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

Parameters

array

$attributes

Return Value

MergeValue

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

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

Parameters

string	$relationship
mixed	$value
mixed	$default

Return Value

MissingValue|mixed

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

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

Parameters

string	$table
mixed	$value
mixed	$default

Return Value

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

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)

Извлечь модель для привязанного значения.

Parameters

mixed

$value

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

static AnonymousResourceCollection collection(mixed $resource)

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

Parameters

mixed

$resource

Return Value

AnonymousResourceCollection

array resolve(Request|null $request = null)

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

Parameters

Request|null

$request

Return Value

array

array toArray(Request $request)

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

Parameters

Request

$request

Return Value

array

array with(Request $request)

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

Parameters

Request

$request

Return Value

array

$this additional(array $data)

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

Parameters

array

$data

Return Value

$this

void withResponse(Request $request, JsonResponse $response)

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

Parameters

Request	$request
JsonResponse	$response

Return Value

void

static void wrap(string $value)

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

Parameters

string

$value

Return Value

void

static void withoutWrapping()

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

Return Value

void

JsonResponse response(Request|null $request = null)

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

Parameters

Request|null

$request

Return Value

JsonResponse

Response toResponse(Request $request)

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

Parameters

Request

$request

Return Value

Response

array jsonSerialize()

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

Return Value

array

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