JsonResource

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

Свойства

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

Трейты

ConditionallyLoadsAttributes

DelegatesToResource

ForwardsCalls

Macroable

Методы

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) Получить значение, если заданное «condition» истинно.	из ConditionallyLoadsAttributes
MissingValue\|mixed	unless(bool $condition, mixed $value, mixed $default = null) Получить значение, если заданное «condition» ложно.	из ConditionallyLoadsAttributes
MergeValue\|mixed	merge(mixed $value) Объединить значение в массив.	из ConditionallyLoadsAttributes
MergeValue\|mixed	mergeWhen(bool $condition, mixed $value, mixed $default = null) Объединить значение, если заданное условие истинно.	из ConditionallyLoadsAttributes
MergeValue\|mixed	mergeUnless(bool $condition, mixed $value, mixed $default = null) Объединить значение, если заданное условие ложно.	из ConditionallyLoadsAttributes
MergeValue	attributes(array $attributes) Объединить заданные атрибуты.	из ConditionallyLoadsAttributes
MissingValue\|mixed	whenHas(string $attribute, mixed $value = null, mixed $default = null) Получить атрибут, если он существует в ресурсе.	из ConditionallyLoadsAttributes
MissingValue\|mixed	whenNull(mixed $value, mixed $default = null) Получить атрибут модели, если он равен null.	из ConditionallyLoadsAttributes
MissingValue\|mixed	whenNotNull(mixed $value, mixed $default = null) Получить атрибут модели, если он не равен null.	из 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	whenCounted(string $relationship, mixed $value = null, mixed $default = null) Получить счётчик отношения, если он существует.	из ConditionallyLoadsAttributes
MissingValue\|mixed	whenAggregated(string $relationship, string $column, string $aggregate, mixed $value = null, mixed $default = null) Получить агрегированное значение отношения, если оно существует.	из ConditionallyLoadsAttributes
MissingValue\|mixed	whenPivotLoaded(string $table, mixed $value, mixed $default = null) Выполнить обратный вызов, если указанная таблица pivot была загружена.	из ConditionallyLoadsAttributes
MissingValue\|mixed	whenPivotLoadedAs(string $accessor, string $table, mixed $value, mixed $default = null) Выполнить обратный вызов, если указанная таблица pivot с пользовательским аксессором была загружена.	из ConditionallyLoadsAttributes
bool	hasPivotLoaded(string $table) Определить, загружена ли у ресурса указанная таблица pivot.	из ConditionallyLoadsAttributes
bool	hasPivotLoadedAs(string $accessor, string $table) Определить, загружена ли у ресурса указанная таблица pivot с пользовательским аксессором.	из 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) Выбросить исключение о неправильном вызове метода для данного метода.	from ForwardsCalls
static void	macro(string $name, object\|callable $macro) Зарегистрировать пользовательский макрос.	from Macroable
static void	mixin(object $mixin, bool $replace = true) Смешать другой объект в класс.	from Macroable
static bool	hasMacro(string $name) Проверить, зарегистрирован ли макрос.	from Macroable
static void	flushMacros() Очистить существующие макросы.	from Macroable
static mixed	__callStatic(string $method, array $parameters) Динамически обрабатывать вызовы к классу.	from Macroable
mixed	__call(string $method, array $parameters) Динамически обрабатывать вызовы к классу.	from Macroable
mixed	getRouteKey() Получить значение ключа маршрута ресурса.	from DelegatesToResource
string	getRouteKeyName() Получить ключ маршрута для ресурса.	from DelegatesToResource
void	resolveRouteBinding(mixed $value, string\|null $field = null) Извлечь модель для связанного значения.	from DelegatesToResource
void	resolveChildRouteBinding(string $childType, mixed $value, string\|null $field = null) Извлечь модель для связанного значения.	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
void	__construct(mixed $resource) Создать новый экземпляр ресурса.
static JsonResource	make(mixed ...$parameters) Создать новый экземпляр ресурса.
static AnonymousResourceCollection	collection(mixed $resource) Создать новую анонимную коллекцию ресурсов.
static AnonymousResourceCollection	newCollection(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)

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

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)

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

Parameters

array

$data

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

MissingValue|mixed unless(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, mixed $default = null)

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

Parameters

bool	$condition
mixed	$value
mixed	$default

Return Value

MergeValue|mixed

protected MergeValue|mixed mergeUnless(bool $condition, mixed $value, mixed $default = null)

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

Parameters

bool	$condition
mixed	$value
mixed	$default

Return Value

MergeValue|mixed

protected MergeValue attributes(array $attributes)

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

Parameters

array

$attributes

Return Value

MergeValue

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

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

Parameters

string	$attribute
mixed	$value
mixed	$default

Return Value

MissingValue|mixed

protected MissingValue|mixed whenNull(mixed $value, mixed $default = null)

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

Parameters

mixed	$value
mixed	$default

Return Value

MissingValue|mixed

protected MissingValue|mixed whenNotNull(mixed $value, mixed $default = null)

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

Parameters

mixed	$value
mixed	$default

Return Value

MissingValue|mixed

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

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

Parameters

string	$attribute
mixed	$value
mixed	$default

Return Value

MissingValue|mixed

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

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

Parameters

string	$relationship
mixed	$value
mixed	$default

Return Value

MissingValue|mixed

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

Получить счетчик отношения, если он существует.

Parameters

