Spec-Zone.ru › Laravel 5.6

PaginatedResourceResponse

class PaginatedResourceResponse extends ResourceResponse (View source)

Свойства

mixed $resource Базовый ресурс. из ResourceResponse

Методы

void __construct(mixed $resource)

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

из ResourceResponse
Response toResponse(Request $request)

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

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

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

из ResourceResponse
bool haveDefaultWrapperAndDataIsUnwrapped(array $data)

Определяет, есть ли у нас стандартная оболочка и предоставленные данные не упакованы.

из ResourceResponse
bool haveAdditionalInformationAndDataIsUnwrapped(array $data, array $with, array $additional)

Определяет, была ли добавлена ​​информация "with", и наши данные не упакованы.

из ResourceResponse
string wrapper()

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

из ResourceResponse
int calculateStatus()

Рассчитать подходящий код состояния для ответа.

из ResourceResponse
array paginationInformation(Request $request)

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

array paginationLinks(array $paginated)

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

array meta(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)

Определяет, есть ли у нас стандартная оболочка и предоставленные данные не упакованы.

Параметры

array $data

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

bool

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

Определяет, была ли добавлена ​​информация "with", и наши данные не упакованы.

Параметры

array $data
array $with
array $additional

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

bool

protected string wrapper()

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

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

string

protected int calculateStatus()

Рассчитать подходящий код состояния для ответа.

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

int

protected array paginationInformation(Request $request)

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

Параметры

Request $request

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

array

protected array paginationLinks(array $paginated)

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

Параметры

array $paginated

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

array

protected array meta(array $paginated)

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

Параметры

array $paginated

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

array

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

Spec-Zone.ru

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