Spec-Zone.ru › Laravel 7

PaginatedResourceResponse

class PaginatedResourceResponse extends ResourceResponse (View source)

Свойства

mixed$resource

Базовый ресурс.

из ResourceResponse

Методы

void__construct(mixed $resource)

Создать новый ответ ресурса.

из ResourceResponse
ResponsetoResponse(Request $request)

Создать HTTP-ответ, представляющий объект.

arraywrap(array $data, array $with = [], array $additional = [])

Оборачивание заданных данных, если необходимо.

из ResourceResponse
boolhaveDefaultWrapperAndDataIsUnwrapped(array $data)

Определение наличия стандартной обертки и развёрнутых данных.

из ResourceResponse
boolhaveAdditionalInformationAndDataIsUnwrapped(array $data, array $with, array $additional)

Определение добавления данных «with» и развёрнутых данных.

из ResourceResponse
stringwrapper()

Получение стандартной обертки данных для ресурса.

из ResourceResponse
intcalculateStatus()

Вычисление соответствующего кода состояния для ответа.

из ResourceResponse
arraypaginationInformation(Request $request)

Добавление информации о постраничном отображении в ответ.

arraypaginationLinks(array $paginated)

Получение ссылок на постраничное отображение для ответа.

arraymeta(array $paginated)

Сбор метаданных для ответа.

Подробное описание

void __construct(mixed $resource)

Создать новый ответ ресурса.

Параметры

mixed$resource

Возвращаемое значение

void

Response toResponse(Request $request)

Создать HTTP-ответ, представляющий объект.

Параметры

Request$request

Возвращаемое значение

Response

protected array wrap(array $data, array $with = [], array $additional = [])

Оборачивание заданных данных, если необходимо.

Параметры

array$data
array$with
array$additional

Возвращаемое значение

array

protected bool haveDefaultWrapperAndDataIsUnwrapped(array $data)

Определение наличия стандартной обертки и развёрнутых данных.

Parameters

array $data

Return Value

bool

protected bool haveAdditionalInformationAndDataIsUnwrapped(array $data, array $with, array $additional)

Определение добавления данных «with» и развёрнутых данных.

Parameters

array $data
array $with
array $additional

Return Value

bool

protected string wrapper()

Получение стандартной обертки данных для ресурса.

Return Value

string

protected int calculateStatus()

Вычисление соответствующего кода состояния для ответа.

Return Value

int

protected array paginationInformation(Request $request)

Добавление информации о постраничном отображении в ответ.

Parameters

Request $request

Return Value

array

protected array paginationLinks(array $paginated)

Получение ссылок на постраничное отображение для ответа.

Parameters

array $paginated

Return Value

array

protected array meta(array $paginated)

Сбор метаданных для ответа.

Parameters

array $paginated

Return Value

array

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/7.x/Illuminate/Http/Resources/Json/PaginatedResourceResponse.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API