ResourceCollection
класс ResourceCollection расширяет JsonResource и реализует Countable, IteratorAggregate (Просмотреть исходный код)
Трейты
| CollectsResources | |
| ConditionallyLoadsAttributes | |
| DelegatesToResource | |
| ForwardsCalls |
Свойства
| mixed | $resource | Экземпляр ресурса. | from JsonResource |
| array | $with | Дополнительные данные, которые должны быть добавлены в массив ресурса верхнего уровня. | from JsonResource |
| array | $additional | Дополнительные метаданные, которые должны быть добавлены в ответ ресурса. | from JsonResource |
| static string | $wrap | Обёртка "данные", которая должна быть применена. | from JsonResource |
| string | $collects | Ресурс, который собирает этот ресурс. | |
| Collection | $collection | Экземпляр сопоставленного набора. | |
| protected bool | $preserveAllQueryParameters | Указывает, должны ли все существующие параметры запроса добавляться к ссылкам постраничной навигации. | |
| protected array|null | $queryParameters | Параметры запроса, которые должны быть добавлены к ссылкам постраничной навигации. |
Методы
| array | filter(array $data)
Отфильтровать заданные данные, удалив любые необязательные значения. | from ConditionallyLoadsAttributes |
| array | mergeData(array $data, int $index, array $merge, bool $numericKeys)
Объединить заданные данные в указанном индексе. | from ConditionallyLoadsAttributes |
| array | removeMissingValues(array $data)
Удалить отсутствующие значения из отфильтрованных данных. | from ConditionallyLoadsAttributes |
| MissingValue|mixed | when(bool $condition, mixed $value, mixed $default = null)
Получить значение на основе заданного условия. | from ConditionallyLoadsAttributes |
| MergeValue|mixed | merge(mixed $value)
Объединить значение в массив. | from ConditionallyLoadsAttributes |
| MergeValue|mixed | mergeWhen(bool $condition, mixed $value)
Объединить значение на основе заданного условия. | from 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)
Преобразовать заданное значение, если оно присутствует. | 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, string|null $field = null)
Получить модель для связанного значения. | from DelegatesToResource |
| void | resolveChildRouteBinding(string $childType, mixed $value, string|null $field = null)
Получить модель для связанного значения. | 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 |
| array | resolve(Request|null $request = null)
Разрешить ресурс в массив. | from JsonResource |
| array | toArray(Request $request)
Преобразовать ресурс в JSON-массив. | |
| string | toJson(int $options = 0)
Преобразовать экземпляр модели в JSON. | from JsonResource |
| array | with(Request $request)
Получить любые дополнительные данные, которые должны быть возвращены с массивом ресурсов. | из JsonResource |
| $this | additional(array $data)
Добавить дополнительные метаданные к ответу ресурса. | из JsonResource |
| void | withResponse(Request $request, JsonResponse $response)
Настроить ответ для запроса. | из JsonResource |
| static void | wrap(string $value)
Установить строку, которая должна обернуть внешний массив ресурсов. | из JsonResource |
| static void | withoutWrapping()
Отключить обертывание внешнего массива ресурсов. | из JsonResource |
| JsonResponse | response(Request|null $request = null)
Преобразовать ресурс в HTTP-ответ. | из JsonResource |
| Response | toResponse(Request $request)
Создать HTTP-ответ, представляющий объект. |
| массив | jsonSerialize()
Подготовить ресурс для сериализации в JSON. | из JsonResource |
| смешанный | collectResource(mixed $resource)
Преобразовать заданный коллекционный ресурс в отдельные ресурсы. | из CollectsResources |
| строка|null | collects()
Получить ресурс, который собирает этот ресурс. | из CollectsResources |
| ArrayIterator | getIterator()
Получить итератор для коллекции ресурсов. | из CollectsResources |
| $this | preserveQuery()
Указать, что все текущие параметры запроса должны быть добавлены к ссылкам на постраничную навигацию. | |
| $this | withQuery(array $query)
Указать параметры строки запроса, которые должны присутствовать в ссылках на постраничную навигацию. | |
| целое число | count()
Возвращает количество элементов в коллекции ресурсов. | |
| JsonResponse | preparePaginatedResponse(Request $request)
Создать HTTP-ответ, учитывающий постраничную навигацию. |
Подробности
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)
Выбросить исключение ошибки вызова метода для заданного метода.
mixed getRouteKey()
Получить значение ключа маршрута ресурса.
строка getRouteKeyName()
Получить имя ключа маршрута для ресурса.
пустое значение resolveRouteBinding(смешанный $value, строка|null $field = null)
Получить модель для связанного значения.
пустое значение resolveChildRouteBinding(строка $childType, смешанный $value, строка|null $field = null)
Получить модель для связанного значения.
логическое значение offsetExists(смешанный $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)
Создать новый экземпляр ресурса.
статический AnonymousResourceCollection collection(mixed $resource)
Создать новый анонимный ресурс-коллекцию.
массив resolve(Request|null $request = null)
Разрешить ресурс в массив.
массив toArray(Request $request)
Преобразовать ресурс в JSON-массив.
строка toJson(int $options = 0)
Преобразовать экземпляр модели в JSON.
массив with(Запрос $request)
Получить любые дополнительные данные, которые должны быть возвращены в массиве ресурсов.
$this additional(массив $data)
Добавить дополнительные метаданные в ответ ресурса.
статический пустое значение wrap(строка $value)
Установить строку, которая должна обернуть самый внешний массив ресурсов.
статический пустое значение 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/ResourceCollection.html
