class WillGetData

deprecated in beta 15, removed in beta 16

Properties

AbstractSerializeController $controller

Methods

__construct(AbstractSerializeController $controller)

No description

bool
isController(string $controller)

No description

setSerializer(string $serializer)

Set the serializer that will serialize data for the endpoint.

addInclude(string|array $name)

Include the given relationship by default.

removeInclude(string $name)

Don't include the given relationship by default.

addOptionalInclude(string $name)

Make the given relationship available for inclusion.

removeOptionalInclude(string $name)

Don't allow the given relationship to be included.

setLimit(int $limit)

Set the default number of results.

setMaxLimit(int $max)

Set the maximum number of results.

addSortField(string $field)

Allow sorting results by the given field.

removeSortField(string $field)

Disallow sorting results by the given field.

setSort(array $sort)

Set the default sort order for the results.

Details

__construct(AbstractSerializeController $controller)

Parameters

AbstractSerializeController $controller

bool isController(string $controller)

Parameters

string $controller

Return Value

bool

setSerializer(string $serializer)

Set the serializer that will serialize data for the endpoint.

Parameters

string $serializer

addInclude(string|array $name)

Include the given relationship by default.

Parameters

string|array $name

removeInclude(string $name)

Don't include the given relationship by default.

Parameters

string $name

addOptionalInclude(string $name)

Make the given relationship available for inclusion.

Parameters

string $name

removeOptionalInclude(string $name)

Don't allow the given relationship to be included.

Parameters

string $name

setLimit(int $limit)

Set the default number of results.

Parameters

int $limit

setMaxLimit(int $max)

Set the maximum number of results.

Parameters

int $max

addSortField(string $field)

Allow sorting results by the given field.

Parameters

string $field

removeSortField(string $field)

Disallow sorting results by the given field.

Parameters

string $field

setSort(array $sort)

Set the default sort order for the results.

Parameters

array $sort