class WillGetData

Properties

AbstractSerializeController $controller

Methods

__construct(AbstractSerializeController $controller)

No description

bool
isController(string $controller)

No description

setSerializer(string $serializer)

<p>Set the serializer that will serialize data for the endpoint.</p>

addInclude(string|array $name)

<p>Include the given relationship by default.</p>

removeInclude(string $name)

<p>Don't include the given relationship by default.</p>

addOptionalInclude(string $name)

<p>Make the given relationship available for inclusion.</p>

removeOptionalInclude(string $name)

<p>Don't allow the given relationship to be included.</p>

setLimit(int $limit)

<p>Set the default number of results.</p>

setMaxLimit(int $max)

<p>Set the maximum number of results.</p>

addSortField(string $field)

<p>Allow sorting results by the given field.</p>

removeSortField(string $field)

<p>Disallow sorting results by the given field.</p>

setSort(array $sort)

<p>Set the default sort order for the results.</p>

Details

__construct(AbstractSerializeController $controller)

Parameters

AbstractSerializeController $controller

bool isController(string $controller)

Parameters

string $controller

Return Value

bool

setSerializer(string $serializer)

<p>Set the serializer that will serialize data for the endpoint.</p>

Parameters

string $serializer

addInclude(string|array $name)

<p>Include the given relationship by default.</p>

Parameters

string|array $name

removeInclude(string $name)

<p>Don't include the given relationship by default.</p>

Parameters

string $name

addOptionalInclude(string $name)

<p>Make the given relationship available for inclusion.</p>

Parameters

string $name

removeOptionalInclude(string $name)

<p>Don't allow the given relationship to be included.</p>

Parameters

string $name

setLimit(int $limit)

<p>Set the default number of results.</p>

Parameters

int $limit

setMaxLimit(int $max)

<p>Set the maximum number of results.</p>

Parameters

int $max

addSortField(string $field)

<p>Allow sorting results by the given field.</p>

Parameters

string $field

removeSortField(string $field)

<p>Disallow sorting results by the given field.</p>

Parameters

string $field

setSort(array $sort)

<p>Set the default sort order for the results.</p>

Parameters

array $sort