Spec-Zone.ru › Laravel 10

PaginatedResourceResponse

class PaginatedResourceResponse extends ResourceResponse (View source)

Свойства

смешанный тип$resource

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

из ResourceResponse

Методы

пустое значение __construct(смешанный тип $resource)

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

из ResourceResponse
Response toResponse(Request $request)

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

массив wrap(Collection|массив $data, массив $with = [], массив $additional = [])

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

из ResourceResponse
логическое значение haveDefaultWrapperAndDataIsUnwrapped(массив $data)

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

из ResourceResponse
логическое значение haveAdditionalInformationAndDataIsUnwrapped(массив $data, массив $with, массив $additional)

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

из ResourceResponse
строка wrapper()

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

из ResourceResponse
целое число calculateStatus()

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

из ResourceResponse
массив paginationInformation(Request $request)

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

массив paginationLinks(массив $paginated)

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

массив meta(массив $paginated)

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

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

пустое значение __construct(смешанный тип $resource)

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

Параметры

смешанный тип $resource

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

пустое значение

Response toResponse(Request $request)

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

Параметры

Request $request

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

Response

protected массив wrap(Collection|массив $data, массив $with = [], массив $additional = [])

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

Параметры

Collection|массив $data
массив $with
массив $additional

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

массив

protected логическое значение haveDefaultWrapperAndDataIsUnwrapped(массив $data)

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

Параметры

массив $data

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

логическое значение

protected логическое значение haveAdditionalInformationAndDataIsUnwrapped(массив $data, массив $with, массив $additional)

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

Параметры

массив $data
массив $with
массив $additional

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

логическое значение

protected строка wrapper()

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

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

строка

protected целое число calculateStatus()

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

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

целое число

protected массив paginationInformation(Request $request)

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

Параметры

Request $request

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

массив

protected массив paginationLinks(массив $paginated)

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

Параметры

массив $paginated

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

массив

protected массив meta(массив $paginated)

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

Параметры

массив $paginated

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

массив

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

Spec-Zone.ru

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