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 |
Методы
| 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, string $collects) Создать новый анонимный ресурсный сборник. | |
| static JsonResource | make(mixed ...$parameters) Создать новый экземпляр ресурса. | из JsonResource |
| static AnonymousResourceCollection | collection(mixed $resource) Создать новый анонимный ресурсный сборник. | из JsonResource |
| массив | resolve(Запрос|null $request = null) Преобразовать ресурс в массив. | из JsonResource |
| массив | toArray(Запрос $request) Преобразовать ресурс в JSON-массив. | из ResourceCollection |
| массив | with(Запрос $request) Получить дополнительные данные, которые должны быть возвращены с ресурсом в массиве. | из JsonResource |
| $this | additional(массив $data) Добавить дополнительные метаданные к ответу ресурса. | из JsonResource |
| void | withResponse(Запрос $request, JsonResponse $response) Настроить ответ для запроса. | из JsonResource |
| static void | wrap(строка $value) Установить строку, которая должна обернуть внешний массив ресурсов. | из JsonResource |
| static void | withoutWrapping() Отключить обёртку внешнего массива ресурсов. | из JsonResource |
| JsonResponse | response(Запрос|null $request = null) Преобразовать ресурс в HTTP-ответ. | из JsonResource |
| Ответ | toResponse(Запрос $request) Создать HTTP-ответ, представляющий объект. | из ResourceCollection |
| массив | jsonSerialize() Подготовить ресурс к сериализации в JSON. | из JsonResource |
| mixed | collectResource(mixed $resource) Преобразовать заданный ресурс коллекции в отдельные ресурсы. | из CollectsResources |
| строка|null | collects() Получить ресурс, который собирает этот ресурс. | из CollectsResources |
| ArrayIterator | getIterator() Получить итератор для коллекции ресурсов. | из CollectsResources |
| целое | count() Возвращает количество элементов в коллекции ресурсов. | из ResourceCollection |
Подробности
protected массив filter(массив $data)
Фильтрует заданные данные, удаляя любые необязательные значения.
protected массив mergeData(массив $data, целое $index, массив $merge, bool $numericKeys)
Объединить заданные данные в заданном индексе.
protected массив removeMissingValues(массив $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(массив $attributes)
Объединить заданные атрибуты.
protected MissingValue|mixed whenLoaded(строка $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)
Получить модель для связанного значения.
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)
Создать новую анонимную коллекцию ресурсов.
массив resolve(Запрос|null $request = null)
Преобразовать ресурс в массив.
массив toArray(Запрос $request)
Преобразовать ресурс в JSON массив.
массив with(Запрос $request)
Получить дополнительные данные, которые должны быть возвращены с массивом ресурса.
$this additional(массив $data)
Добавить дополнительные метаданные к ответу ресурса.
пусто withResponse(Запрос $request, JsonResponse $response)
Настроить ответ для запроса.
статический пусто wrap(строка $value)
Установить строку, которая должна обернуть самый внешний массив ресурса.
статический пусто withoutWrapping()
Отключить обертывание самого внешнего массива ресурса.
JsonResponse response(Запрос|null $request = null)
Преобразовать ресурс в HTTP ответ.
Ответ toResponse(Запрос $request)
Создать HTTP ответ, который представляет объект.
массив jsonSerialize()
Подготовить ресурс для сериализации в JSON.
защищённый смешанный collectResource(смешанный $resource)
Преобразовать данный ресурс-коллекцию в отдельные ресурсы.
защищённый строка|null collects()
Получить ресурс, который собирает этот ресурс.
ArrayIterator getIterator()
Получить итератор для коллекции ресурсов.
целое число count()
Возвратить количество элементов в коллекции ресурсов.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.8/Illuminate/Http/Resources/Json/AnonymousResourceCollection.html
