PaginatedResourceResponse
class PaginatedResourceResponse extends ResourceResponse
Properties
| mixed | $resource | The underlying resource. |
from ResourceResponse |
Methods
Wrap the given data if necessary.
Determine if we have a default wrapper and the given data is unwrapped.
Determine if "with" data has been added and our data is unwrapped.
Get the pagination links for the response.
Gather the metadata for the response.
Details
in
ResourceResponse at line 23
__construct(mixed $resource)
Create a new resource response.
at line 16
Response
toResponse(Request $request)
Create an HTTP response that represents the object.
in
ResourceResponse at line 52
protected array
wrap(Collection|array $data, array $with = [], array $additional = [])
Wrap the given data if necessary.
in
ResourceResponse at line 70
protected bool
haveDefaultWrapperAndDataIsUnwrapped(array $data)
Determine if we have a default wrapper and the given data is unwrapped.
in
ResourceResponse at line 82
protected bool
haveAdditionalInformationAndDataIsUnwrapped(array $data, array $with, array $additional)
Determine if "with" data has been added and our data is unwrapped.
in
ResourceResponse at line 92
protected string|null
wrapper()
Get the default data wrapper for the resource.
in
ResourceResponse at line 103
protected int
calculateStatus()
Calculate the appropriate status code for the response.
at line 49
protected array
paginationInformation(Request $request)
Add the pagination information to the response.
at line 69
protected array
paginationLinks(array $paginated)
Get the pagination links for the response.
at line 82
protected array
meta(array $paginated)
Gather the metadata for the response.