PaginatedResourceResponse
class PaginatedResourceResponse extends ResourceResponse (View source)
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 meta data for the response.
Details
void
__construct(mixed $resource)
Create a new resource response.
Response
toResponse(Request $request)
Create an HTTP response that represents the object.
protected array
wrap(Collection|array $data, array $with = [], array $additional = [])
Wrap the given data if necessary.
protected bool
haveDefaultWrapperAndDataIsUnwrapped(array $data)
Determine if we have a default wrapper and the given data is unwrapped.
protected bool
haveAdditionalInformationAndDataIsUnwrapped(array $data, array $with, array $additional)
Determine if "with" data has been added and our data is unwrapped.
protected string|null
wrapper()
Get the default data wrapper for the resource.
protected int
calculateStatus()
Calculate the appropriate status code for the response.
protected array
paginationInformation(Request $request)
Add the pagination information to the response.
protected array
paginationLinks(array $paginated)
Get the pagination links for the response.
protected array
meta(array $paginated)
Gather the meta data for the response.