ResourceCollection
class ResourceCollection extends JsonResource implements Countable, IteratorAggregate (View source)
Свойства
| mixed | $resource | Экземпляр ресурса. | from JsonResource |
| array | $with | Дополнительные данные, которые должны быть добавлены к массиву ресурса верхнего уровня. | from JsonResource |
| array | $additional | Дополнительные метаданные, которые должны быть добавлены в ответ ресурса. | from JsonResource |
| static string | $wrap | Обертка "data", которая должна быть применена. | from JsonResource |
| string | $collects | Ресурс, который собирает этот ресурс. | |
| Collection | $collection | Экземпляр отображённого набора. |
Свойства
| CollectsResources | |
| ConditionallyLoadsAttributes | |
| DelegatesToResource | |
| ForwardsCalls |
Методы
| 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) Объединить заданные атрибуты. | from ConditionallyLoadsAttributes |
| MissingValue|mixed | whenLoaded(string $relationship, 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 |
| mixed | transform(mixed $value, callable $callback, mixed $default = null) Преобразовать заданное значение, если оно присутствует. | from ConditionallyLoadsAttributes |
| mixed | forwardCallTo(mixed $object, string $method, array $parameters) Передать вызов метода заданному объекту. | from ForwardsCalls |
| static void | throwBadMethodCallException(string $method) Выбросить исключение плохого вызова метода для данного метода. | from ForwardsCalls |
| mixed | getRouteKey() Получить значение ключа маршрута ресурса. | from DelegatesToResource |
| string | getRouteKeyName() Получить ключ маршрута для ресурса. | from DelegatesToResource |
| void | resolveRouteBinding(mixed $value) Получить модель для связанного значения. | 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 |
| mixed | __call(string $method, array $parameters) Динамически передать вызовы методов базовому ресурсу. | from DelegatesToResource |
| void | __construct(mixed $resource) Создать новый экземпляр ресурса. | |
| static JsonResource | make(mixed ...$parameters) Создать новый экземпляр ресурса. | from JsonResource |
| static AnonymousResourceCollection | collection(mixed $resource) Создать новую анонимную коллекцию ресурсов. | from JsonResource |
| массив | resolve(Request|null $request = null) Разрешить ресурс в массив. | from JsonResource |
| массив | toArray(Request $request) Преобразовать ресурс в JSON-массив. | |
| массив | 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-ответ, представляющий объект. | |
| array | jsonSerialize() Подготовить ресурс для сериализации в JSON. | from JsonResource |
| mixed | collectResource(mixed $resource) Преобразовать заданный коллекционный ресурс в отдельные ресурсы. | from CollectsResources |
| string|null | collects() Получить ресурс, который собирает этот ресурс. | from CollectsResources |
| ArrayIterator | getIterator() Получить итератор для коллекции ресурсов. | from CollectsResources |
| int | count() Возвращает количество элементов в коллекции ресурсов. |
Подробности
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 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)
Выбросить исключение неверного вызова метода для указанного метода.
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)
Получить любые дополнительные данные, которые должны быть возвращены в массиве ресурсов.
$this additional(массив $data)
Добавить дополнительные метаданные в ответ ресурса.
void withResponse(Запрос $request, JsonResponse $response)
Настроить ответ для запроса.
static void wrap(строка $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()
Получить итератор для коллекции ресурсов.
int 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/ResourceCollection.html
