DocumentsControllerListTrait uses \oihana\controllers\traits\BenchTrait, \oihana\controllers\traits\CheckOwnerArgumentsTrait, \oihana\models\traits\ModelTrait, \oihana\controllers\traits\OutputDocumentsTrait, trait:short, trait:short, \oihana\controllers\traits\PrepareParamTrait, \oihana\controllers\traits\StatusTrait
Table of Contents
Methods
- list() : mixed
- List a set of elements with the model.
- prepareFacetCounts() : array<string|int, mixed>|null
- Resolves the facet-count dimensions for a list query.
- prepareGroup() : array<string|int, mixed>|null
- Resolves the {@see Arango::GROUP} spec for a list query.
- mapGroupParams() : array<string|int, mixed>
- Maps the short HTTP {@see GroupParam} keys onto the {@see Group} vocabulary.
Methods
list()
List a set of elements with the model.
public
list([ServerRequestInterface|null $request = null ][, ResponseInterface|null $response = null ][, array<string|int, mixed> $args = [] ][, array<string|int, mixed> $init = [] ]) : mixed
Ex: ../element?search=film Ex: ../element?facets={"location":12} Ex: ../element?facets={"type":"-event,visual/exhibition","eventStatus":"-scheduled"}
Parameters
- $request : ServerRequestInterface|null = null
- $response : ResponseInterface|null = null
- $args : array<string|int, mixed> = []
-
The route arguments
- $init : array<string|int, mixed> = []
-
ex: [ 'limit' => 0 ]
Tags
prepareFacetCounts()
Resolves the facet-count dimensions for a list query.
protected
prepareFacetCounts(ServerRequestInterface|null $request[, array<string|int, mixed> $args = [] ][, array<string|int, mixed>|null &$params = null ]) : array<string|int, mixed>|null
Parameters
- $request : ServerRequestInterface|null
-
The HTTP request.
- $args : array<string|int, mixed> = []
-
Predefined options (
$args[Arango::FACET_COUNTS]as base). - $params : array<string|int, mixed>|null = null
-
Echoed query params, populated by reference.
Return values
array<string|int, mixed>|null —The list of facet keys, or null when none requested.
prepareGroup()
Resolves the {@see Arango::GROUP} spec for a list query.
protected
prepareGroup(ServerRequestInterface|null $request[, array<string|int, mixed> $args = [] ][, array<string|int, mixed>|null &$params = null ]) : array<string|int, mixed>|null
Parameters
- $request : ServerRequestInterface|null
-
The HTTP request.
- $args : array<string|int, mixed> = []
-
Predefined options (
$args[Arango::GROUP]as base). - $params : array<string|int, mixed>|null = null
-
Echoed query params, populated by reference.
Return values
array<string|int, mixed>|null —The Group spec, or null when no grouping is requested.
mapGroupParams()
Maps the short HTTP {@see GroupParam} keys onto the {@see Group} vocabulary.
private
mapGroupParams(array<string|int, mixed> $decoded) : array<string|int, mixed>
Parameters
- $decoded : array<string|int, mixed>
-
The decoded
?group=JSON object.
Return values
array<string|int, mixed> —The translated spec keyed by Group::*.