AnonymousResourceCollection
class AnonymousResourceCollection extends ResourceCollection (View source)
Особенности
| CollectsResources |
| ConditionallyLoadsAttributes |
| DelegatesToResource |
Свойства
| mixed | $resource | Экземпляр ресурса. | from Resource |
| array | $with | Дополнительные данные, которые должны быть добавлены в массив ресурса верхнего уровня. | from Resource |
| array | $additional | Дополнительные метаданные, которые должны быть добавлены к ответу ресурса. | from Resource |
| static string | $wrap | Обёртка "данные", которая должна быть применена. | from Resource |
| string | $collects | Имя собираемого ресурса. | |
| Collection | $collection | Экземпляр сопоставленного набора. | from ResourceCollection |
Методы
| массив | filter(массив $data) Фильтрует заданные данные, удаляя любые необязательные значения. | из ConditionallyLoadsAttributes |
| массив | merge(массив $data, int $index, массив $merge) Объединяет заданные данные в указанном индексе. | из ConditionallyLoadsAttributes |
| MissingValue|смешанный тип | when(bool $condition, смешанный тип $value, смешанный тип $default = null) Возвращает значение, основанное на заданном условии. | из ConditionallyLoadsAttributes |
| MissingValue|смешанный тип | mergeWhen(bool $condition, смешанный тип $value) Объединяет значение, основанное на заданном условии. | из ConditionallyLoadsAttributes |
| MergeValue | attributes(массив $attributes) Объединяет заданные атрибуты. | из ConditionallyLoadsAttributes |
| MissingValue|смешанный тип | whenLoaded(строка $relationship, смешанный тип $value = null, смешанный тип $default = null) Возвращает отношение, если оно было загружено. | из ConditionallyLoadsAttributes |
| MissingValue|смешанный тип | whenPivotLoaded(строка $table, смешанный тип $value, смешанный тип $default = null) Выполняет обратный вызов, если заданная таблица связей была загружена. | из ConditionallyLoadsAttributes |
| смешанный тип | transform(смешанный тип $value, вызываемый объект $callback, смешанный тип $default = null) Преобразует заданное значение, если оно присутствует. | из ConditionallyLoadsAttributes |
| смешанный тип | getRouteKey() Получить значение ключа маршрута ресурса. | из DelegatesToResource |
| строка | getRouteKeyName() Получить ключ маршрута для ресурса. | из DelegatesToResource |
| void | resolveRouteBinding(смешанный тип $value) Получить модель для привязанного значения. | из DelegatesToResource |
| bool | offsetExists(смешанный тип $offset) Определить, существует ли данный атрибут. | из DelegatesToResource |
| смешанный тип | offsetGet(смешанный тип $offset) Получить значение для данного смещения. | из DelegatesToResource |
| void | offsetSet(смешанный тип $offset, смешанный тип $value) Установить значение для данного смещения. | из DelegatesToResource |
| void | offsetUnset(смешанный тип $offset) Удалить значение для данного смещения. | из DelegatesToResource |
| bool | __isset(строка $key) Определить, существует ли атрибут ресурса. | из DelegatesToResource |
| void | __unset(строка $key) Удалить атрибут ресурса. | из DelegatesToResource |
| смешанный тип | __get(строка $key) Динамически получить свойства из базового ресурса. | из DelegatesToResource |
| смешанный тип | __call(строка $method, массив $parameters) Динамически передавать вызовы методов базовому ресурсу. | из DelegatesToResource |
| void | __construct(смешанный тип $resource, строка $collects) Создать новый анонимный ресурсный сборник. | |
| статический Resource | make(динамический $parameters) Создать новый экземпляр ресурса. | из Resource |
| статический AnonymousResourceCollection | collection(смешанный тип $resource) Создать новый анонимный ресурсный сборник. | из Resource |
| массив | resolve(Request|null $request = null) Разрешить ресурс в массив. | из Resource |
| массив | toArray(Request $request) Преобразовать ресурс в массив JSON. | из ResourceCollection |
| массив | with(Request $request) Получить любые дополнительные данные, которые должны быть возвращены с массивом ресурса. | из Resource |
| $this | additional(массив $data) Добавить дополнительные метаданные к ответу ресурса. | из Resource |
| void | withResponse(Request $request, JsonResponse $response) Настроить ответ для запроса. | из Resource |
| статический void | wrap(строка $value) Установить строку, которая должна обернуть внешний массив ресурса. | из Resource |
| static void | withoutWrapping() Отключить обёртку внешнего массива ресурсов. | из Resource |
| JsonResponse | response(Request|null $request = null) Преобразовать ресурс в HTTP-ответ. | из Resource |
| Response | toResponse(Request $request) Создать HTTP-ответ, представляющий объект. | из ResourceCollection |
| array | jsonSerialize() Подготовить ресурс для сериализации в JSON. | из Resource |
| mixed | collectResource(mixed $resource) Преобразовать заданный ресурс-коллекцию в отдельные ресурсы. | из CollectsResources |
| string|null | collects() Получить ресурс, который собирает этот ресурс. | из CollectsResources |
| ArrayIterator | getIterator() Получить итератор для коллекции ресурсов. | из CollectsResources |
Подробности
protected array filter(array $data)
Отфильтровать заданные данные, удалив любые необязательные значения.
protected array merge(array $data, int $index, array $merge)
Объединить заданные данные по заданному индексу.
protected MissingValue|mixed when(bool $condition, mixed $value, mixed $default = null)
Получить значение, основанное на заданном условии.
protected MissingValue|mixed mergeWhen(bool $condition, mixed $value)
Объединить значение на основе заданного условия.
protected MergeValue attributes(array $attributes)
Объединить заданные атрибуты.
protected MissingValue|mixed whenLoaded(string $relationship, mixed $value = null, mixed $default = null)
Получить отношение, если оно было загружено.
protected MissingValue|mixed whenPivotLoaded(string $table, mixed $value, mixed $default = null)
Выполнить обратный вызов, если заданная таблица связей была загружена.
protected mixed transform(mixed $value, callable $callback, mixed $default = null)
Преобразовать заданное значение, если оно присутствует.
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 Resource make(dynamic $parameters)
Создать новый экземпляр ресурса.
static AnonymousResourceCollection collection(mixed $resource)
Создать новую коллекцию анонимных ресурсов.
array resolve(Request|null $request = null)
Преобразовать ресурс в массив.
array toArray(Request $request)
Преобразовать ресурс в массив 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-ответ.
array jsonSerialize()
Подготовить ресурс для сериализации в JSON.
protected mixed collectResource(mixed $resource)
Преобразовать заданный коллекционный ресурс в отдельные ресурсы.
protected string|null collects()
Получить ресурс, который собирает этот ресурс.
ArrayIterator getIterator()
Получить итератор для коллекции ресурсов.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.6/Illuminate/Http/Resources/Json/AnonymousResourceCollection.html
