PaginatedResourceResponse

class PaginatedResourceResponse extends ResourceResponse (View source)

Свойства

mixed

$resource

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

из ResourceResponse

Методы

void

__construct(mixed $resource)

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

из ResourceResponse

Response

toResponse(Запрос $request)

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

array

wrap(Collection|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)

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

array

paginationLinks(array $paginated)

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

array

meta(array $paginated)

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

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

void __construct(mixed $resource)

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

Параметры

mixed

$resource

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

void

Response toResponse(Запрос $request)

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

Параметры

Запрос

$request

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

Response

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

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

Параметры

Collection\|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)

Определить, были ли добавлены данные "с" и наши данные распакованы.

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/11.x/Illuminate/Http/Resources/Json/PaginatedResourceResponse.html