Oihana PHP Arango

AQL uses ConstantsTrait, PaginationTrait

Table of Contents

Constants

_DEPTH  : string = '_depth'
_PARENT  : string = '_parent'
AGGREGATABLE  : string = 'aggregatable'
The 'aggregatable' parameter — the optional whitelist/mapping of aggregatable fields (`urlKey => fieldPath`) consumed by {@see \oihana\arango\models\traits\aql\GroupTrait::$aggregatable}.
AGGREGATABLE_POLICY  : string = 'aggregatablePolicy'
The 'aggregatablePolicy' parameter — what happens to an aggregate whose field is absent from {@see AQL::AGGREGATABLE}. One of the {@see \oihana\arango\models\enums\AggregatablePolicy} codes.
AGGREGATE  : string = 'aggregate'
ALTERS  : string = 'alters'
ANALYZER  : string = 'analyzer'
ANY_REF  : string = 'anyRef'
ARRAY  : string = 'array'
ARRAYS  : string = 'arrays'
ASSIGN  : string = 'assign'
BIND_COLLECTION  : string = '@collection'
BINDS  : string = 'binds'
BOTH  : string = 'both'
BOUNDS  : string = 'bounds'
CHILDREN  : string = 'children'
COLLECTION  : string = 'collection'
CONDITIONS  : string = 'conditions'
CONTEXT  : string = 'context'
COUNT  : string = 'count'
DATABASE  : string = 'database'
DEFAULT  : string = 'default'
DIRECTION  : string = 'direction'
DISCRIMINATOR  : string = 'discriminator'
DOC  : string = 'doc'
DOC_JOIN  : string = 'doc_join'
DOC_PREFIX  : string = 'doc_'
DOC_REF  : string = 'docRef'
DOCUMENT  : string = 'document'
EDGE  : string = 'edge'
EDGE_COLLECTION  : string = 'edgeCollection'
EDGE_REF  : string = 'edgeRef'
EDGES  : string = 'edges'
EXCLUDES  : string = 'excludes'
EXPRESSION  : string = 'expression'
FACETS  : string = 'facets'
FALLBACK  : string = 'fallback'
FIELD  : string = 'field'
FIELDS  : string = 'fields'
FILTER  : string = 'filter'
FILTERS  : string = 'filters'
FIRST  : string = 'first'
FOLLOWING  : string = 'following'
FROM  : string = 'from'
GRAPH  : string = 'graph'
GRAPH_DEFAULT  : string = 'vertex, edge, path'
GROUP  : string = 'group'
The 'group' parameter — holds a high-level grouping spec ({@see Group}) translated into an AQL `COLLECT` by {@see GroupTrait::prepareCollect()}.
GROUPABLE  : string = 'groupable'
The 'groupable' parameter — the optional whitelist/mapping of groupable dimensions (`urlKey => fieldPath`) consumed by {@see GroupTrait::$groupable}.
HYDRATION  : string = 'hydration'
ID  : string = 'id'
IN  : string = 'in'
INDEXES  : string = 'indexes'
INSERT  : string = 'insert'
INTO  : string = 'into'
IS_ARRAY  : string = 'isArray'
ITEM  : string = 'item'
JOIN  : string = 'join'
JOINS  : string = 'joins'
KEEP  : string = 'keep'
KEY  : string = 'key'
LAZY  : string = 'lazy'
LEAF  : string = 'leaf'
LENGTH  : string = 'length'
MAP  : string = 'map'
MAX_DEPTH  : string = 'maxDepth'
METHOD  : string = 'method'
MIN_DEPTH  : string = 'minDepth'
MOCK  : string = 'mock'
MODEL  : string = 'model'
NAME  : string = 'name'
NESTED  : string = 'nested'
NULL  : string = 'null'
OPERATOR  : string = 'operator'
OPTIONS  : string = 'options'
ORDER  : string = 'order'
PATH  : string = 'path'
PATH_REF  : string = 'pathRef'
PRECEDING  : string = 'preceding'
PREFIX  : string = 'prefix'
PROJECTION  : string = 'projection'
PROPERTY  : string = 'property'
PRUNE  : string = 'prune'
PURGE  : string = 'purge'
QUERY_ID  : string = 'queryId'
RANGE_VALUE  : string = 'rangeValue'
RAW  : string = 'raw'
RAW_KEYS  : string = 'rawKeys'
RAW_VALUES  : string = 'rawValues'
RELATION  : string = 'relation'
REPLACE  : string = 'replace'
REQUIRES  : string = 'requires'
RESOLVE  : string = '__resolve__'
RESULT  : string = 'result'
RETURN  : string = 'return'
SCHEMA  : string = 'schema'
SEARCH  : string = 'search'
SEARCH_OPTIONS  : string = 'searchOptions'
SEARCHABLE  : string = 'searchable'
SKIN  : string = 'skin'
SKIN_FIELDS  : string = 'skinFields'
SORT  : string = 'sort'
SORT_DEFAULT  : string = 'sortDefault'
SORT_TIEBREAK  : string = 'sortTiebreak'
SORTABLE  : string = 'sortable'
SOURCE  : string = 'source'
START_VERTEX  : string = 'startVertex'
TARGET  : string = 'target'
TO  : string = 'to'
TYPE  : string = 'type'
UNIQUE  : string = 'unique'
UPDATE  : string = 'update'
USE_SPACE  : string = 'useSpace'
VALUE  : string = 'value'
VALUES  : string = 'values'
VAR_COLLECTION  : string = '@@collection'
VERTEX  : string = 'vertex'
VERTEX_REF  : string = 'vertexRef'
VERTICES  : string = 'vertices'
VIEW  : string = 'view'
WHERE  : string = 'where'
WITH  : string = 'with'
WITH_COUNT  : string = 'withCount'
WITH_PATH  : string = 'withPath'

