Param uses ConstantsTrait

Centralized enumeration of parameter keys used across various parts of the application.

use oihana\enums\Param;

$options = [
    Param::LIMIT   => 20,
    Param::OFFSET  => 0,
    Param::ORDER   => 'DESC',
    Param::FILTER  => ['status' => 'active'],
];

Tags

author

Marc Alcaraz (ekameleon)

since

1.0.0

Table of Contents

Constants

ACTION  : string = 'action'

ACTIONS  : string = 'actions'

ACTIVABLE  : string = 'activable'

ACTIVE  : string = 'active'

AFTER  : string = 'after'

ALIAS  : string = 'alias'

ALL  : string = 'all'

ALT  : string = 'alt'

ALTER  : string = 'alter'

ALTERS  : string = 'alters'

ARGS  : string = 'args'

BASE_PATH  : string = 'basePath'

BATCH_SIZE  : string = 'batchSize'

BEFORE  : string = 'before'

BENCH  : string = 'bench'

BINDS  : string = 'binds'

BOOL  : string = 'bool'

CACHE  : string = 'cache'

CACHEABLE  : string = 'cacheable'

COLLECTION  : string = 'collection'

COMPARATOR  : string = 'comparator'

COMPRESS  : string = 'compress'

CONDITION  : string = 'condition'

CONDITIONS  : string = 'conditions'

CONFIG  : string = 'config'

CONTEXT  : string = 'context'

CONTROLLER  : string = 'controller'

CONTROLLERS  : string = 'controllers'

CUSTOM_RULES  : string = 'customRules'

DATE  : string = 'date'

DATE_FORMAT  : string = 'dateFormat'

DEBUG  : string = 'debug'

DEFAULT  : string = 'default'

DEFAULT_NOT_EQUALS  : string = 'defaultNotEquals'

DEFER_ASSIGNMENT  : string = 'deferAssignment'

DEFINITION  : string = 'definition'

DESCRIPTION  : string = 'description'

DESTROY  : string = 'destroy'

DIRECTION  : string = 'direction'

DIRECTORY  : string = 'directory'

DOC  : string = 'doc'

DOC_REF  : string = 'docRef'

DOCS  : string = 'docs'

DOCUMENT_KEY  : string = 'documentKey'

DOCUMENTS  : string = 'documents'

ENABLE  : string = 'enable'

ENABLED  : string = 'enabled'

ENCRYPT  : string = 'encrypt'

EXCLUDES  : string = 'excludes'

EXIST  : string = 'exist'

EXTENSIONS  : string = 'extensions'

EXTRA_QUERY  : string = 'extraQuery'

FACET  : string = 'facet'

FACETS  : string = 'facets'

FIELD  : string = 'field'

FIELDS  : string = 'fields'

FILE  : string = 'file'

FILTER  : string = 'filter'

FILTER_KEYS  : string = 'filterKeys'

FILTER_PATCH_AND_PUT_KEYS  : string = 'filterPatchAndPutKeys'

FILTER_PATCH_KEYS  : string = 'filterPatchKeys'

FILTER_POST_KEYS  : string = 'filterPostKeys'

FILTER_PUT_KEYS  : string = 'filterPutKeys'

FILTERABLE  : string = 'filterable'

FORCE_URL  : string = 'forceUrl'

FORMAT  : string = 'format'

FULL_PATH  : string = 'fullPath'

GROUP_BY  : string = 'groupBy'

HARVEST  : string = 'harvest'

HAS_TOTAL  : string = 'hasTotal'

HELP  : string = 'help'

HTML  : string = 'html'

I18N  : string = 'i18n'

ID  : string = 'id'

IDS  : string = 'ids'

INFLECTOR  : string = 'inflector'

INIT  : string = 'init'

INSERT  : string = 'insert'

INTERVAL  : string = 'interval'

INTERVAL_DEFAULT  : string = 'interval_default'

ITEMS  : string = 'items'

JOIN  : string = 'join'

JOINS  : string = 'joins'

JSON  : string = 'json'

JSON_OPTIONS  : string = 'jsonOptions'

KEY  : string = 'key'

KEY_LIST  : string = 'keyList'

LANG  : string = 'lang'

LAST  : string = 'last'

LAZY  : string = 'lazy'

LIMIT  : string = 'limit'

LIMIT_DEFAULT  : string = 'limit_default'

LIST  : string = 'list'

LOCATION  : string = 'location'

