Ресурс

класс Ресурс наследуется от JsonResource (Просмотреть исходный код)

Трейты

Свойства

смешанный	$resource	Экземпляр ресурса.	из JsonResource
массив	$with	Дополнительные данные, которые должны быть добавлены в массив ресурса верхнего уровня.	из JsonResource
массив	$additional	Дополнительные метаданные, которые должны быть добавлены в ответ ресурса.	из JsonResource
статическая строка	$wrap	Обёртка "данные", которая должна быть применена.	из JsonResource

Методы

array	filter(array $data) Фильтр указанных данных, удаляя любые необязательные значения.	из ConditionallyLoadsAttributes
array	mergeData(array $data, int $index, array $merge, bool $numericKeys) Объединить заданные данные в заданном индексе.	из ConditionallyLoadsAttributes
array	removeMissingValues(array $data, bool $numericKeys = false) Удалить отсутствующие значения из отфильтрованных данных.	из 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	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
static void	throwBadMethodCallException(string $method) Выбросить исключение плохого вызова метода для заданного метода.	из ForwardsCalls
mixed	getRouteKey() Получить значение ключа маршрута ресурса.	из DelegatesToResource
string	getRouteKeyName() Получить ключ маршрута для ресурса.	из DelegatesToResource
void	resolveRouteBinding(mixed $value) Получить модель для связанного значения.	из 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) Создать новый экземпляр ресурса.	из JsonResource
static JsonResource	make(mixed ...$parameters) Создать новый экземпляр ресурса.	из JsonResource
static AnonymousResourceCollection	collection(mixed $resource) Создать новую анонимную коллекцию ресурсов.	из JsonResource

массив	resolve(Запрос\|null $request = null) Преобразовать ресурс в массив.	из JsonResource
массив	toArray(Запрос $request) Преобразовать ресурс в массив.	из JsonResource
массив	with(Запрос $request) Получить дополнительные данные, которые должны быть возвращены с массивом ресурсов.	из JsonResource
$this	additional(массив $data) Добавить дополнительные метаданные к ответу ресурса.	из JsonResource
void	withResponse(Запрос $request, JsonResponse $response) Настроить ответ для запроса.	из JsonResource
static void	wrap(строка $value) Установить строку, которая должна обернуть внешний массив ресурсов.	из JsonResource
static void	withoutWrapping() Отключить обертывание внешнего массива ресурсов.	из JsonResource
JsonResponse	response(Запрос\|null $request = null) Преобразовать ресурс в HTTP-ответ.	из JsonResource
Response	toResponse(Запрос $request) Создать HTTP-ответ, представляющий объект.	из JsonResource
массив	jsonSerialize() Подготовить ресурс для сериализации в формате JSON.	из JsonResource

Подробности

protected массив filter(массив $data)

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

Параметры

массив

$data

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

массив

protected массив mergeData(массив $data, целое $index, массив $merge, логическое $numericKeys)

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

Параметры

массив	$data
целое	$index
массив	$merge
логическое	$numericKeys

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

массив

protected массив removeMissingValues(массив $data, логическое $numericKeys = ложь)

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

Параметры

массив	$data
логическое	$numericKeys

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

массив

protected MissingValue|смешанное when(логическое $condition, смешанное $value, смешанное $default = null)

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

Параметры

логическое	$condition
смешанное	$value
смешанное	$default

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

MissingValue|смешанное

protected MergeValue|смешанное merge(смешанное $value)

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

Параметры

смешанное

$value

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

MergeValue|смешанное

protected MergeValue|смешанное mergeWhen(логическое $condition, смешанное $value)

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

Параметры

логическое	$condition
смешанное	$value

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

MergeValue|смешанное

protected MergeValue attributes(массив $attributes)

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

Параметры

массив

$attributes

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

MergeValue

protected MissingValue|смешанное whenLoaded(строка $relationship, смешанное $value = null, смешанное $default = null)

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

Параметры

строка	$relationship
смешанное	$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|смешанное

END_OF_DOCUMENT_MARKER

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)

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

Параметры

array

$data

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

$this

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/5.7/Illuminate/Http/Resources/Json/Resource.html