1. interface
  2. Hypervel
  3. \
  4. Data
  5. \
  6. Contracts
  7. \
  8. ResponsableData

ResponsableData

interface ResponsableData implements Responsable

Methods

Response
toResponse(Request $request)

Create an HTTP response that represents the data object.

static int
jsonOptions()

Get the JSON serialization options for the resource response.

void
withResponse(Request $request, JsonResponse $response)

Customize the outgoing resource response.

static array|null
allowedRequestIncludes()

Get the request properties that may be included.

static array|null
allowedRequestExcludes()

Get the request properties that may be excluded.

static array|null
allowedRequestOnly()

Get the request properties allowed by an only selection.

static array|null
allowedRequestExcept()

Get the request properties allowed by an except selection.

Details

at line 17
Response toResponse(Request $request)

Create an HTTP response that represents the data object.

Parameters

Request $request

Return Value

Response

at line 22
static int jsonOptions()

Get the JSON serialization options for the resource response.

Return Value

int

at line 27
void withResponse(Request $request, JsonResponse $response)

Customize the outgoing resource response.

Parameters

Request $request
JsonResponse $response

Return Value

void

at line 32
static array|null allowedRequestIncludes()

Get the request properties that may be included.

Return Value

array|null

at line 37
static array|null allowedRequestExcludes()

Get the request properties that may be excluded.

Return Value

array|null

at line 42
static array|null allowedRequestOnly()

Get the request properties allowed by an only selection.

Return Value

array|null

at line 47
static array|null allowedRequestExcept()

Get the request properties allowed by an except selection.

Return Value

array|null