Oihana PHP System

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

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
see
CborTrait

INTERVAL_DEFAULT

The 'intervalDefault' parameter.

public string INTERVAL_DEFAULT = 'intervalDefault'

PARAMS_STRATEGY

The 'paramsStrategy' parameter.

public string PARAMS_STRATEGY = 'paramsStrategy'

TIMEZONE_DEFAULT

The 'timezoneDefault' parameter.

public string TIMEZONE_DEFAULT = 'timezoneDefault'
On this page

Search results