AnonymousResourceCollection
class AnonymousResourceCollection extends ResourceCollection (View source)
Трейты
| CollectsResources | |
| ConditionallyLoadsAttributes | |
| DelegatesToResource | |
| ForwardsCalls |
Свойства
| mixed | $resource | Экземпляр ресурса. | из JsonResource |
| array | $with | Дополнительные данные, которые должны быть добавлены в массив ресурса верхнего уровня. | из JsonResource |
| array | $additional | Дополнительные метаданные, которые должны быть добавлены в ответ ресурса. | из JsonResource |
| static string | $wrap | Обёртка "data", которая должна быть применена. | из JsonResource |
| string | $collects | Имя собираемого ресурса. | |
| Collection | $collection | Экземпляр отображённой коллекции. | из ResourceCollection |
| protected bool | $preserveAllQueryParameters | Указывает, должны ли быть добавлены все существующие параметры запроса к ссылкам постраничной навигации. | из ResourceCollection |
| protected array|null | $queryParameters | Параметры запроса, которые должны быть добавлены к ссылкам постраничной навигации. | из ResourceCollection |
Методы
| 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 | whenAppended(string $attribute, mixed $value = null, mixed $default = null) Получить аксессор, когда он был добавлен. | из 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, 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 |
| mixed | __call(string $method, array $parameters) Динамически передать вызовы методов базовому ресурсу. | из DelegatesToResource |
| void | __construct(mixed $resource, string $collects) Создать новую анонимную коллекцию ресурсов. |
| static JsonResource | make(mixed ...$parameters)
Создать новый экземпляр ресурса. | from JsonResource |
| static AnonymousResourceCollection | collection(mixed $resource)
Создать новую коллекцию анонимных ресурсов. | from JsonResource |
| array | resolve(Request|null $request = null)
Разрешить ресурс в массив. | from JsonResource |
| array | 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 |
| 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 |
| array | jsonSerialize()
Подготовить ресурс для сериализации в JSON. | from JsonResource |
| mixed | collectResource(mixed $resource)
Преобразовать заданный ресурс коллекции в отдельные ресурсы. | from CollectsResources |
| string|null | collects()
Получить ресурс, который собирает этот ресурс. | from CollectsResources |
| ArrayIterator | getIterator()
Получить итератор для коллекции ресурсов. | from CollectsResources |
| $this | preserveQuery()
Указать, что все текущие параметры запроса должны быть добавлены к ссылкам на постраничность. | from ResourceCollection |
| $this | withQuery(array $query)
Указать параметры строки запроса, которые должны быть присутствовать в ссылках на постраничность. | from ResourceCollection |
| int | count()
Возвращает количество элементов в коллекции ресурсов. | from ResourceCollection |
| JsonResponse | preparePaginatedResponse(Request $request)
Создать HTTP-ответ, учитывающий постраничность. | from 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)
Получить значение на основе заданного условия.
protected MergeValue|mixed merge(mixed $value)
Объединить значение в массив.
protected MergeValue|mixed mergeWhen(bool $condition, mixed $value)
Объединить значение на основе заданного условия.
protected MergeValue attributes(array $attributes)
Объединить заданные атрибуты.
protected MissingValue|mixed whenAppended(string $attribute, mixed $value = null, mixed $default = null)
Получить аксессор, если он был добавлен.
protected MissingValue|mixed whenLoaded(string $relationship, 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 mixed transform(mixed $value, callable $callback, mixed $default = null)
Преобразовать заданное значение, если оно присутствует.
protected mixed forwardCallTo(mixed $object, string $method, array $parameters)
Перенаправить вызов метода заданному объекту.
static protected void throwBadMethodCallException(string $method)
Выбросить исключение BadMethodCall для заданного метода.
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)
Динамически получаем свойства из базового ресурса.
mixed __call(string $method, array $parameters)
Динамически передаем вызовы методов базовому ресурсу.
void __construct(mixed $resource, string $collects)
Создайте новый анонимный ресурс.
static JsonResource make(mixed ...$parameters)
Создайте новый экземпляр ресурса.
static AnonymousResourceCollection collection(mixed $resource)
Создайте новый анонимный ресурс.
array resolve(Request|null $request = null)
Преобразуйте ресурс в массив.
array toArray(Request $request)
Преобразуйте ресурс в массив JSON.
string toJson(int $options = 0)
Преобразуйте экземпляр модели в JSON.
array with(Request $request)
Получите дополнительные данные, которые должны быть возвращены с массивом ресурса.
$this additional(array $data)
Добавьте дополнительные метаданные к ответу ресурса.
void withResponse(Request $request, JsonResponse $response)
Настройте ответ для запроса.
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()
Получите ресурс, который собирается этим ресурсом.
ArrayIterator 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/7.x/Illuminate/Http/Resources/Json/AnonymousResourceCollection.html
