Oihana PHP Arango

Arango uses ConstantsTrait, ControllerParamTrait, PaginationTrait, ModelParamTrait

Central enumeration of ArangoDB-related parameters used throughout controllers, models, and pagination contexts.

Provides typed constants for common parameters such as 'doc', 'model', 'collection', 'queryFields', 'active', 'insert', 'update', etc.

Traits used:

  • ControllerParamTrait : adds controller-related parameter utilities.
  • ModelParamTrait : adds model-related parameter utilities.
  • PaginationTrait : adds pagination-related constants.
  • ConstantsTrait : adds helper methods for constants introspection.

Example usage:

$param = Arango::DOC;

Table of Contents

Constants

ACTIVABLE  : string = 'activable'
The 'activable' parameter.
ALTER  : string = 'alter'
The 'alter' parameter.
AUTHORIZER  : string = 'authorizer'
The 'authorizer' parameter.
CACHEABLE  : string = 'cacheable'
The 'cacheable' parameter.
COLLECT  : string = 'collect'
The 'collect' parameter — holds an AQL `COLLECT` (grouping/aggregation) spec forwarded to {@see aqlCollect()}.
COLLECTION  : string = 'collection'
The 'collection' parameter.
COMPRESS  : string = 'compress'
The 'compress' parameter.
CONDITIONS  : string = 'conditions'
The 'conditions' parameter.
CONTEXT  : string = 'context'
The 'context' parameter.
CONTROLLER  : string = 'controller'
The 'controller' parameter.
COUNT  : string = 'count'
The 'count' parameter.
COUNTER  : string = 'counter'
The 'counter' parameter.
DATABASE  : string = 'database'
The 'database' parameter.
DATE_FIELD  : string = 'dateField'
The 'dateField' parameter.
DEFAULT  : string = 'default'
The 'default' parameter.
DIRECTION  : string = 'direction'
The 'direction' parameter.
DOC  : string = 'doc'
The 'doc' parameter.
DOC_REF  : string = 'docRef'
The 'docRef' parameter.
DOCUMENT  : string = 'document'
The 'document' parameter.
DOCUMENTS  : string = 'documents'
The 'documents' parameter.
EDGE  : string = 'edge'
The 'edge' parameter.
EDGES  : string = 'edges'
The 'edges' parameter.
EXCLUDES  : string = 'excludes'
The 'excludes' parameter.
EXIST  : string = 'exist'
The 'exist' parameter.
EXTRA_QUERY  : string = 'extraQuery'
The 'extraQuery' parameter.
FACET_COUNTS  : string = 'facetCounts'
The 'facetCounts' parameter — the list of facet keys (from `Arango::FACETS`) for which per-value bucket counts are computed alongside the list, by {@see \oihana\arango\models\traits\queries\FacetCountsQueryTrait::buildFacetCountsQuery()}.
FIELD  : string = 'field'
The 'field' parameter.
FROM  : string = 'from'
The 'from' parameter.
GROUP  : string = 'group'
The 'group' parameter — holds a high-level grouping spec ({@see \oihana\arango\models\enums\Group}) translated into an AQL `COLLECT` by {@see \oihana\arango\models\traits\aql\GroupTrait::prepareCollect()}.
GROUPABLE  : string = 'groupable'
The 'groupable' parameter — the optional whitelist/mapping of groupable dimensions (`urlKey => fieldPath`) consumed by {@see \oihana\arango\models\traits\aql\GroupTrait::$groupable}.
IN  : string = 'in'
The 'in' parameter.
INDEXES  : string = 'indexes'
The 'indexes' parameter.
INIT  : string = 'init'
The 'init' parameter.
INSERT  : string = 'insert'
The 'insert' parameter.
JOINS  : string = 'joins'
The 'joins' parameter.
KEY_LIST  : string = 'keyList'
The 'keyList' parameter.
LAZY  : string = 'lazy'
The 'lazy' parameter.
MATCH  : string = 'match'
The 'match' parameter.
MODE  : string = 'mode'
The 'mode' parameter.
MODEL_ID  : string = 'modelID'
The 'modelID' parameter.
NAME  : string = 'name'
The 'name' parameter.
NEAR  : string = 'near'
The 'near' parameter — a geospatial anchor for distance sorting.
NUM  : string = 'num'
The 'num' parameter.
OPTIONS  : string = 'options'
The 'options' parameter.
POSITION  : string = 'position'
The 'position' parameter.
PREFIX  : string = 'prefix'
The 'prefix' parameter.
PROFILE  : string = 'profile'
The 'profile' parameter — when truthy, `list()` / `get()` run the query in profiled mode (`true` → profile level 2) and the measurements are exposed through {@see \oihana\arango\models\traits\ArangoTrait::getProfile()}.
PROPERTY  : string = 'property'
The 'property' parameter.
RAW  : string = 'raw'
The 'raw' parameter.
RELATIONS  : string = 'relations'
The 'relations' parameter.
REMOVE_KEYS  : string = 'removeKeys'
The 'removeKeys' parameter.
REPLACE  : string = 'replace'
The 'replace' parameter.
RETURN  : string = 'return'
The 'return' parameter.
ROUTE  : string = 'route'
The 'route' parameter.
SIDE  : string = 'side'
The 'side' parameter.
SKIP  : string = 'skip'
The 'skip' parameter.
SORTABLE  : string = 'sortable'
The 'sortable' parameter.
TO  : string = 'to'
The 'to' parameter.
TOUCH  : string = 'touch'
The 'touch' parameter.
UNIQUE  : string = 'unique'
The 'unique' parameter.
UPDATE  : string = 'update'
The 'update' parameter.
VAR_NAME  : string = 'varName'
The 'varName' parameter.
VARIABLES  : string = 'variables'
The 'variables' parameter.

