class Groups extends ApiController (View source)

Traits

Trait ApplicationAwareTrait A trait used with ApplicationAwareInterface

Properties

protected Application $app from  ApplicationAwareTrait
protected Request $request from  ApiController

Methods

setApplication(Application $app)

Setter method for the application

__construct(Request $request)

No description

JsonResponse
error($message, int $code = 400)

Returns an error response in the standard Concrete error response format.

Item
transform($object, TransformerAbstract $transformer, string $resourceKey = null)

Transforms an object using the API transformer

deleted(string $objectType, string $id)

No description

addLimitToPaginationIfSpecified($pagination, Request $request)

No description

getCurrentCursorFromRequest(Request $request)

No description

addCursorToResource(iterable $results, Request $request, $getNewCursor, ResourceAbstract $resource, $previousCursor = null)

No description

setupSortAndCursor(Request $request, ItemList $list, PagerColumnInterface $column, callable $getCursorObjectFunction)

No description

read($gID)

No description

listGroups()

No description

add()

No description

Details

setApplication(Application $app)

Setter method for the application

Parameters

Application $app

__construct(Request $request)

No description

Parameters

Request $request

protected JsonResponse error($message, int $code = 400)

Returns an error response in the standard Concrete error response format.

Parameters

$message
int $code

Return Value

JsonResponse

Item transform($object, TransformerAbstract $transformer, string $resourceKey = null)

Transforms an object using the API transformer

Parameters

$object
TransformerAbstract $transformer
string $resourceKey

Return Value

Item

deleted(string $objectType, string $id)

No description

Parameters

string $objectType
string $id

addLimitToPaginationIfSpecified($pagination, Request $request)

No description

Parameters

$pagination
Request $request

getCurrentCursorFromRequest(Request $request)

No description

Parameters

Request $request

addCursorToResource(iterable $results, Request $request, $getNewCursor, ResourceAbstract $resource, $previousCursor = null)

No description

Parameters

iterable $results
Request $request
$getNewCursor
ResourceAbstract $resource
$previousCursor

setupSortAndCursor(Request $request, ItemList $list, PagerColumnInterface $column, callable $getCursorObjectFunction)

No description

Parameters

Request $request
ItemList $list
PagerColumnInterface $column
callable $getCursorObjectFunction

read($gID)

No description

Parameters

$gID

listGroups()

No description

add()

No description