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)

Set the serializer that will serialize data for the endpoint.

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

Include the given relationship by default.

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

Don't include the given relationship by default.

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

Make the given relationship available for inclusion.

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

Don't allow the given relationship to be included.

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

Set the default number of results.

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

Set the maximum number of results.

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

Allow sorting results by the given field.

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

Disallow sorting results by the given field.

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

Set the default sort order for the results.

ApiController
load(string|string[] $relations)

Eager loads relationships needed for serializer logic.

ApiController
loadWhere(string $relation, callable $callback)

Allows loading a relationship with additional query modification.

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 The callback can be a closure or an invokable class, and should accept: - $controller: An instance of this controller.

Return Value

ApiController

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

Parameters

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

Return Value

ApiController

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

Set the serializer that will serialize data for the endpoint.

Parameters

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

Return Value

ApiController

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

Include the given relationship by default.

Parameters

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

Return Value

ApiController

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

Don't include the given relationship by default.

Parameters

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

Return Value

ApiController

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

Make the given relationship available for inclusion.

Parameters

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

Return Value

ApiController

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

Don't allow the given relationship to be included.

Parameters

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

Return Value

ApiController

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

Set the default number of results.

Parameters

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

Return Value

ApiController

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

Set the maximum number of results.

Parameters

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

Return Value

ApiController

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

Allow sorting results by the given field.

Parameters

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

Return Value

ApiController

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

Disallow sorting results by the given field.

Parameters

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

Return Value

ApiController

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

Set the default sort order for the results.

Parameters

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

Return Value

ApiController

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

Eager loads relationships needed for serializer logic.

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.

Parameters

string|string[] $relations

Return Value

ApiController

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

Allows loading a relationship with additional query modification.

Parameters

string $relation
callable $callback

Return Value

ApiController

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

Parameters

Container $container
Extension $extension