Constants

ACTIVABLE

The 'activable' parameter.

public string ACTIVABLE = 'activable'

ALTER

The 'alter' parameter.

public string ALTER = 'alter'

AUTHORIZER

The 'authorizer' parameter.

public string AUTHORIZER = 'authorizer'

Optional Closure(string $subject): bool injected through $init so AQL projection helpers can gate fields on permission subjects via Field::REQUIRES without introducing a hard dependency on a specific authorization backend (Casbin, opa, custom, ...).

CACHEABLE

The 'cacheable' parameter.

public string CACHEABLE = 'cacheable'

COLLECT

The 'collect' parameter — holds an AQL `COLLECT` (grouping/aggregation) spec forwarded to {@see aqlCollect()}.

public string COLLECT = 'collect'

COLLECTION

The 'collection' parameter.

public string COLLECTION = 'collection'

COMPRESS

The 'compress' parameter.

public string COMPRESS = 'compress'

CONDITIONS

The 'conditions' parameter.

public string CONDITIONS = 'conditions'

CONTEXT

The 'context' parameter.

public string CONTEXT = 'context'

CONTROLLER

The 'controller' parameter.

public string CONTROLLER = 'controller'

COUNT

The 'count' parameter.

public string COUNT = 'count'

When true, a bulk array operation returns the number of affected documents (server-side COLLECT WITH COUNT) instead of the list of modified documents.

COUNTER

The 'counter' parameter.

public string COUNTER = 'counter'

Name of the sibling field holding the length of an embedded array, kept in sync (LENGTH(...)) on every mutation by DocumentsArrayTrait.

DATABASE

The 'database' parameter.

public string DATABASE = 'database'

DATE_FIELD

The 'dateField' parameter.

public string DATE_FIELD = 'dateField'

DEFAULT

The 'default' parameter.

public string DEFAULT = 'default'

DIRECTION

The 'direction' parameter.

public string DIRECTION = 'direction'

DOC

The 'doc' parameter.

public string DOC = 'doc'

DOC_REF

The 'docRef' parameter.

public string DOC_REF = 'docRef'

DOCUMENT

The 'document' parameter.

public string DOCUMENT = 'document'

DOCUMENTS

The 'documents' parameter.

public string DOCUMENTS = 'documents'

EDGE

The 'edge' parameter.

public string EDGE = 'edge'

EDGES

The 'edges' parameter.

public string EDGES = 'edges'

EXCLUDES

The 'excludes' parameter.

public string EXCLUDES = 'excludes'

EXIST

The 'exist' parameter.

