class ListGroupsController extends AbstractListController

Properties

$serializer <p>{@inheritdoc}</p>
array $include <p>The relationships that are included by default.</p> from AbstractSerializeController
array $optionalInclude <p>The relationships that are available to be included.</p> from AbstractSerializeController
int $maxLimit <p>The maximum number of records that can be requested.</p> from AbstractSerializeController
int $limit <p>The number of records included by default.</p> from AbstractSerializeController
array $sortFields <p>The fields that are available to be sorted by.</p> from AbstractSerializeController
array|null $sort <p>The default sort field and order to user.</p> from AbstractSerializeController
static protected Container $container from AbstractSerializeController
static protected Dispatcher $events from AbstractSerializeController

Methods

ResponseInterface
handle(ServerRequestInterface $request)

<p>{@inheritdoc}</p>

mixed
data(ServerRequestInterface $request, Document $document)

<p>Get the data to be serialized and assigned to the response document.</p>

ElementInterface
createElement(mixed $data, SerializerInterface $serializer)

<p>Create a PHP JSON-API Element for output in the document.</p>

array
extractInclude(ServerRequestInterface $request)

No description

array
extractFields(ServerRequestInterface $request)

No description

array|null
extractSort(ServerRequestInterface $request)

No description

int
extractOffset(ServerRequestInterface $request)

No description

int
extractLimit(ServerRequestInterface $request)

No description

array
extractFilter(ServerRequestInterface $request)

No description

Parameters
buildParameters(ServerRequestInterface $request)

No description

static Dispatcher
getEventDispatcher()

No description

static 
setEventDispatcher(Dispatcher $events)

No description

static Container
getContainer()

No description

static 
setContainer(Container $container)

No description

Details

ResponseInterface handle(ServerRequestInterface $request)

<p>{@inheritdoc}</p>

Parameters

ServerRequestInterface $request

Return Value

ResponseInterface

protected mixed data(ServerRequestInterface $request, Document $document)

<p>Get the data to be serialized and assigned to the response document.</p>

Parameters

ServerRequestInterface $request
Document $document

Return Value

mixed

protected ElementInterface createElement(mixed $data, SerializerInterface $serializer)

<p>Create a PHP JSON-API Element for output in the document.</p>

Parameters

mixed $data
SerializerInterface $serializer

Return Value

ElementInterface

protected array extractInclude(ServerRequestInterface $request)

Parameters

ServerRequestInterface $request

Return Value

array

Exceptions

InvalidParameterException

protected array extractFields(ServerRequestInterface $request)

Parameters

ServerRequestInterface $request

Return Value

array

protected array|null extractSort(ServerRequestInterface $request)

Parameters

ServerRequestInterface $request

Return Value

array|null

Exceptions

InvalidParameterException

protected int extractOffset(ServerRequestInterface $request)

Parameters

ServerRequestInterface $request

Return Value

int

Exceptions

InvalidParameterException

protected int extractLimit(ServerRequestInterface $request)

Parameters

ServerRequestInterface $request

Return Value

int

protected array extractFilter(ServerRequestInterface $request)

Parameters

ServerRequestInterface $request

Return Value

array

protected Parameters buildParameters(ServerRequestInterface $request)

Parameters

ServerRequestInterface $request

Return Value

Parameters

static Dispatcher getEventDispatcher()

Return Value

Dispatcher

static setEventDispatcher(Dispatcher $events)

Parameters

Dispatcher $events

static Container getContainer()

Return Value

Container

static setContainer(Container $container)

Parameters

Container $container