ResourceCollection

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

Свойства

static protected array	$macros	Зарегистрированные строковые макросы.	from Macroable
mixed	$resource	Экземпляр ресурса.	from JsonResource
array	$with	Дополнительные данные, которые должны быть добавлены в массив ресурса верхнего уровня.	from JsonResource
array	$additional	Дополнительные метаданные, которые должны быть добавлены в ответ ресурса.	from JsonResource
static string\|null	$wrap	Обёртка «данные», которая должна быть применена.	from 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) Получить значение, если заданное «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) Создать новый экземпляр ресурса.	from JsonResource
static AnonymousResourceCollection	collection(mixed $resource) Создать новую коллекцию анонимных ресурсов.	from JsonResource
static AnonymousResourceCollection	newCollection(mixed $resource) Создать новый экземпляр коллекции ресурсов.	from JsonResource
array	resolve(Request\|null $request = null) Разрешить ресурс в массив.	from JsonResource
array\|Arrayable\|JsonSerializable	toArray(Request $request) Преобразовать ресурс в массив JSON.
string	toJson(int $options = 0) Преобразовать экземпляр модели в JSON.	from JsonResource
array	with(Request $request) Получить любые дополнительные данные, которые должны быть возвращены с массивом ресурса.	from JsonResource
$this	additional(array $data) Добавить дополнительные метаданные в ответ ресурса.	from JsonResource
int	jsonOptions() Получить параметры сериализации JSON, которые должны быть применены к ответу ресурса.	from CollectsResources
void	withResponse(Request $request, JsonResponse $response) Настроить ответ для запроса.	from JsonResource
static void	wrap(string $value) Установить строку, которая должна оборачивать самый внешний массив ресурса.	from JsonResource

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

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)

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

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|mixed whenAggregated(string $relationship, string $column, string $aggregate, mixed $value = null, mixed $default = null)

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

Parameters

string	$relationship
string	$column
string	$aggregate
mixed	$value
mixed	$default

Return Value

MissingValue|mixed

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

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

Parameters

string	$table
mixed	$value
mixed	$default

Return Value

MissingValue|mixed

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

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

Parameters

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

Return Value

MissingValue|mixed

protected bool hasPivotLoaded(string $table)

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

Parameters

string

$table

Return Value

bool

protected bool hasPivotLoadedAs(string $accessor, string $table)

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

Parameters

string	$accessor
string	$table

Return Value

bool

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

static void macro(string $name, object|callable $macro)

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

Parameters

string	$name
object\|callable	$macro

Return Value

void

static void mixin(object $mixin, bool $replace = true)

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

Parameters

object	$mixin
bool	$replace

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

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

Параметры

string

$name

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

bool

static void flushMacros()

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

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

void

static mixed __callStatic(string $method, array $parameters)

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

Параметры

string	$method
array	$parameters

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

mixed

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Параметры

string	$method
array	$parameters

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

mixed

Исключения

BadMethodCallException

mixed getRouteKey()

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

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

mixed

string getRouteKeyName()

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

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

string

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

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

Параметры

mixed	$value
string\|null	$field

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

void

Исключения

Exception

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

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

Параметры

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

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

void

Исключения

Exception

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(Request|null $request = null)

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

Параметры

Request|null

$request

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

array

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

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

Параметры

Запрос

$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

static void wrap(string $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

Traversable getIterator()

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

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

Traversable

$this preserveQuery()

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

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

$this

$this withQuery(array $query)

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

Параметры

массив

$query

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

$this

int count()

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

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

int

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/11.x/Illuminate/Http/Resources/Json/ResourceCollection.html