public string EXIST = 'exist'

EXTRA_QUERY

The 'extraQuery' parameter.

public string EXTRA_QUERY = 'extraQuery'

FACET_COUNTS

The 'facetCounts' parameter — the list of facet keys (from `Arango::FACETS`) for which per-value bucket counts are computed alongside the list, by {@see \oihana\arango\models\traits\queries\FacetCountsQueryTrait::buildFacetCountsQuery()}.

public string FACET_COUNTS = 'facetCounts'

FIELD

The 'field' parameter.

public string FIELD = 'field'

FROM

The 'from' parameter.

public string FROM = 'from'

GROUP

The 'group' parameter — holds a high-level grouping spec ({@see \oihana\arango\models\enums\Group}) translated into an AQL `COLLECT` by {@see \oihana\arango\models\traits\aql\GroupTrait::prepareCollect()}.

public string GROUP = 'group'

GROUPABLE

The 'groupable' parameter — the optional whitelist/mapping of groupable dimensions (`urlKey => fieldPath`) consumed by {@see \oihana\arango\models\traits\aql\GroupTrait::$groupable}.

public string GROUPABLE = 'groupable'

IN

The 'in' parameter.

public string IN = 'in'

INDEXES

The 'indexes' parameter.

public string INDEXES = 'indexes'

INIT

The 'init' parameter.

public string INIT = 'init'

INSERT

The 'insert' parameter.

public string INSERT = 'insert'

JOINS

The 'joins' parameter.

public string JOINS = 'joins'

KEY_LIST

The 'keyList' parameter.

public string KEY_LIST = 'keyList'

LAZY

The 'lazy' parameter.

public string LAZY = 'lazy'

MATCH

The 'match' parameter.

public string MATCH = 'match'

MODE

The 'mode' parameter.

public string MODE = 'mode'

Optional per-call override of an embedded array field's ArrayMode.

MODEL_ID

The 'modelID' parameter.

public string MODEL_ID = 'modelID'

NAME

The 'name' parameter.

public string NAME = 'name'

NEAR

The 'near' parameter — a geospatial anchor for distance sorting.

public string NEAR = 'near'

Holds a { key, latitude, longitude } object: the document attribute to measure from (key) plus the reference point. It exposes the synthetic distance sort key consumed by SortTrait::prepareSort().

NUM

The 'num' parameter.

public string NUM = 'num'

OPTIONS

The 'options' parameter.

public string OPTIONS = 'options'

POSITION

The 'position' parameter.

public string POSITION = 'position'

PREFIX

The 'prefix' parameter.

public string PREFIX = 'prefix'

PROFILE

The 'profile' parameter — when truthy, `list()` / `get()` run the query in profiled mode (`true` → profile level 2) and the measurements are exposed through {@see \oihana\arango\models\traits\ArangoTrait::getProfile()}.

public string PROFILE = 'profile'

PROPERTY

The 'property' parameter.

public string PROPERTY = 'property'

RAW

The 'raw' parameter.

public string RAW = 'raw'

RELATIONS

The 'relations' parameter.

public string RELATIONS = 'relations'

REMOVE_KEYS

The 'removeKeys' parameter.

public string REMOVE_KEYS = 'removeKeys'

REPLACE

The 'replace' parameter.

public string REPLACE = 'replace'

RETURN

The 'return' parameter.

public string RETURN = 'return'

ROUTE

The 'route' parameter.

public string ROUTE = 'route'

SIDE

The 'side' parameter.

public string SIDE = 'side'

SKIP

The 'skip' parameter.

public string SKIP = 'skip'

SORTABLE

The 'sortable' parameter.

public string SORTABLE = 'sortable'

TO

The 'to' parameter.

public string TO = 'to'

TOUCH

The 'touch' parameter.

public string TOUCH = 'touch'

Indicates if a document timestamp or date must be updated (modified=now())

UNIQUE

The 'unique' parameter.

public string UNIQUE = 'unique'

UPDATE

The 'update' parameter.

public string UPDATE = 'update'

VAR_NAME

The 'varName' parameter.

public string VAR_NAME = 'varName'

VARIABLES

The 'variables' parameter.

public string VARIABLES = 'variables'
On this page

Search results