ControllerParam uses ConstantsTrait, ControllerParamTrait, PaginationTrait
The enumeration of all the common controller's parameters.
Table of Contents
Constants
- ACTIVE : string = 'active'
- The 'active' parameter.
- ALL : string = 'all'
- The 'all' parameter.
- API : string = 'api'
- The 'api' parameter.
- APP : string = 'app'
- The 'app' parameter.
- ARGS : string = 'args'
- The 'args' parameter.
- BASE_URL : string = 'baseUrl'
- The 'baseUrl' parameter.
- BENCH : string = 'bench'
- The 'bench' parameter.
- CAPABILITIES : string = 'capabilities'
- Capabilities configuration block — maps param names (SKIN, FILTER, ...) to per-param capability declarations.
- CAPABILITIES_ENABLED : string = 'capabilitiesEnabled'
- Optional kill-switch to disable the whole capability enforcement block without removing its declaration.
- CBOR_SERIALIZE_OPTIONS : string = 'cborSerializeOptions'
- The 'cborSerializeOptions' parameter.
- CONTROLLER : string = 'controller'
- The 'controller' parameter.
- CUSTOM_RULES : string = 'customRules'
- The 'customRules' parameter.
- DATE_FORMAT : string = 'dateFormat'
- The 'dateFormat' parameter.
- DOCUMENT_KEY : string = 'documentKey'
- The 'documentKey' parameter.
- FACETS : string = 'facets'
- The 'facets' parameter.
- FIELDS : string = 'fields'
- The 'fields' parameter.
- FILTER : string = 'filter'
- The 'filter' parameter.
- FORCE_URL : string = 'forceUrl'
- The 'forceUrl' parameter.
- FULL_PATH : string = 'fullPath'
- The 'fullPath' parameter.
- GROUP_BY : string = 'groupBy'
- The 'groupBy' parameter.
- HAS_TOTAL : string = 'hasTotal'
- The 'hasTotal' parameter.
- HTTP_CACHE : string = 'httpCache'
- The 'httpCache' parameter.
- ID : string = 'id'
- The 'id' parameter.
- IDS : string = 'ids'
- The 'ids' parameter.
- INTERVAL : string = 'interval'
- The 'interval' parameter.
- INTERVAL_DEFAULT : string = 'intervalDefault'
- The 'intervalDefault' parameter.
- JSON_OPTIONS : string = 'jsonOptions'
- The 'jsonOptions' parameter.
- JSON_SERIALIZE_OPTIONS : string = 'jsonSerializeOptions'
- The 'jsonSerializeOptions' parameter.
- KEY : string = 'key'
- The 'key' parameter.
- LANG : string = 'lang'
- The 'lang' parameter.
- LANGUAGES : string = 'languages'
- The 'languages' parameter.
- LIST : string = 'list'
- The 'list' parameter.
- MARGIN : string = 'margin'
- The 'margin' parameter.
- MOCK : string = 'mock'
- The 'mock' parameter.
- MODEL : string = 'model'
- The 'model' parameter.
- ORDER : string = 'order'
- The 'order' parameter.
- ORDERS : string = 'orders'
- The 'orders' parameter.
- OWNER : string = 'owner'
- The 'owner' parameter.
- OWNER_PATH : string = 'ownerPath'
- The 'ownerPath' parameter.
- PAGINATION : string = 'pagination'
- The 'pagination' parameter.
- PARAMS : string = 'params'
- The 'params' parameter.
- PARAMS_STRATEGY : string = 'paramsStrategy'
- The 'paramsStrategy' parameter.
- PATH : string = 'path'
- The 'path' parameter.
- PAYLOAD : string = 'payload'
- The 'payload' parameter.
- PAYLOADS : string = 'payloads'
- The 'payloads' parameter.
- QUANTITY : string = 'quantity'
- The 'quantity' parameter.
- REDIRECTS : string = 'redirects'
- The 'redirects' parameter.
- ROUTER : string = 'router'
- The 'router' parameter.
- RULES : string = 'rules'
- The 'rules' parameter.
- SANITIZE : string = 'sanitize'
- The 'sanitize' parameter.
- SCHEMA : string = 'schema'
- The 'schema' parameter.
- SEARCH : string = 'search'
- The 'search' parameter.
- SKIN : string = 'skin'
- The 'skin' parameter.
- SKIN_DEFAULT : string = 'skinDefault'
- The 'skinDefault' parameter.
- SKIN_METHODS : string = 'skinMethods'
- The 'skinMethods' parameter.
- SKINS : string = 'skins'
- The 'skins' parameter.
- SORT : string = 'sort'
- The 'sort' parameter.
- SORT_DEFAULT : string = 'sortDefault'
- The 'sortDefault' parameter.
- STATUS : string = 'status'
- The 'status' parameter.
- TIMEZONE : string = 'timezone'
- The 'timezone' parameter.
- TIMEZONE_DEFAULT : string = 'timezoneDefault'
- The 'timezoneDefault' parameter.
- TWIG : string = 'twig'
- The 'twig' parameter.
- TYPE : string = 'type'
- The 'type' parameter.
- URL : string = 'url'
- The 'url' parameter.
- VALIDATOR : string = 'validator'
- The 'validator' parameter.
- VALUE : string = 'value'
- The 'value' parameter.
Constants
ACTIVE
The 'active' parameter.
public
string
ACTIVE
= 'active'
ALL
The 'all' parameter.
public
string
ALL
= 'all'
API
The 'api' parameter.
public
string
API
= 'api'
Tags
APP
The 'app' parameter.
public
string
APP
= 'app'
Tags
ARGS
The 'args' parameter.
public
string
ARGS
= 'args'
BASE_URL
The 'baseUrl' parameter.
public
string
BASE_URL
= 'baseUrl'
BENCH
The 'bench' parameter.
public
string
BENCH
= 'bench'
CAPABILITIES
Capabilities configuration block — maps param names (SKIN, FILTER, ...) to per-param capability declarations.
public
string
CAPABILITIES
= 'capabilities'
CAPABILITIES_ENABLED
Optional kill-switch to disable the whole capability enforcement block without removing its declaration.
public
string
CAPABILITIES_ENABLED
= 'capabilitiesEnabled'
Defaults to true when the CAPABILITIES block is present.
CBOR_SERIALIZE_OPTIONS
The 'cborSerializeOptions' parameter.
public
string
CBOR_SERIALIZE_OPTIONS
= 'cborSerializeOptions'
Tags
CONTROLLER
The 'controller' parameter.
public
string
CONTROLLER
= 'controller'
CUSTOM_RULES
The 'customRules' parameter.
public
string
CUSTOM_RULES
= 'customRules'
DATE_FORMAT
The 'dateFormat' parameter.
public
string
DATE_FORMAT
= 'dateFormat'
DOCUMENT_KEY
The 'documentKey' parameter.
public
string
DOCUMENT_KEY
= 'documentKey'
FACETS
The 'facets' parameter.
public
string
FACETS
= 'facets'
FIELDS
The 'fields' parameter.
public
string
FIELDS
= 'fields'
FILTER
The 'filter' parameter.
public
string
FILTER
= 'filter'
FORCE_URL
The 'forceUrl' parameter.
public
string
FORCE_URL
= 'forceUrl'
FULL_PATH
The 'fullPath' parameter.
public
string
FULL_PATH
= 'fullPath'
GROUP_BY
The 'groupBy' parameter.
public
string
GROUP_BY
= 'groupBy'
HAS_TOTAL
The 'hasTotal' parameter.
public
string
HAS_TOTAL
= 'hasTotal'
HTTP_CACHE
The 'httpCache' parameter.
public
string
HTTP_CACHE
= 'httpCache'
ID
The 'id' parameter.
public
string
ID
= 'id'
IDS
The 'ids' parameter.
public
string
IDS
= 'ids'
INTERVAL
The 'interval' parameter.
public
string
INTERVAL
= 'interval'
INTERVAL_DEFAULT
The 'intervalDefault' parameter.
public
string
INTERVAL_DEFAULT
= 'intervalDefault'
JSON_OPTIONS
The 'jsonOptions' parameter.
public
string
JSON_OPTIONS
= 'jsonOptions'
Tags
JSON_SERIALIZE_OPTIONS
The 'jsonSerializeOptions' parameter.
public
string
JSON_SERIALIZE_OPTIONS
= 'jsonSerializeOptions'
Tags
KEY
The 'key' parameter.
public
string
KEY
= 'key'
LANG
The 'lang' parameter.
public
string
LANG
= 'lang'
LANGUAGES
The 'languages' parameter.
public
string
LANGUAGES
= 'languages'
LIST
The 'list' parameter.
public
string
LIST
= 'list'
MARGIN
The 'margin' parameter.
public
string
MARGIN
= 'margin'
MOCK
The 'mock' parameter.
public
string
MOCK
= 'mock'
MODEL
The 'model' parameter.
public
string
MODEL
= 'model'
ORDER
The 'order' parameter.
public
string
ORDER
= 'order'
ORDERS
The 'orders' parameter.
public
string
ORDERS
= 'orders'
OWNER
The 'owner' parameter.
public
string
OWNER
= 'owner'
OWNER_PATH
The 'ownerPath' parameter.
public
string
OWNER_PATH
= 'ownerPath'
PAGINATION
The 'pagination' parameter.
public
string
PAGINATION
= 'pagination'
Tags
PARAMS
The 'params' parameter.
public
string
PARAMS
= 'params'
PARAMS_STRATEGY
The 'paramsStrategy' parameter.
public
string
PARAMS_STRATEGY
= 'paramsStrategy'
PATH
The 'path' parameter.
public
string
PATH
= 'path'
PAYLOAD
The 'payload' parameter.
public
string
PAYLOAD
= 'payload'
Tags
PAYLOADS
The 'payloads' parameter.
public
string
PAYLOADS
= 'payloads'
Tags
QUANTITY
The 'quantity' parameter.
public
string
QUANTITY
= 'quantity'
REDIRECTS
The 'redirects' parameter.
public
string
REDIRECTS
= 'redirects'
ROUTER
The 'router' parameter.
public
string
ROUTER
= 'router'
RULES
The 'rules' parameter.
public
string
RULES
= 'rules'
SANITIZE
The 'sanitize' parameter.
public
string
SANITIZE
= 'sanitize'
SCHEMA
The 'schema' parameter.
public
string
SCHEMA
= 'schema'
SEARCH
The 'search' parameter.
public
string
SEARCH
= 'search'
SKIN
The 'skin' parameter.
public
string
SKIN
= 'skin'
SKIN_DEFAULT
The 'skinDefault' parameter.
public
string
SKIN_DEFAULT
= 'skinDefault'
SKIN_METHODS
The 'skinMethods' parameter.
public
string
SKIN_METHODS
= 'skinMethods'
SKINS
The 'skins' parameter.
public
string
SKINS
= 'skins'
SORT
The 'sort' parameter.
public
string
SORT
= 'sort'
SORT_DEFAULT
The 'sortDefault' parameter.
public
string
SORT_DEFAULT
= 'sortDefault'
STATUS
The 'status' parameter.
public
string
STATUS
= 'status'
TIMEZONE
The 'timezone' parameter.
public
string
TIMEZONE
= 'timezone'
TIMEZONE_DEFAULT
The 'timezoneDefault' parameter.
public
string
TIMEZONE_DEFAULT
= 'timezoneDefault'
TWIG
The 'twig' parameter.
public
string
TWIG
= 'twig'
TYPE
The 'type' parameter.
public
string
TYPE
= 'type'
URL
The 'url' parameter.
public
string
URL
= 'url'
VALIDATOR
The 'validator' parameter.
public
string
VALIDATOR
= 'validator'
VALUE
The 'value' parameter.
public
string
VALUE
= 'value'