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  = 'action'

ACTIONS  = 'actions'

ACTIVABLE  = 'activable'

ACTIVE  = 'active'

AFTER  = 'after'

ALIAS  = 'alias'

ALL  = 'all'

ALT  = 'alt'

ALTER  = 'alter'

ALTERS  = 'alters'

ARGS  = 'args'

BASE_PATH  = 'basePath'

BATCH_SIZE  = 'batchSize'

BEFORE  = 'before'

BENCH  = 'bench'

BINDS  = 'binds'

BOOL  = 'bool'

CACHE  = 'cache'

CACHEABLE  = 'cacheable'

COLLECTION  = 'collection'

COMPARATOR  = 'comparator'

COMPRESS  = 'compress'

CONDITION  = 'condition'

CONDITIONS  = 'conditions'

CONFIG  = 'config'

CONTEXT  = 'context'

CONTROLLER  = 'controller'

CONTROLLERS  = 'controllers'

CUSTOM_RULES  = 'customRules'

DATE  = 'date'

DATE_FORMAT  = 'dateFormat'

DEBUG  = 'debug'

DEFAULT  = 'default'

DEFAULT_NOT_EQUALS  = 'defaultNotEquals'

DEFER_ASSIGNMENT  = 'deferAssignment'

DEFINITION  = 'definition'

DESCRIPTION  = 'description'

DESTROY  = 'destroy'

DIRECTION  = 'direction'

DIRECTORY  = 'directory'

DOC  = 'doc'

DOC_REF  = 'docRef'

DOCS  = 'docs'

DOCUMENT_KEY  = 'documentKey'

DOCUMENTS  = 'documents'

ENABLE  = 'enable'

ENABLED  = 'enabled'

ENCRYPT  = 'encrypt'

EXCLUDES  = 'excludes'

EXIST  = 'exist'

EXTENSIONS  = 'extensions'

EXTRA_QUERY  = 'extraQuery'

FACET  = 'facet'

FACETS  = 'facets'

FIELD  = 'field'

FIELDS  = 'fields'

FILE  = 'file'

FILTER  = 'filter'

FILTER_KEYS  = 'filterKeys'

FILTER_PATCH_AND_PUT_KEYS  = 'filterPatchAndPutKeys'

FILTER_PATCH_KEYS  = 'filterPatchKeys'

FILTER_POST_KEYS  = 'filterPostKeys'

FILTER_PUT_KEYS  = 'filterPutKeys'

FILTERABLE  = 'filterable'

FORCE_URL  = 'forceUrl'

FORMAT  = 'format'

FULL_PATH  = 'fullPath'

GROUP_BY  = 'groupBy'

HARVEST  = 'harvest'

HAS_TOTAL  = 'hasTotal'

HELP  = 'help'

HTML  = 'html'

I18N  = 'i18n'

ID  = 'id'

IDS  = 'ids'

INFLECTOR  = 'inflector'

INIT  = 'init'

INSERT  = 'insert'

INTERVAL  = 'interval'

INTERVAL_DEFAULT  = 'interval_default'

ITEMS  = 'items'

JOIN  = 'join'

JOINS  = 'joins'

JSON  = 'json'

JSON_OPTIONS  = 'jsonOptions'

KEY  = 'key'

KEY_LIST  = 'keyList'

LANG  = 'lang'

LAST  = 'last'

LAZY  = 'lazy'

LIMIT  = 'limit'

LIMIT_DEFAULT  = 'limit_default'

LIST  = 'list'

LOCATION  = 'location'

LOCATIONS  = 'locations'

LOCKABLE  = 'lockable'

LOGGABLE  = 'loggable'

LOGGER  = 'logger'

MARGIN  = 'margin'

MATCH  = 'match'

MAX_DEPTH  = 'maxDepth'

MAX_INTERVAL  = 'maxInterval'

MAX_LIMIT  = 'maxLimit'

MAX_RANGE  = 'max_range'

MEMCACHED  = 'memcached'

METHOD  = 'method'

METHODS  = 'methods'

MIN_LIMIT  = 'minLimit'

MIN_RANGE  = 'min_range'

MOCK  = 'mock'

MODEL  = 'model'

MODEL_ID  = 'modelID'

MODELS  = 'models'

NAME  = 'name'

NOT_EQUALS  = 'notEquals'

NUM  = 'num'

OBJECT  = 'object'

OFFSET  = 'offset'

OFFSET_DEFAULT  = 'offset_default'

OP  = 'op'

OPTIMIZED  = 'optimized'

OPTIONS  = 'options'

ORDER  = 'order'

OVERWRITE  = 'overwrite'

OWNER  = 'owner'

OWNER_KEY  = 'ownerKey'

OWNER_PATH  = 'ownerPath'

OWNERS  = 'owners'

PARAMS  = 'params'

PARAMS_STRATEGY  = 'paramsStrategy'

PASS_PHRASE  = 'passphrase'

PATH  = 'path'

PATTERN  = 'pattern'

PDO  = 'pdo'

POSITION  = 'position'

POST_INIT  = 'postInit'

PRE_INIT  = 'preInit'

PRECISION  = 'precision'

PREFIX  = 'prefix'

PRETTY_PRINT  = 'pretty_print'

PROPERTIES  = 'properties'

PROPERTY  = 'property'

PROPS  = 'props'

QUANTITY  = 'quantity'

QUERY  = 'query'

QUERY_BUILDER  = 'queryBuilder'

QUERY_FIELDS  = 'queryFields'

QUERY_ID  = 'queryId'

REDIRECTS  = 'redirects'

RELATIONS  = 'relations'

RETURN  = 'return'

REVERSE  = 'reverse'

ROUTE  = 'route'

RULE  = 'rule'

RULES  = 'rules'

SCHEMA  = 'schema'

SEARCH  = 'search'

SIDE  = 'side'

SILENT  = 'silent'

SINGLE  = 'single'

SKIN  = 'skin'

SKIN_DEFAULT  = 'skinDefault'

SKIN_FROM  = 'skinFrom'

SKIN_METHODS  = 'skinMethods'

SKIN_PREFIX  = 'skin_'

SKINS  = 'skins'

SKIP  = 'skip'

SORT  = 'sort'

SORT_DEFAULT  = 'sortDefault'

SORTABLE  = 'sortable'

STATUS  = 'status'

STATUS_NAME  = 'statusName'

STRICT  = 'strict'

TABLE  = 'table'

THINGS  = 'things'

TIMEZONE  = 'timezone'

TIMEZONE_DEFAULT  = 'timezone_default'

TOTAL  = 'total'

TYPE  = 'type'

UNIQUE  = 'unique'

UPDATE  = 'update'

URL  = 'url'

VAL  = 'val'

VALIDATOR  = 'validator'

VALUE  = 'value'

VALUES  = 'values'

VAR_NAME  = 'varName'

VERBOSE  = 'verbose'

WITH  = 'with'

Properties

$ALL  : array<string|int, mixed>|null

The list of all constants.

$CONSTANTS  : array<string|int, mixed>|null

The flipped list of all constants.

Methods

enums()  : array<string|int, mixed>

Returns an array of all constants in this enumeration.

get()  : mixed

Returns a valid enumeration value or the default value.

getAll()  : array<string, string>

Returns an array of constants in this class.

getConstant()  : string|array<string|int, string>|null

Returns the constant name(s) associated with the given value.

groupByPrefix()  : array<string, mixed>

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

includes()  : bool

Checks if a given value is valid (exists as a constant in this class).

resetCaches()  : void

Reset the internal cache of the static methods.

validate()  : void

Validates if the passed-in value is a valid element in the current enum.

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