GroupParam uses ConstantsTrait
The short HTTP keys of the grouping surface, mapped by {@see \oihana\arango\controllers\traits\PrepareGroupTrait::prepareGroup()} onto the model-side {@see \oihana\arango\models\enums\Group} vocabulary.
?group={...}carries the full spec using these short keys (by/agg/count/sort/alt).?groupBy=(the vendor ControllerParam::GROUP_BY) is the CSV shortcut forby, implying a per-group count.
Tags
Table of Contents
Constants
- AGG : string = 'agg'
- The aggregates map (`{"total":"sum:amount"}`). Maps to {@see \oihana\arango\models\enums\Group::AGG}.
- ALT : string = 'alt'
- The grouping-key `alt` transform chains. Maps to {@see \oihana\arango\models\enums\Group::ALT}.
- BY : string = 'by'
- The grouping field(s). Maps to {@see \oihana\arango\models\enums\Group::BY}.
- COUNT : string = 'count'
- The per-group count flag/name. Maps to {@see \oihana\arango\models\enums\Group::COUNT}.
- GROUP : string = 'group'
- The `?group=` query parameter holding the full JSON spec.
- SORT : string = 'sort'
- The sort on group/aggregate variables. Maps to {@see \oihana\arango\models\enums\Group::SORT}.
Constants
AGG
The aggregates map (`{"total":"sum:amount"}`). Maps to {@see \oihana\arango\models\enums\Group::AGG}.
public
string
AGG
= 'agg'
ALT
The grouping-key `alt` transform chains. Maps to {@see \oihana\arango\models\enums\Group::ALT}.
public
string
ALT
= 'alt'
BY
The grouping field(s). Maps to {@see \oihana\arango\models\enums\Group::BY}.
public
string
BY
= 'by'
COUNT
The per-group count flag/name. Maps to {@see \oihana\arango\models\enums\Group::COUNT}.
public
string
COUNT
= 'count'
GROUP
The `?group=` query parameter holding the full JSON spec.
public
string
GROUP
= 'group'
SORT
The sort on group/aggregate variables. Maps to {@see \oihana\arango\models\enums\Group::SORT}.
public
string
SORT
= 'sort'