ResourceCollection

class ResourceCollection extends JsonResource implements Countable, IteratorAggregate (View source)

Особенности

Свойства

mixed	$resource	Экземпляр ресурса.	из JsonResource
array	$with	Дополнительные данные, которые должны быть добавлены в массив ресурса верхнего уровня.	из JsonResource
array	$additional	Дополнительные метаданные, которые должны быть добавлены в ответ ресурса.	из JsonResource
static string	$wrap	Обёртка "data", которая должна быть применена.	из JsonResource
string	$collects	Ресурс, который собирается этим ресурсом.
Collection	$collection	Экземпляр отображённой коллекции.
protected bool	$preserveAllQueryParameters	Указывает, должны ли быть добавлены все имеющиеся параметры запроса в ссылки для пагинации.
protected array\|null	$queryParameters	Параметры запроса, которые должны быть добавлены в ссылки для пагинации.

Методы

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	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) Создать новый экземпляр ресурса.
static JsonResource	make(mixed ...$parameters) Создать новый экземпляр ресурса.	из JsonResource
static AnonymousResourceCollection	collection(mixed $resource) Создать новую коллекцию анонимных ресурсов.	из JsonResource
array	resolve(Request\|null $request = null) Разрешить ресурс в массив.	из JsonResource

массив	toArray(Request $request) Преобразовать ресурс в массив JSON.
массив	with(Request $request) Получить дополнительные данные, которые должны быть возвращены с ресурсным массивом.	из JsonResource
$this	additional(array $data) Добавить дополнительные метаданные в ответ ресурса.	из JsonResource
void	withResponse(Request $request, JsonResponse $response) Настроить ответ для запроса.	из JsonResource
static void	wrap(string $value) Установить строку, которая должна оборачивать внешний ресурсный массив.	из JsonResource
static void	withoutWrapping() Отключить оборачивание внешнего ресурсного массива.	из JsonResource
JsonResponse	response(Request\|null $request = null) Преобразовать ресурс в HTTP-ответ.	из JsonResource
Response	toResponse(Request $request) Создать HTTP-ответ, представляющий объект.
массив	jsonSerialize() Подготовить ресурс для сериализации в JSON.	из JsonResource
mixed	collectResource(mixed $resource) Преобразовать данный ресурс коллекции в отдельные ресурсы.	из CollectsResources
строка\|null	collects() Получить ресурс, который собирает этот ресурс.	из CollectsResources
ArrayIterator	getIterator() Получить итератор для коллекции ресурсов.	из CollectsResources
$this	preserveQuery() Указать, что все текущие параметры запроса должны быть добавлены к ссылкам постраничной навигации.
$this	withQuery(array $query) Указать параметры строки запроса, которые должны присутствовать в ссылках постраничной навигации.
int	count() Возвращает количество элементов в коллекции ресурсов.
JsonResponse	preparePaginatedResponse(Request $request) Создать HTTP-ответ, учитывающий пагинацию.

Подробности

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

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

Параметры

массив

$data

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

массив

protected массив mergeData(array $data, int $index, array $merge, bool $numericKeys)

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

Параметры

массив	$data
int	$index
массив	$merge
bool	$numericKeys

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

массив

protected массив removeMissingValues(array $data)

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

Параметры

массив

$data

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

массив

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)

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

Параметры

массив

$attributes

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

MergeValue

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

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

Параметры

строка	$relationship
mixed	$value
mixed	$default

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

MissingValue|mixed

END_OF_DOCUMENT_MARKER

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

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

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

Параметры

Запрос|null

$request

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

массив

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

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

Параметры

Запрос

$request

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

массив

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

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

Параметры

Запрос

$request

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

массив

$this additional(массив $data)

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

Параметры

массив

$data

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

$this

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

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

Параметры

Запрос	$request
JsonResponse	$response

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

void

static void wrap(строка $value)

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

Параметры

строка

$value

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

void

static void withoutWrapping()

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

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

void

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

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

Параметры

Запрос|null

$request

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

JsonResponse

Ответ toResponse(Запрос $request)

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

Параметры

Запрос

$request

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

Ответ

массив jsonSerialize()

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

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

массив

protected смешанный collectResource(смешанный $resource)

Преобразовать заданный коллекционный ресурс в отдельные ресурсы.

Параметры

смешанный

$resource

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

смешанный

protected строка|null collects()

Получить ресурс, который собирает этот ресурс.

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

строка|null

ArrayIterator getIterator()

Получить итератор для коллекции ресурсов.

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

ArrayIterator

$this preserveQuery()

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

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

$this

$this withQuery(массив $query)

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

Параметры

массив

$query

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

$this

целое число count()

Возвращает количество элементов в коллекции ресурсов.

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

целое число

protected JsonResponse preparePaginatedResponse(Запрос $request)

Создать HTTP-ответ, учитывающий постраничность.

Параметры

Запрос

$request

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

JsonResponse

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