ResourceCollection
class ResourceCollection extends JsonResource implements Countable, IteratorAggregate (View source)
Свойства
| CollectsResources | |
| ConditionallyLoadsAttributes | |
| DelegatesToResource | |
| ForwardsCalls |
Свойства
| mixed | $resource | Экземпляр ресурса. | из JsonResource |
| array | $with | Дополнительные данные, которые должны быть добавлены в массив ресурса верхнего уровня. | из JsonResource |
| array | $additional | Дополнительные метаданные, которые должны быть добавлены в ответ ресурса. | из JsonResource |
| static string|null | $wrap | Обёртка "data", которая должна быть применена. | из JsonResource |
| string | $collects | Ресурс, который собирает этот ресурс. | |
| Collection | $collection | Экземпляр сопоставленной коллекции. | |
| protected bool | $preserveAllQueryParameters | Указывает, должны ли быть добавлены все существующие параметры запроса к ссылкам постраничной навигации. | |
| protected array|null | $queryParameters | Параметры запроса, которые должны быть добавлены к ссылкам постраничной навигации. |
Методы
| массив | filter(массив $data)
Отфильтровать предоставленные данные, удалив любые необязательные значения. | из ConditionallyLoadsAttributes |
| массив | mergeData(массив $data, int $index, массив $merge, bool $numericKeys)
Объединить предоставленные данные в указанном индексе. | из ConditionallyLoadsAttributes |
| массив | removeMissingValues(массив $data)
Удалить отсутствующие значения из отфильтрованных данных. | из ConditionallyLoadsAttributes |
| MissingValue|смешанное | when(bool $condition, смешанное $value, смешанное $default = null)
Получить значение на основе заданного условия. | из ConditionallyLoadsAttributes |
| MergeValue|смешанное | merge(смешанное $value)
Объединить значение в массив. | из ConditionallyLoadsAttributes |
| MergeValue|смешанное | mergeWhen(bool $condition, смешанное $value)
Объединить значение на основе заданного условия. | из ConditionallyLoadsAttributes |
| MergeValue | attributes(массив $attributes)
Объединить заданные атрибуты. | из ConditionallyLoadsAttributes |
| MissingValue|смешанное | whenAppended(строка $attribute, смешанное $value = null, смешанное $default = null)
Получить аксессор, когда он был добавлен. | из ConditionallyLoadsAttributes |
| MissingValue|смешанное | whenLoaded(строка $relationship, смешанное $value = null, смешанное $default = null)
Получить отношение, если оно было загружено. | из ConditionallyLoadsAttributes |
| MissingValue|смешанное | whenPivotLoaded(строка $table, смешанное $value, смешанное $default = null)
Выполнить обратный вызов, если заданная таблица связей была загружена. | из ConditionallyLoadsAttributes |
| MissingValue|смешанное | whenPivotLoadedAs(строка $accessor, строка $table, смешанное $value, смешанное $default = null)
Выполнить обратный вызов, если заданная таблица связей с пользовательским аксессором была загружена. | из ConditionallyLoadsAttributes |
| смешанное | transform(смешанное $value, вызов $callback, смешанное $default = null)
Преобразовать заданное значение, если оно есть. | из ConditionallyLoadsAttributes |
| смешанное | forwardCallTo(смешанное $object, строка $method, массив $parameters)
Передать вызов метода заданному объекту. | из ForwardsCalls |
| смешанное | forwardDecoratedCallTo(смешанное $object, строка $method, массив $parameters)
Передать вызов метода заданному объекту, вернув $this, если переданный вызов вернул себя. | из ForwardsCalls |
| статический void | throwBadMethodCallException(строка $method)
Выбросить исключение плохого вызова метода для заданного метода. | из ForwardsCalls |
| смешанное | getRouteKey()
Получить значение ключа маршрута ресурса. | из DelegatesToResource |
| строка | getRouteKeyName()
Получить ключ маршрута для ресурса. | из DelegatesToResource |
| void | resolveRouteBinding(смешанное $value, строка|null $field = null)
Получить модель для связанного значения. | из DelegatesToResource |
| void | resolveChildRouteBinding(строка $childType, смешанное $value, строка|null $field = null)
Получить модель для связанного значения. | из 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(mixed $resource)
Создать новый экземпляр ресурса. | |
| static JsonResource | make(mixed ...$parameters)
Создать новый экземпляр ресурса. | из JsonResource |
| static AnonymousResourceCollection | collection(mixed $resource)
Создать новую коллекцию анонимных ресурсов. | из JsonResource |
| array | resolve(Request|null $request = null)
Разрешить ресурс в массив. | из JsonResource |
| array|Arrayable|JsonSerializable | toArray(Request $request)
Преобразовать ресурс в JSON-массив. | |
| string | toJson(int $options = 0)
Преобразовать экземпляр модели в JSON. | из JsonResource |
| array | with(Request $request)
Получить дополнительные данные, которые должны быть возвращены с массивом ресурсов. | из JsonResource |
| $this | additional(array $data)
Добавить дополнительные метаданные к ответу ресурса. | из JsonResource |
| int | jsonOptions()
Получить параметры сериализации JSON, которые должны быть применены к ответу ресурса. | из CollectsResources |
| 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-ответ, который представляет объект. | |
| array | jsonSerialize()
Подготовить ресурс к сериализации в JSON. | из JsonResource |
| mixed | collectResource(mixed $resource)
Преобразовать заданный ресурс-коллекцию в отдельные ресурсы. | из CollectsResources |
| string|null | collects()
Получить ресурс, который собирает этот ресурс. | из CollectsResources |
| ArrayIterator | getIterator()
Получить итератор для коллекции ресурсов. | из CollectsResources |
| $this | preserveQuery()
Указать, что все текущие параметры запроса должны быть добавлены к ссылкам постраничной навигации. | |
| $this | withQuery(array $query)
Указать параметры строки запроса, которые должны присутствовать в ссылках постраничной навигации. | |
| int | count()
Вернуть количество элементов в коллекции ресурсов. | |
| JsonResponse | preparePaginatedResponse(Request $request)
Создать HTTP-ответ, учитывающий постраничную навигацию. |
Details
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)
Передать вызов метода заданному объекту.
protected mixed forwardDecoratedCallTo(mixed $object, string $method, array $parameters)
Передать вызов метода заданному объекту, вернув $this, если переданный вызов вернул себя.
static protected void throwBadMethodCallException(string $method)
Выбросить исключение BadMethodCallException для данного метода.
mixed getRouteKey()
Получить значение ключа маршрута ресурса.
string getRouteKeyName()
Получить ключ маршрута для ресурса.
void resolveRouteBinding(mixed $value, string|null $field = null)
Получить модель для связанного значения.
void resolveChildRouteBinding(string $childType, mixed $value, string|null $field = null)
Получить модель для связанного значения.
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|Arrayable|JsonSerializable toArray(Request $request)
Преобразовать ресурс в JSON-массив.
string toJson(int $options = 0)
Преобразовать экземпляр модели в JSON.
array with(Request $request)
Получить дополнительные данные, которые должны быть возвращены с массивом ресурсов.
$this additional(array $data)
Добавить дополнительные метаданные к ответу ресурса.
int jsonOptions()
Получить параметры сериализации JSON, которые должны быть применены к ответу ресурса.
void withResponse(Request $request, JsonResponse $response)
Настроить ответ для запроса.
static void wrap(string $value)
Установить строку, которая должна обернуть внешний массив ресурсов.
static void withoutWrapping()
Отключить обёртку внешнего массива ресурсов.
JsonResponse response(Request|null $request = null)
Преобразовать ресурс в HTTP-ответ.
Response toResponse(Запрос $request)
Создать HTTP-ответ, представляющий объект.
массив jsonSerialize()
Подготовить ресурс для сериализации в формате JSON.
protected смешанный тип collectResource(смешанный тип $resource)
Преобразовать данный коллекционный ресурс в отдельные ресурсы.
protected строка|null collects()
Получить ресурс, который собирает этот ресурс.
Итератор массива getIterator()
Получить итератор для коллекции ресурсов.
$this preserveQuery()
Указать, что все текущие параметры запроса должны быть добавлены к ссылкам постраничной навигации.
$this withQuery(массив $query)
Указать параметры строки запроса, которые должны присутствовать в ссылках постраничной навигации.
целое число count()
Возвращает количество элементов в коллекции ресурсов.
protected JsonResponse preparePaginatedResponse(Запрос $request)
Создать HTTP-ответ, учитывающий постраничность.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Http/Resources/Json/ResourceCollection.html
