1. class
  2. Illuminate
  3. \
  4. Http
  5. \
  6. Resources
  7. \
  8. Json
  9. \
  10. PaginatedResourceResponse

PaginatedResourceResponse

class PaginatedResourceResponse extends ResourceResponse (View source)

Properties

mixed $resource

The underlying resource.

 from  ResourceResponse

Methods

__construct(mixed $resource)

Create a new resource response.

from  ResourceResponse
Response
toResponse(Request $request)

Create an HTTP response that represents the object.

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

Wrap the given data if necessary.

from  ResourceResponse
bool
haveDefaultWrapperAndDataIsUnwrapped(array $data)

Determine if we have a default wrapper and the given data is unwrapped.

from  ResourceResponse
bool
haveAdditionalInformationAndDataIsUnwrapped(array $data, array $with, array $additional)

Determine if "with" data has been added and our data is unwrapped.

from  ResourceResponse
string
wrapper()

Get the default data wrapper for the resource.

from  ResourceResponse
int
calculateStatus()

Calculate the appropriate status code for the response.

from  ResourceResponse
array
paginationInformation(Request $request)

Add the pagination information to the response.

array
paginationLinks(array $paginated)

Get the pagination links for the response.

array
meta(array $paginated)

Gather the meta data for the response.

Details

in ResourceResponse at line 23
__construct(mixed $resource)

Create a new resource response.

Parameters

mixed $resource

at line 15
Response toResponse(Request $request)

Create an HTTP response that represents the object.

Parameters

Request $request

Return Value

Response

in ResourceResponse at line 60
protected array wrap(Collection|array $data, array $with = [], array $additional = [])

Wrap the given data if necessary.

Parameters

Collection|array $data
array $with
array $additional

Return Value

array

in ResourceResponse at line 81
protected bool haveDefaultWrapperAndDataIsUnwrapped(array $data)

Determine if we have a default wrapper and the given data is unwrapped.

Parameters

array $data

Return Value

bool

in ResourceResponse at line 94
protected bool haveAdditionalInformationAndDataIsUnwrapped(array $data, array $with, array $additional)

Determine if "with" data has been added and our data is unwrapped.

Parameters

array $data
array $with
array $additional

Return Value

bool

in ResourceResponse at line 106
protected string wrapper()

Get the default data wrapper for the resource.

Return Value

string

in ResourceResponse at line 116
protected int calculateStatus()

Calculate the appropriate status code for the response.

Return Value

int

at line 44
protected array paginationInformation(Request $request)

Add the pagination information to the response.

Parameters

Request $request

Return Value

array

Get the pagination links for the response.

Parameters

array $paginated

Return Value

array

at line 83
protected array meta(array $paginated)

Gather the meta data for the response.

Parameters

array $paginated

Return Value

array