Constants

_DEPTH

public string _DEPTH = '_depth'

_PARENT

public string _PARENT = '_parent'

AGGREGATABLE

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

public string AGGREGATABLE = 'aggregatable'

It is the agg counterpart of AQL::GROUPABLE, but it keys on the field token, not on the output name: in [ 'total' => 'sum:speed' ] the output name total is chosen freely by the client, while speed is what the whitelist resolves (to speed.value, say). Accepts the three normalizeSortable() notations.

Absent (null), every projected path stays aggregatable — the historical behaviour. Declaring it closes the gate; AQL::AGGREGATABLE_POLICY chooses what happens to an undeclared aggregate.

AGGREGATABLE_POLICY

The 'aggregatablePolicy' parameter — what happens to an aggregate whose field is absent from {@see AQL::AGGREGATABLE}. One of the {@see \oihana\arango\models\enums\AggregatablePolicy} codes.

public string AGGREGATABLE_POLICY = 'aggregatablePolicy'

Defaults to AggregatablePolicy::DROP when a whitelist is declared, and to AggregatablePolicy::OPEN when none is.

AGGREGATE

public string AGGREGATE = 'aggregate'

ALTERS

public string ALTERS = 'alters'

ANALYZER

public string ANALYZER = 'analyzer'

ANY_REF

public string ANY_REF = 'anyRef'

ARRAY

public string ARRAY = 'array'

ARRAYS

public string ARRAYS = 'arrays'

ASSIGN

public string ASSIGN = 'assign'

BIND_COLLECTION

public string BIND_COLLECTION = '@collection'

BINDS

public string BINDS = 'binds'

BOTH

public string BOTH = 'both'

BOUNDS

public string BOUNDS = 'bounds'

CHILDREN

public string CHILDREN = 'children'

COLLECTION

public string COLLECTION = 'collection'

CONDITIONS

public string CONDITIONS = 'conditions'

CONTEXT

public string CONTEXT = 'context'

COUNT

public string COUNT = 'count'

DATABASE

public string DATABASE = 'database'

DEFAULT

public string DEFAULT = 'default'

DIRECTION

public string DIRECTION = 'direction'

DISCRIMINATOR

public string DISCRIMINATOR = 'discriminator'

DOC

public string DOC = 'doc'

DOC_JOIN

public string DOC_JOIN = 'doc_join'

DOC_PREFIX

public string DOC_PREFIX = 'doc_'

DOC_REF

public string DOC_REF = 'docRef'

DOCUMENT

public string DOCUMENT = 'document'

EDGE

public string EDGE = 'edge'

EDGE_COLLECTION

public string EDGE_COLLECTION = 'edgeCollection'

EDGE_REF

public string EDGE_REF = 'edgeRef'

EDGES

public string EDGES = 'edges'

EXCLUDES

public string EXCLUDES = 'excludes'

EXPRESSION

public string EXPRESSION = 'expression'

FACETS

public string FACETS = 'facets'

FALLBACK

public string FALLBACK = 'fallback'

FIELD

public string FIELD = 'field'

FIELDS

public string FIELDS = 'fields'