LOCATIONS  : string = 'locations'

LOCKABLE  : string = 'lockable'

LOGGABLE  : string = 'loggable'

LOGGER  : string = 'logger'

MARGIN  : string = 'margin'

MATCH  : string = 'match'

MAX_DEPTH  : string = 'maxDepth'

MAX_INTERVAL  : string = 'maxInterval'

MAX_LIMIT  : string = 'maxLimit'

MAX_RANGE  : string = 'max_range'

MEMCACHED  : string = 'memcached'

METHOD  : string = 'method'

METHODS  : string = 'methods'

MIN_LIMIT  : string = 'minLimit'

MIN_RANGE  : string = 'min_range'

MOCK  : string = 'mock'

MODEL  : string = 'model'

MODEL_ID  : string = 'modelID'

MODELS  : string = 'models'

NAME  : string = 'name'

NOT_EQUALS  : string = 'notEquals'

NUM  : string = 'num'

OBJECT  : string = 'object'

OFFSET  : string = 'offset'

OFFSET_DEFAULT  : string = 'offset_default'

OP  : string = 'op'

OPTIMIZED  : string = 'optimized'

OPTIONS  : string = 'options'

ORDER  : string = 'order'

OVERWRITE  : string = 'overwrite'

OWNER  : string = 'owner'

OWNER_KEY  : string = 'ownerKey'

OWNER_PATH  : string = 'ownerPath'

OWNERS  : string = 'owners'

PARAMS  : string = 'params'

PARAMS_STRATEGY  : string = 'paramsStrategy'

PASS_PHRASE  : string = 'passphrase'

PASSWORD  : string = 'password'

PATH  : string = 'path'

PATTERN  : string = 'pattern'

PDO  : string = 'pdo'

POSITION  : string = 'position'

POST_INIT  : string = 'postInit'

PRE_INIT  : string = 'preInit'

PRECISION  : string = 'precision'

PREFIX  : string = 'prefix'

PRETTY_PRINT  : string = 'pretty_print'

PROPERTIES  : string = 'properties'

PROPERTY  : string = 'property'

PROPS  : string = 'props'

QUANTITY  : string = 'quantity'

QUERY  : string = 'query'

QUERY_BUILDER  : string = 'queryBuilder'

QUERY_FIELDS  : string = 'queryFields'

QUERY_ID  : string = 'queryId'

REDIRECTS  : string = 'redirects'

RELATIONS  : string = 'relations'

RETURN  : string = 'return'

REVERSE  : string = 'reverse'

ROUTE  : string = 'route'

RULE  : string = 'rule'

RULES  : string = 'rules'

SCHEMA  : string = 'schema'

SEARCH  : string = 'search'

SIDE  : string = 'side'

SILENT  : string = 'silent'

SINGLE  : string = 'single'

SKIN  : string = 'skin'

SKIN_DEFAULT  : string = 'skinDefault'

SKIN_FROM  : string = 'skinFrom'

SKIN_METHODS  : string = 'skinMethods'

SKIN_PREFIX  : string = 'skin_'

SKINS  : string = 'skins'

SKIP  : string = 'skip'

SORT  : string = 'sort'

SORT_DEFAULT  : string = 'sortDefault'

SORTABLE  : string = 'sortable'

STATUS  : string = 'status'

STATUS_NAME  : string = 'statusName'

STRICT  : string = 'strict'

TABLE  : string = 'table'

THINGS  : string = 'things'

TIMEZONE  : string = 'timezone'

TIMEZONE_DEFAULT  : string = 'timezone_default'

TOTAL  : string = 'total'

TYPE  : string = 'type'

UNIQUE  : string = 'unique'

UPDATE  : string = 'update'

URL  : string = 'url'

USERNAME  : string = 'username'

VAL  : string = 'val'

VALIDATE  : string = 'validate'

VALIDATOR  : string = 'validator'

VALUE  : string = 'value'

VALUES  : string = 'values'

VAR_NAME  : string = 'varName'

VERBOSE  : string = 'verbose'

WITH  : string = 'with'

Methods

groupByPrefix()  : array<string, mixed>

Returns an associative array of constants whose names start with the given prefix.

Param::groupByPrefix('FILTER_');
// [
//     'FILTER'                  => 'filter',
//     'FILTER_KEYS'            => 'filterKeys',
//     'FILTER_POST_KEYS'       => 'filterPostKeys',
//     ...
// ]