ApiController  

class ApiController implements ExtenderInterface

Methods

__construct(string $controllerClass)

No description

ApiController
prepareDataQuery(callable|string $callback)

No description

ApiController
prepareDataForSerialization(callable|string $callback)

No description

ApiController
setSerializer(string $serializerClass, callable|string|null $callback = null)

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

ApiController
addInclude($name, callable|string|null $callback = null)

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

ApiController
removeInclude($name, callable|string|null $callback = null)

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

ApiController
addOptionalInclude($name, callable|string|null $callback = null)

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

ApiController
removeOptionalInclude($name, callable|string|null $callback = null)

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

ApiController
setLimit(int $limit, callable|string|null $callback = null)

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

ApiController
setMaxLimit(int $max, callable|string|null $callback = null)

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

ApiController
addSortField(string|array $field, callable|string|null $callback = null)

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

ApiController
removeSortField(string|array $field, callable|string|null $callback = null)

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

ApiController
setSort(array $sort, callable|string|null $callback = null)

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

ApiController
load(string|string[] $relations)

<p>Eager loads relationships needed for serializer logic.</p>

ApiController
loadWhere(string $relation, callable $callback)

<p>Allows loading a relationship with additional query modification.</p>

extend(Container $container, Extension $extension = null)

No description

Details

at line 39
__construct(string $controllerClass)

Parameters

string $controllerClass

at line 52
ApiController prepareDataQuery(callable|string $callback)

Parameters

callable|string $callback <p>The callback can be a closure or an invokable class, and should accept:</p> <ul> <li>$controller: An instance of this controller.</li> </ul>

Return Value

ApiController

at line 74
ApiController prepareDataForSerialization(callable|string $callback)

Parameters

callable|string $callback <p>The callback can be a closure or an invokable class, and should accept:</p> <ul> <li>$controller: An instance of this controller.</li> <li>$data: Mixed, can be an array of data or an object (like an instance of Collection or AbstractModel).</li> <li>$request: An instance of \Psr\Http\Message\ServerRequestInterface.</li> <li>$document: An instance of \Tobscure\JsonApi\Document.</li> </ul> <p>The callable should return:</p> <ul> <li>An array of additional data to merge with the existing array. Or a modified $data array.</li> </ul>

Return Value

ApiController

at line 95
ApiController setSerializer(string $serializerClass, callable|string|null $callback = null)

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

Parameters

string $serializerClass
callable|string|null $callback <p>The optional callback can be a closure or an invokable class, and should accept:</p> <ul> <li>$controller: An instance of this controller.</li> </ul> <p>The callable should return:</p> <ul> <li>A boolean value to determine if this applies.</li> </ul>

Return Value

ApiController

at line 116
ApiController addInclude($name, callable|string|null $callback = null)

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

Parameters

$name
callable|string|null $callback <p>The optional callback can be a closure or an invokable class, and should accept:</p> <ul> <li>$controller: An instance of this controller.</li> </ul> <p>The callable should return:</p> <ul> <li>A boolean value to determine if this applies.</li> </ul>

Return Value

ApiController

at line 137
ApiController removeInclude($name, callable|string|null $callback = null)

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

Parameters

$name
callable|string|null $callback <p>The optional callback can be a closure or an invokable class, and should accept:</p> <ul> <li>$controller: An instance of this controller.</li> </ul> <p>The callable should return:</p> <ul> <li>A boolean value to determine if this applies.</li> </ul>

Return Value

ApiController

at line 158
ApiController addOptionalInclude($name, callable|string|null $callback = null)

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

Parameters

$name
callable|string|null $callback <p>The optional callback can be a closure or an invokable class, and should accept:</p> <ul> <li>$controller: An instance of this controller.</li> </ul> <p>The callable should return:</p> <ul> <li>A boolean value to determine if this applies.</li> </ul>

Return Value

ApiController

at line 179
ApiController removeOptionalInclude($name, callable|string|null $callback = null)

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

Parameters

$name
callable|string|null $callback <p>The optional callback can be a closure or an invokable class, and should accept:</p> <ul> <li>$controller: An instance of this controller.</li> </ul> <p>The callable should return:</p> <ul> <li>A boolean value to determine if this applies.</li> </ul>

Return Value

ApiController

at line 200
ApiController setLimit(int $limit, callable|string|null $callback = null)

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

Parameters

int $limit
callable|string|null $callback <p>The optional callback can be a closure or an invokable class, and should accept:</p> <ul> <li>$controller: An instance of this controller.</li> </ul> <p>The callable should return:</p> <ul> <li>A boolean value to determine if this applies.</li> </ul>

Return Value

ApiController

at line 221
ApiController setMaxLimit(int $max, callable|string|null $callback = null)

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

Parameters

int $max
callable|string|null $callback <p>The optional callback can be a closure or an invokable class, and should accept:</p> <ul> <li>$controller: An instance of this controller.</li> </ul> <p>The callable should return:</p> <ul> <li>A boolean value to determine if this applies.</li> </ul>

Return Value

ApiController

at line 242
ApiController addSortField(string|array $field, callable|string|null $callback = null)

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

Parameters

string|array $field
callable|string|null $callback <p>The optional callback can be a closure or an invokable class, and should accept:</p> <ul> <li>$controller: An instance of this controller.</li> </ul> <p>The callable should return:</p> <ul> <li>A boolean value to determine if this applies.</li> </ul>

Return Value

ApiController

at line 263
ApiController removeSortField(string|array $field, callable|string|null $callback = null)

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

Parameters

string|array $field
callable|string|null $callback <p>The optional callback can be a closure or an invokable class, and should accept:</p> <ul> <li>$controller: An instance of this controller.</li> </ul> <p>The callable should return:</p> <ul> <li>A boolean value to determine if this applies.</li> </ul>

Return Value

ApiController

at line 284
ApiController setSort(array $sort, callable|string|null $callback = null)

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

Parameters

array $sort
callable|string|null $callback <p>The optional callback can be a closure or an invokable class, and should accept:</p> <ul> <li>$controller: An instance of this controller.</li> </ul> <p>The callable should return:</p> <ul> <li>A boolean value to determine if this applies.</li> </ul>

Return Value

ApiController

at line 305
ApiController load(string|string[] $relations)

<p>Eager loads relationships needed for serializer logic.</p>

<p>First level relationships will be loaded regardless of whether they are included in the response. Sublevel relationships will only be loaded if the upper level was included or manually loaded.</p>

Parameters

string|string[] $relations

Return Value

ApiController

at line 325
ApiController loadWhere(string $relation, callable $callback)

<p>Allows loading a relationship with additional query modification.</p>

Parameters

string $relation
callable $callback

Return Value

ApiController

at line 332
extend(Container $container, Extension $extension = null)

Parameters

Container $container
Extension $extension