ResourceCollection
class ResourceCollection extends JsonResource implements Countable, IteratorAggregate (View source)
Свойства
| CollectsResources | |
| ConditionallyLoadsAttributes | |
| DelegatesToResource | |
| ForwardsCalls | |
| Macroable |
Свойства
| static protected array | $macros | Зарегистрированные строковые макросы. | from Macroable |
| mixed | $resource | Экземпляр ресурса. | from JsonResource |
| array | $with | Дополнительные данные, которые должны быть добавлены в массив ресурса верхнего уровня. | from JsonResource |
| array | $additional | Дополнительные метаданные, которые должны быть добавлены в ответ ресурса. | from JsonResource |
| static string|null | $wrap | Обёртка "data", которая должна быть применена. | from JsonResource |
| string | $collects | Ресурс, который собирается этим ресурсом. | |
| Collection | $collection | Экземпляр сопоставленного набора. | |
| protected bool | $preserveAllQueryParameters | Указывает, должны ли все существующие параметры запроса быть добавлены к ссылкам на постраничную навигацию. | |
| protected array|null | $queryParameters | Параметры запроса, которые должны быть добавлены к ссылкам на постраничную навигацию. |
Методы
| массив | filter(массив $data)
Отфильтровать заданные данные, удалив все необязательные значения. | из ConditionallyLoadsAttributes |
| массив | mergeData(массив $data, целое число $index, массив $merge, логическое значение $numericKeys)
Объединить заданные данные по заданному индексу. | из ConditionallyLoadsAttributes |
| массив | removeMissingValues(массив $data)
Удалить отсутствующие значения из отфильтрованных данных. | из ConditionallyLoadsAttributes |
| MissingValue|смешанный тип | when(логическое значение $condition, смешанный тип $value, смешанный тип $default = null)
Получить значение, если заданное «условие» истинно. | из ConditionallyLoadsAttributes |
| MissingValue|смешанный тип | unless(логическое значение $condition, смешанный тип $value, смешанный тип $default = null)
Получить значение, если заданное «условие» ложно. | из ConditionallyLoadsAttributes |
| MergeValue|смешанный тип | merge(смешанный тип $value)
Объединить значение в массив. | из ConditionallyLoadsAttributes |
| MergeValue|смешанный тип | mergeWhen(логическое значение $condition, смешанный тип $value)
Объединить значение, если заданное условие истинно. | из ConditionallyLoadsAttributes |
| MergeValue|смешанный тип | mergeUnless(логическое значение $condition, смешанный тип $value)
Объединить значение, если заданное условие ложно. | из ConditionallyLoadsAttributes |
| MergeValue | attributes(массив $attributes)
Объединить заданные атрибуты. | из ConditionallyLoadsAttributes |
| MissingValue|смешанный тип | whenHas(строка $attribute, смешанный тип $value = null, смешанный тип $default = null)
Получить атрибут, если он существует в ресурсе. | из ConditionallyLoadsAttributes |
| MissingValue|смешанный тип | whenNull(смешанный тип $value, смешанный тип $default = null)
Получить атрибут модели, если он равен null. | из ConditionallyLoadsAttributes |
| MissingValue|смешанный тип | whenNotNull(смешанный тип $value, смешанный тип $default = null)
Получить атрибут модели, если он не равен null. | из ConditionallyLoadsAttributes |
| MissingValue|смешанный тип | whenAppended(строка $attribute, смешанный тип $value = null, смешанный тип $default = null)
Получить аксессор, если он был добавлен. | из ConditionallyLoadsAttributes |
| MissingValue|смешанный тип | whenLoaded(строка $relationship, смешанный тип $value = null, смешанный тип $default = null)
Получить отношение, если оно было загружено. | из ConditionallyLoadsAttributes |
| MissingValue|смешанный тип | whenCounted(строка $relationship, смешанный тип $value = null, смешанный тип $default = null)
Получить количество отношения, если оно существует. | из ConditionallyLoadsAttributes |
| MissingValue|смешанный тип | whenPivotLoaded(строка $table, смешанный тип $value, смешанный тип $default = null)
Выполнить обратный вызов, если заданная таблица связей была загружена. | из ConditionallyLoadsAttributes |
| MissingValue|смешанный тип | whenPivotLoadedAs(строка $accessor, строка $table, смешанный тип $value, смешанный тип $default = null)
Выполнить обратный вызов, если заданная таблица связей с пользовательским аксессором была загружена. | из ConditionallyLoadsAttributes |
| смешанный тип | transform(смешанный тип $value, вызываемый объект $callback, смешанный тип $default = null)
Преобразовать заданное значение, если оно присутствует. | из ConditionallyLoadsAttributes |
| смешанный тип | forwardCallTo(смешанный тип $object, строка $method, массив $parameters)
Перенаправить вызов метода заданному объекту. | из ForwardsCalls |
| смешанный тип | forwardDecoratedCallTo(смешанный тип $object, строка $method, массив $parameters)
Перенаправить вызов метода заданному объекту, вернув $this, если перенаправленный вызов вернул себя. | из ForwardsCalls |
| статический void | throwBadMethodCallException(строка $method)
Выбросить исключение плохого вызова метода для данного метода. | из ForwardsCalls |
| статический void | macro(строка $name, объект|вызываемый объект $macro)
Зарегистрировать пользовательское макро. | из Macroable |
| статический void | mixin(объект $mixin, логическое значение $replace = true)
Вставить другой объект в класс. | из Macroable |
| статический логическое значение | hasMacro(строка $name)
Проверяет, зарегистрировано ли макро. | из Macroable |
| статический void | flushMacros()
Очистить существующие макросы. | из Macroable |
| static mixed | __callStatic(string $method, array $parameters)
Динамически обрабатывает вызовы класса. | из Macroable |
| mixed | __call(string $method, array $parameters)
Динамически обрабатывает вызовы класса. | из Macroable |
| mixed | getRouteKey()
Получить значение ключа маршрута ресурса. | из DelegatesToResource |
| string | getRouteKeyName()
Получить ключ маршрута для ресурса. | из DelegatesToResource |
| void | resolveRouteBinding(mixed $value, string|null $field = null)
Получить модель для привязанного значения. | из DelegatesToResource |
| void | resolveChildRouteBinding(string $childType, mixed $value, string|null $field = null)
Получить модель для привязанного значения. | из 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 |
| void | __construct(mixed $resource)
Создать новый экземпляр ресурса. | |
| static JsonResource | make(mixed ...$parameters)
Создать новый экземпляр ресурса. | из JsonResource |
| static AnonymousResourceCollection | collection(mixed $resource)
Создать новый анонимный набор ресурсов. | из JsonResource |
| array | resolve(Request|null $request = null)
Разрешить ресурс в массив. | из JsonResource |
| array|Arrayable|JsonSerializable | toArray(Request $request)
Преобразовать ресурс в массив JSON. | |
| string | toJson(int $options = 0)
Преобразовать экземпляр модели в JSON. | из JsonResource |
| array | with(Request $request)
Получить дополнительные данные, которые должны быть возвращены с массивом ресурса. | из JsonResource |
| $this | additional(array $data)
Добавить дополнительные метаданные к ответу ресурса. | из JsonResource |
| int | jsonOptions()
Получить параметры сериализации JSON, которые должны быть применены к ответу ресурса. | из CollectsResources |
| 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-ответ, представляющий объект. | |
| array | jsonSerialize()
Подготовить ресурс к сериализации в JSON. | из JsonResource |
| mixed | collectResource(mixed $resource)
Преобразовать предоставленный ресурс коллекции в отдельные ресурсы. | из CollectsResources |
| string|null | collects()
Получить ресурс, который собирается этим ресурсом. | из CollectsResources |
| Traversable | getIterator()
Получить итератор для коллекции ресурсов. | из CollectsResources |
| $this | preserveQuery()
Указать, что все текущие параметры запроса должны быть добавлены к ссылкам на страницы. | |
| $this | withQuery(array $query)
Указать параметры строки запроса, которые должны присутствовать в ссылках на страницы. | |
| int | count()
Возвратить количество элементов в коллекции ресурсов. | |
| JsonResponse | preparePaginatedResponse(Request $request)
Создать HTTP-ответ, учитывающий пагинацию. |
Подробности
protected array filter(array $data)
Отфильтровать заданные данные, удалив любые необязательные значения.
protected array mergeData(array $data, int $index, array $merge, bool $numericKeys)
Объединить заданные данные в заданном индексе.
protected array removeMissingValues(array $data)
Удалить отсутствующие значения из отфильтрованных данных.
protected MissingValue|mixed when(bool $condition, mixed $value, mixed $default = null)
Получить значение, если заданное «условие» истинно.
MissingValue|mixed unless(bool $condition, mixed $value, mixed $default = null)
Получить значение, если заданное «условие» ложно.
protected MergeValue|mixed merge(mixed $value)
Объединить значение в массив.
protected MergeValue|mixed mergeWhen(bool $condition, mixed $value)
Объединить значение, если заданное условие истинно.
protected MergeValue|mixed mergeUnless(bool $condition, mixed $value)
Объединить значение, если заданное условие ложно.
protected MergeValue attributes(array $attributes)
Объединить заданные атрибуты.
MissingValue|mixed whenHas(string $attribute, mixed $value = null, mixed $default = null)
Получить атрибут, если он существует в ресурсе.
protected MissingValue|mixed whenNull(mixed $value, mixed $default = null)
Получить атрибут модели, если он равен null.
protected MissingValue|mixed whenNotNull(mixed $value, mixed $default = null)
Получить атрибут модели, если он не равен null.
protected MissingValue|mixed whenAppended(string $attribute, mixed $value = null, mixed $default = null)
Получить аксессор, если он добавлен.
protected MissingValue|mixed whenLoaded(string $relationship, mixed $value = null, mixed $default = null)
Получить отношение, если оно загружено.
MissingValue|смешанный whenCounted(строка $relationship, смешанный $value = null, смешанный $default = null)
Получить количество отношений, если оно существует.
protected MissingValue|смешанный whenPivotLoaded(строка $table, смешанный $value, смешанный $default = null)
Выполнить обратный вызов, если заданная сводная таблица загружена.
protected MissingValue|смешанный whenPivotLoadedAs(строка $accessor, строка $table, смешанный $value, смешанный $default = null)
Выполнить обратный вызов, если заданная сводная таблица с пользовательским аксессором загружена.
protected смешанный transform(смешанный $value, вызов $callback, смешанный $default = null)
Преобразовать заданное значение, если оно присутствует.
protected смешанный forwardCallTo(смешанный $object, строка $method, массив $parameters)
Перенаправить вызов метода заданному объекту.
protected смешанный forwardDecoratedCallTo(смешанный $object, строка $method, массив $parameters)
Перенаправить вызов метода заданному объекту, вернув $this, если перенаправленный вызов вернул себя.
static protected void throwBadMethodCallException(строка $method)
Выбросить исключение вызова неверного метода для заданного метода.
static void macro(строка $name, объект|вызов $macro)
Зарегистрировать пользовательский макрос.
static void mixin(объект $mixin, bool $replace = true)
Смешать другой объект в класс.
static bool hasMacro(строка $name)
Проверка, зарегистрирован ли макрос.
static void flushMacros()
Очистить существующие макросы.
static смешанный __callStatic(строка $method, массив $parameters)
Динамически обработать вызовы класса.
смешанный __call(строка $method, массив $parameters)
Динамически обработать вызовы класса.
смешанный getRouteKey()
Получить значение ключа маршрута ресурса.
строка getRouteKeyName()
Получить ключ маршрута для ресурса.
void resolveRouteBinding(смешанный $value, строка|null $field = null)
Получить модель для связанного значения.
void resolveChildRouteBinding(string $childType, mixed $value, string|null $field = null)
Получить модель для связанного значения.
bool offsetExists(mixed $offset)
Определить, существует ли заданное атрибут.
mixed offsetGet(mixed $offset)
Получить значение для заданного смещения.
void offsetSet(mixed $offset, mixed $value)
Установить значение для заданного смещения.
void offsetUnset(mixed $offset)
Удалить значение для заданного смещения.
bool __isset(string $key)
Определить, существует ли атрибут в ресурсе.
void __unset(string $key)
Удалить атрибут из ресурса.
mixed __get(string $key)
Динамически получить свойства из базового ресурса.
void __construct(mixed $resource)
Создать новый экземпляр ресурса.
static JsonResource make(mixed ...$parameters)
Создать новый экземпляр ресурса.
static AnonymousResourceCollection collection(mixed $resource)
Создать новую коллекцию анонимных ресурсов.
array resolve(Запрос|null $request = null)
Разрешить ресурс в массив.
array|Arrayable|JsonSerializable toArray(Запрос $request)
Преобразовать ресурс в массив JSON.
string toJson(int $options = 0)
Преобразовать экземпляр модели в JSON.
array with(Запрос $request)
Получить дополнительные данные, которые должны быть возвращены с массивом ресурсов.
$this additional(array $data)
Добавить дополнительные метаданные к ответу ресурса.
int jsonOptions()
Получить параметры сериализации JSON, которые должны быть применены к ответу ресурса.
static void wrap(string $value)
Установить строку, которая должна обернуть внешний массив ресурсов.
static void withoutWrapping()
Отключить обёртку внешнего массива ресурсов.
JsonResponse response(Request|null $request = null)
Преобразовать ресурс в HTTP-ответ.
Response toResponse(Request $request)
Создать HTTP-ответ, представляющий объект.
array jsonSerialize()
Подготовить ресурс для сериализации в формате JSON.
protected mixed collectResource(mixed $resource)
Преобразовать данный коллекционный ресурс в отдельные ресурсы.
protected string|null collects()
Получить ресурс, который собирает этот ресурс.
Traversable getIterator()
Получить итератор для коллекции ресурсов.
$this preserveQuery()
Указать, что все текущие параметры запроса должны быть добавлены к ссылкам на постраничную навигацию.
$this withQuery(array $query)
Указать параметры строки запроса, которые должны присутствовать в ссылках на постраничную навигацию.
int count()
Возвращает количество элементов в коллекции ресурсов.
protected JsonResponse preparePaginatedResponse(Request $request)
Создать HTTP-ответ, учитывающий постраничный вывод.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/9.x/Illuminate/Http/Resources/Json/ResourceCollection.html