string	$relationship
mixed	$value
mixed	$default

Return Value

MissingValue|mixed

MissingValue|смешанный whenAggregated(строка $relationship, строка $column, строка $aggregate, смешанный $value = null, смешанный $default = null)

Получить агрегированное значение отношения, если оно существует.

Параметры

строка	$relationship
строка	$column
строка	$aggregate
смешанный	$value
смешанный	$default

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

MissingValue|смешанный

protected MissingValue|смешанный whenPivotLoaded(строка $table, смешанный $value, смешанный $default = null)

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

Параметры

строка	$table
смешанный	$value
смешанный	$default

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

MissingValue|смешанный

protected MissingValue|смешанный whenPivotLoadedAs(строка $accessor, строка $table, смешанный $value, смешанный $default = null)

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

Параметры

строка	$accessor
строка	$table
смешанный	$value
смешанный	$default

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

MissingValue|смешанный

protected bool hasPivotLoaded(строка $table)

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

Параметры

строка

$table

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

bool

protected bool hasPivotLoadedAs(строка $accessor, строка $table)

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

Параметры

строка	$accessor
строка	$table

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

bool

protected смешанный transform(смешанный $value, вызов $callback, смешанный $default = null)

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

Параметры

смешанный	$value
вызов	$callback
смешанный	$default

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

смешанный

protected смешанный forwardCallTo(смешанный $object, строка $method, массив $parameters)

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

Параметры

смешанный	$object
строка	$method
массив	$parameters

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

смешанный

Исключения

BadMethodCallException

protected смешанный forwardDecoratedCallTo(смешанный $object, строка $method, массив $parameters)

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

Параметры

смешанный	$object
строка	$method
массив	$parameters

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

смешанный

Исключения

BadMethodCallException

static protected void throwBadMethodCallException(строка $method)

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

Параметры

строка

$method

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

void

Исключения

BadMethodCallException

static void macro(строка $name, объект|вызов $macro)

Зарегистрировать пользовательский макрос.

Параметры

строка	$name
объект\|вызов	$macro

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

void

static void mixin(объект $mixin, bool $replace = true)

Добавить другой объект в класс.

Параметры

объект	$mixin
bool	$replace

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

void

Исключения

ReflectionException

static bool hasMacro(строка $name)

Проверяет, зарегистрирован ли макрос.

Параметры

строка

$name

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

bool

static void flushMacros()

Очистить существующие макросы.

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

void

static смешанный __callStatic(строка $method, массив $parameters)

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

Параметры

строка	$method
массив	$parameters

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

смешанный

Исключения

BadMethodCallException

смешанный __call(строка $method, массив $parameters)

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

Параметры

строка	$method
массив	$parameters

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

смешанный

Исключения

BadMethodCallException

смешанный getRouteKey()

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

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

смешанный

строка getRouteKeyName()

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

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

строка

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

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

Параметры

mixed	$value
string\|null	$field

Значение возврата

void

Исключения

Исключение

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

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

Параметры

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

Значение возврата

void

Исключения

Исключение

bool offsetExists(mixed $offset)

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

Параметры

mixed

$offset

Значение возврата

bool

mixed offsetGet(mixed $offset)

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

Параметры

mixed

$offset

Значение возврата

mixed

void offsetSet(mixed $offset, mixed $value)

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

Параметры

mixed	$offset
mixed	$value

Значение возврата

void

void offsetUnset(mixed $offset)

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

Параметры

mixed

$offset

Значение возврата

void

bool __isset(string $key)

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

Параметры

string

$key

Значение возврата

bool

void __unset(string $key)

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

Параметры

string

$key

Значение возврата

void

mixed __get(string $key)

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

Параметры

string

$key

Значение возврата

mixed

void __construct(mixed $resource)

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

Параметры

mixed

$resource

Значение возврата

void

static JsonResource make(mixed ...$parameters)

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

Параметры

mixed

...$parameters

Значение возврата

JsonResource

static AnonymousResourceCollection collection(mixed $resource)

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

Параметры

mixed

$resource

Значение возврата

AnonymousResourceCollection

static protected AnonymousResourceCollection newCollection(mixed $resource)

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

Параметры

mixed

$resource

Значение возврата

AnonymousResourceCollection

array resolve(Запрос|null $request = null)

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

Параметры

Запрос|null

$request

Значение возврата

array

array|Arrayable|JsonSerializable toArray(Запрос $request)

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

Параметры

Запрос

$request

Значение возврата

array|Arrayable|JsonSerializable

string toJson(int $options = 0)

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

Параметры

int

$options

Значение возврата

string

Исключения

JsonEncodingException

array with(Запрос $request)

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

Параметры

Запрос

$request

Значение возврата

array

$this additional(array $data)

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

Параметры

array

$data

Значение возврата

$this

int jsonOptions()

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

Значение возврата

int

void withResponse(Request $request, JsonResponse $response)

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

Параметры

Request	$request
JsonResponse	$response

Значение возврата

void

static void wrap(string $value)

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

Параметры

string

$value

Значение возврата

void

static void withoutWrapping()

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

Значение возврата

void

JsonResponse response(Request|null $request = null)

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

Параметры

Request|null

$request

Значение возврата

JsonResponse

Response toResponse(Request $request)

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

Параметры

Request

$request

Значение возврата

Response

array jsonSerialize()

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

Значение возврата

array

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