ResourceCollection
class ResourceCollection extends JsonResource implements IteratorAggregate (View source)
Особенности
| CollectsResources |
| ConditionallyLoadsAttributes |
| DelegatesToResource |
Свойства
| mixed | $resource | Экземпляр ресурса. | из JsonResource |
| array | $with | Дополнительные данные, которые должны быть добавлены в массив ресурса верхнего уровня. | из JsonResource |
| array | $additional | Дополнительные метаданные, которые должны быть добавлены в ответ ресурса. | из JsonResource |
| static string | $wrap | Обёртка "данные", которая должна быть применена. | из JsonResource |
| string | $collects | Ресурс, который собирает этот ресурс. | |
| Collection | $collection | Экземпляр отображённой коллекции. |
Методы
| массив | filter(массив $data) Фильтровать заданные данные, удаляя любые необязательные значения. | из ConditionallyLoadsAttributes |
| массив | mergeData(массив $data, целое $index, массив $merge, логическое $numericKeys) Объединить заданные данные в указанный индекс. | из ConditionallyLoadsAttributes |
| массив | removeMissingValues(массив $data, логическое $numericKeys = false) Удалить отсутствующие значения из отфильтрованных данных. | из ConditionallyLoadsAttributes |
| MissingValue|смешанный тип | when(логическое $condition, смешанный тип $value, смешанный тип $default = null) Получить значение на основе заданного условия. | из ConditionallyLoadsAttributes |
| MergeValue|смешанный тип | merge(смешанный тип $value) Объединить значение в массив. | из ConditionallyLoadsAttributes |
| MergeValue|смешанный тип | mergeWhen(логическое $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 |
| логическое | offsetExists(смешанный тип $offset) Определить, существует ли данный атрибут. | из DelegatesToResource |
| смешанный тип | offsetGet(смешанный тип $offset) Получить значение для заданного смещения. | из DelegatesToResource |
| void | offsetSet(смешанный тип $offset, смешанный тип $value) Установить значение для заданного смещения. | из DelegatesToResource |
| void | offsetUnset(смешанный тип $offset) Удалить значение для заданного смещения. | из DelegatesToResource |
| логическое | __isset(строка $key) Определить, существует ли атрибут в ресурсе. | из DelegatesToResource |
| void | __unset(строка $key) Удалить атрибут из ресурса. | из DelegatesToResource |
| смешанный тип | __get(строка $key) Динамически получить свойства из базового ресурса. | из DelegatesToResource |
| смешанный тип | __call(строка $method, массив $parameters) Динамически передать вызовы методов базовому ресурсу. | из DelegatesToResource |
| void | __construct(смешанный тип $resource) Создать новый экземпляр ресурса. | |
| статический JsonResource | make(смешанный тип $parameters) Создать новый экземпляр ресурса. | из JsonResource |
| статический AnonymousResourceCollection | collection(смешанный тип $resource) Создать новую анонимную коллекцию ресурсов. | из JsonResource |
| массив | resolve(Request|null $request = null) Разрешить ресурс в массив. | из JsonResource |
| массив | toArray(Request $request) Преобразовать ресурс в массив JSON. | |
| массив | with(Request $request) Получить любые дополнительные данные, которые должны быть возвращены с массивом ресурса. | из JsonResource |
| $this | additional(массив $data) Добавить дополнительные метаданные к ответу ресурса. | из 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-ответ, представляющий объект. | |
| array | jsonSerialize() Подготовить ресурс для сериализации в JSON. | from JsonResource |
| mixed | collectResource(mixed $resource) Отобразить заданный ресурс коллекции в отдельные ресурсы. | from CollectsResources |
| string|null | collects() Получить ресурс, который собирается этим ресурсом. | from CollectsResources |
| ArrayIterator | getIterator() Получить итератор для коллекции ресурсов. | from CollectsResources |
Подробности
protected array filter(array $data)
Отфильтровать заданные данные, удалив любые необязательные значения.
protected array mergeData(array $data, int $index, array $merge, bool $numericKeys)
Объединить заданные данные в указанном индексе.
protected array removeMissingValues(array $data, bool $numericKeys = false)
Удалить отсутствующие значения из отфильтрованных данных.
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 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)
Создать новый экземпляр ресурса.
static JsonResource make(mixed $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 ответ.
массив jsonSerialize()
Подготовить ресурс для сериализации в формате JSON.
protected смешанный тип collectResource(смешанный тип $resource)
Преобразовать данный коллекционный ресурс в отдельные ресурсы.
protected строка|null collects()
Получить ресурс, который собирает этот ресурс.
Итератор массива 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/ResourceCollection.html
