AnonymousResourceCollection
class AnonymousResourceCollection extends ResourceCollection (View source)
Свойства
| CollectsResources | |
| ConditionallyLoadsAttributes | |
| DelegatesToResource | |
| ForwardsCalls | |
| Macroable |
Свойства
| статический защищённый массив | $macros | Зарегистрированные строковые макросы. | из Macroable |
| смешанный тип | $resource | Экземпляр ресурса. | из JsonResource |
| массив | $with | Дополнительные данные, которые должны быть добавлены в массив ресурса верхнего уровня. | из JsonResource |
| массив | $additional | Дополнительные метаданные, которые должны быть добавлены в ответ ресурса. | из JsonResource |
| статический строка|null | $wrap | Обёртка "данные", которая должна быть применена. | из JsonResource |
| строка | $collects | Имя собираемого ресурса. | |
| Collection | $collection | Экземпляр сопоставленного набора. | из ResourceCollection |
| защищённый булево значение | $preserveAllQueryParameters | Указывает, должны ли быть добавлены все существующие параметры запроса к ссылкам на постраничную навигацию. | из ResourceCollection |
| защищённый массив|null | $queryParameters | Параметры запроса, которые должны быть добавлены к ссылкам на постраничную навигацию. | из ResourceCollection |
| bool | $preserveKeys | Указывает, должны ли сохраняться ключи коллекции. |
Методы
| 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 |
| MissingValue|mixed | unless(bool $condition, mixed $value, mixed $default = null)
Получить значение, если заданное «условие» ложно. | из ConditionallyLoadsAttributes |
| MergeValue|mixed | merge(mixed $value)
Объединить значение в массив. | из ConditionallyLoadsAttributes |
| MergeValue|смешанный | mergeWhen(bool $condition, смешанный $value, смешанный $default = null)
Объединить значение, если заданное условие истинно. | из ConditionallyLoadsAttributes |
| MergeValue|смешанный | mergeUnless(bool $condition, смешанный $value, смешанный $default = null)
Объединить значение, если заданное условие ложно. | из ConditionallyLoadsAttributes |
| MergeValue | attributes(array $attributes)
Объединить заданные атрибуты. | из ConditionallyLoadsAttributes |
| MissingValue|смешанный | whenHas(string $attribute, смешанный $value = null, смешанный $default = null)
Получить атрибут, если он существует в ресурсе. | из ConditionallyLoadsAttributes |
| MissingValue|смешанный | whenNull(смешанный $value, смешанный $default = null)
Получить атрибут модели, если он равен null. | из ConditionallyLoadsAttributes |
| MissingValue|mixed | whenNotNull(mixed $value, mixed $default = null)
Получить атрибут модели, если он не равен null. | from ConditionallyLoadsAttributes |
| MissingValue|mixed | whenAppended(string $attribute, mixed $value = null, mixed $default = null)
Получить аксессор, если он был добавлен. | from ConditionallyLoadsAttributes |
| MissingValue|mixed | whenLoaded(string $relationship, mixed $value = null, mixed $default = null)
Получить отношение, если оно было загружено. | from ConditionallyLoadsAttributes |
| MissingValue|mixed | whenCounted(string $relationship, mixed $value = null, mixed $default = null)
Получить количество отношения, если оно существует. | from ConditionallyLoadsAttributes |
| MissingValue|mixed | whenAggregated(string $relationship, string $column, string $aggregate, mixed $value = null, mixed $default = null)
Получить агрегированное значение отношения, если оно существует. | from ConditionallyLoadsAttributes |
| MissingValue|mixed | whenPivotLoaded(string $table, mixed $value, mixed $default = null)
Выполнить обратный вызов, если указанная сводная таблица была загружена. | from ConditionallyLoadsAttributes |
| MissingValue|mixed | whenPivotLoadedAs(string $accessor, string $table, mixed $value, mixed $default = null)
Выполнить обратный вызов, если указанная сводная таблица с пользовательским аксессором была загружена. | from ConditionallyLoadsAttributes |
| bool | hasPivotLoaded(string $table)
Определить, загружена ли для ресурса указанная сводная таблица. | from ConditionallyLoadsAttributes |
| bool | hasPivotLoadedAs(string $accessor, string $table)
Определить, загружена ли для ресурса указанная сводная таблица с пользовательским аксессором. | from ConditionallyLoadsAttributes |
| mixed | transform(mixed $value, callable $callback, mixed $default = null)
Преобразовать заданное значение, если оно присутствует. | from ConditionallyLoadsAttributes |
| mixed | forwardCallTo(mixed $object, string $method, array $parameters)
Передать вызов метода заданному объекту. | from ForwardsCalls |
| mixed | forwardDecoratedCallTo(mixed $object, string $method, array $parameters)
Передать вызов метода заданному объекту, возвращая $this, если переданный вызов вернул себя. | from 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, string $collects)
Создать новую анонимную коллекцию ресурсов. | |
| 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-массив. | from ResourceCollection |
| 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-ответ, представляющий объект. | from ResourceCollection |
| массив | jsonSerialize()
Подготовьте ресурс для сериализации в формате JSON. | from JsonResource |
| mixed | collectResource(mixed $resource)
Преобразуйте заданный ресурс коллекции в отдельные ресурсы. | from CollectsResources |
| строка|null | collects()
Получить ресурс, который собирает этот ресурс. | from CollectsResources |
| Traversable | getIterator()
Получить итератор для коллекции ресурсов. | from CollectsResources |
| $this | preserveQuery()
Указать, что все текущие параметры запроса должны быть добавлены к ссылкам на страницы пагинации. | from ResourceCollection |
| $this | withQuery(array $query)
Указать параметры строки запроса, которые должны быть присутствовать в ссылках на страницы пагинации. | from ResourceCollection |
| int | count()
Возвращает количество элементов в коллекции ресурсов. | из ResourceCollection |
| JsonResponse | preparePaginatedResponse(Request $request)
Создаёт HTTP-ответ, учитывающий пагинацию. | из ResourceCollection |
Подробности
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, mixed $default = null)
Объединить значение, если заданное условие истинно.
protected MergeValue|mixed mergeUnless(bool $condition, mixed $value, mixed $default = null)
Объединить значение, если заданное условие ложно.
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|mixed whenCounted(string $relationship, mixed $value = null, mixed $default = null)
Получить количество отношения, если оно существует.
MissingValue|mixed whenAggregated(string $relationship, string $column, string $aggregate, mixed $value = null, mixed $default = null)
Получить агрегированное значение отношения, если оно существует.
protected MissingValue|mixed whenPivotLoaded(string $table, mixed $value, mixed $default = null)
Выполнить обратный вызов, если указанная вспомогательная таблица загружена.
protected MissingValue|mixed whenPivotLoadedAs(string $accessor, string $table, mixed $value, mixed $default = null)
Выполнить обратный вызов, если указанная вспомогательная таблица с пользовательским аксессором загружена.
protected bool hasPivotLoaded(string $table)
Определить, загружена ли у ресурса указанная сводная таблица.
protected bool hasPivotLoadedAs(string $accessor, string $table)
Определить, загружена ли у ресурса указанная сводная таблица с пользовательским аксессором.
protected mixed transform(mixed $value, callable $callback, mixed $default = null)
Преобразовать заданное значение, если оно присутствует.
protected mixed forwardCallTo(mixed $object, string $method, array $parameters)
Перенаправить вызов метода заданному объекту.
protected mixed forwardDecoratedCallTo(mixed $object, string $method, array $parameters)
Перенаправить вызов метода заданному объекту, вернув $this, если перенаправленный вызов вернул себя.
static protected void throwBadMethodCallException(string $method)
Выбросить исключение для неверного вызова метода.
static void macro(string $name, object|callable $macro)
Зарегистрировать пользовательский макрос.
static void mixin(object $mixin, bool $replace = true)
Смешать другой объект в класс.
static bool hasMacro(string $name)
Проверяет, зарегистрирована ли макрокоманда.
static void flushMacros()
Очистить существующие макросы.
static mixed __callStatic(string $method, array $parameters)
Динамически обрабатывать вызовы класса.
mixed __call(string $method, array $parameters)
Динамически обрабатывает вызовы класса.
mixed getRouteKey()
Получить значение ключа маршрута ресурса.
string getRouteKeyName()
Получить ключ маршрута для ресурса.
void resolveRouteBinding(mixed $value, string|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, string $collects)
Создать новую коллекцию анонимных ресурсов.
static JsonResource make(mixed ...$parameters)
Создать новый экземпляр ресурса.
static AnonymousResourceCollection collection(mixed $resource)
Создать новый анонимный ресурс.
static protected AnonymousResourceCollection newCollection(mixed $resource)
Создать новый экземпляр коллекции ресурсов.
array resolve(Request|null $request = null)
Преобразовать ресурс в массив.
array|Arrayable|JsonSerializable toArray(Request $request)
Преобразовать ресурс в JSON массив.
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-ответ.
Ответ toResponse(Запрос $request)
Создать HTTP-ответ, представляющий объект.
массив jsonSerialize()
Подготовить ресурс для сериализации в формате JSON.
protected смешанный тип collectResource(смешанный тип $resource)
Преобразовать заданный коллекционный ресурс в отдельные ресурсы.
protected строка|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/10.x/Illuminate/Http/Resources/Json/AnonymousResourceCollection.html