FILTER

public string FILTER = 'filter'

FILTERS

public string FILTERS = 'filters'

FIRST

public string FIRST = 'first'

FOLLOWING

public string FOLLOWING = 'following'

FROM

public string FROM = 'from'

GRAPH

public string GRAPH = 'graph'

GRAPH_DEFAULT

public string GRAPH_DEFAULT = 'vertex, edge, path'

GROUP

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

public string GROUP = 'group'

GROUPABLE

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

public string GROUPABLE = 'groupable'

HYDRATION

public string HYDRATION = 'hydration'

ID

public string ID = 'id'

IN

public string IN = 'in'

INDEXES

public string INDEXES = 'indexes'

INSERT

public string INSERT = 'insert'

INTO

public string INTO = 'into'

IS_ARRAY

public string IS_ARRAY = 'isArray'

ITEM

public string ITEM = 'item'

JOIN

public string JOIN = 'join'

JOINS

public string JOINS = 'joins'

KEEP

public string KEEP = 'keep'

KEY

public string KEY = 'key'

LAZY

public string LAZY = 'lazy'

LEAF

public string LEAF = 'leaf'

LENGTH

public string LENGTH = 'length'

MAP

public string MAP = 'map'

MAX_DEPTH

public string MAX_DEPTH = 'maxDepth'

METHOD

public string METHOD = 'method'

MIN_DEPTH

public string MIN_DEPTH = 'minDepth'

MOCK

public string MOCK = 'mock'

MODEL

public string MODEL = 'model'

NAME

public string NAME = 'name'

NESTED

public string NESTED = 'nested'

NULL

public string NULL = 'null'

OPERATOR

public string OPERATOR = 'operator'

OPTIONS

public string OPTIONS = 'options'

ORDER

public string ORDER = 'order'

PATH

public string PATH = 'path'

PATH_REF

public string PATH_REF = 'pathRef'

PRECEDING

public string PRECEDING = 'preceding'

PREFIX

public string PREFIX = 'prefix'

PROJECTION

public string PROJECTION = 'projection'

PROPERTY

public string PROPERTY = 'property'

PRUNE

public string PRUNE = 'prune'

PURGE

public string PURGE = 'purge'

QUERY_ID

public string QUERY_ID = 'queryId'

RANGE_VALUE

public string RANGE_VALUE = 'rangeValue'

RAW

public string RAW = 'raw'

RAW_KEYS

public string RAW_KEYS = 'rawKeys'

RAW_VALUES

public string RAW_VALUES = 'rawValues'

RELATION

public string RELATION = 'relation'

REPLACE

public string REPLACE = 'replace'

REQUIRES

public string REQUIRES = 'requires'

RESOLVE

public string RESOLVE = '__resolve__'

RESULT

public string RESULT = 'result'

RETURN

public string RETURN = 'return'

SCHEMA

public string SCHEMA = 'schema'
public string SEARCH = 'search'

SEARCH_OPTIONS

public string SEARCH_OPTIONS = 'searchOptions'

SEARCHABLE

public string SEARCHABLE = 'searchable'

SKIN

public string SKIN = 'skin'

SKIN_FIELDS

public string SKIN_FIELDS = 'skinFields'

SORT

public string SORT = 'sort'

SORT_DEFAULT

public string SORT_DEFAULT = 'sortDefault'

SORT_TIEBREAK

public string SORT_TIEBREAK = 'sortTiebreak'

SORTABLE

public string SORTABLE = 'sortable'

SOURCE

public string SOURCE = 'source'

START_VERTEX

public string START_VERTEX = 'startVertex'

TARGET

public string TARGET = 'target'

TO

public string TO = 'to'

TYPE

public string TYPE = 'type'

UNIQUE

public string UNIQUE = 'unique'

UPDATE

public string UPDATE = 'update'

USE_SPACE

public string USE_SPACE = 'useSpace'

VALUE

public string VALUE = 'value'

VALUES

public string VALUES = 'values'

VAR_COLLECTION

public string VAR_COLLECTION = '@@collection'

VERTEX

public string VERTEX = 'vertex'

VERTEX_REF

public string VERTEX_REF = 'vertexRef'

VERTICES

public string VERTICES = 'vertices'

VIEW

public string VIEW = 'view'

WHERE

public string WHERE = 'where'

WITH

public string WITH = 'with'

WITH_COUNT

public string WITH_COUNT = 'withCount'

WITH_PATH

public string WITH_PATH = 'withPath'
On this page

Search results