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

ResourceResponse

class ResourceResponse implements Responsable (View source)

Properties

mixed $resource

The underlying resource.

Methods

__construct(mixed $resource)

Create a new resource response.

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.

bool
haveDefaultWrapperAndDataIsUnwrapped(array $data)

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

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

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

string
wrapper()

Get the default data wrapper for the resource.

int
calculateStatus()

Calculate the appropriate status code for the response.

Details

at line 23
__construct(mixed $resource)

Create a new resource response.

Parameters

mixed $resource

at line 34
Response toResponse(Request $request)

Create an HTTP response that represents the object.

Parameters

Request $request

Return Value

Response

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

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

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

at line 106
protected string wrapper()

Get the default data wrapper for the resource.

Return Value

string

at line 116
protected int calculateStatus()

Calculate the appropriate status code for the response.

Return Value

int