Oihana PHP Arango

FilterQuantifier uses ConstantsTrait

FinalYes

The element-axis quantifier catalogue of array filters (the `quant` key).

Each named code maps to the AQL quantifier keyword that answers « how many elements of the array must satisfy the condition ». The numeric quantifier AT LEAST (n) is parameterized (it carries a threshold), so it is built dynamically by resolveQuantifier() from a bare integer rather than being listed here.

The same vocabulary drives both array surfaces:

  • scalar arrays via the array comparison operator (doc.scores ALL >= @v);
  • object arrays via the question-mark operator (doc.reviews[? ALL FILTER …]).
Tags
since
1.0.0
author

Marc Alcaraz

Table of Contents

Constants

ALL  : string = 'all'
ANY  : string = 'any'
AT_LEAST  : string = 'atLeast'
The numeric quantifier prefix. The threshold `n` is supplied as a bare integer in the `quant` value (`"quant": 3`) and resolved to `AT LEAST (n)` by {@see \oihana\arango\db\helpers\resolveQuantifier()}.
NONE  : string = 'none'
__ALIAS__  : array<string|int, mixed> = [self::ALL => \oihana\arango\db\enums\ArrayComp...

Methods

getAlias()  : mixed
Returns the AQL quantifier keyword for a named quantifier code.

Constants

AT_LEAST

The numeric quantifier prefix. The threshold `n` is supplied as a bare integer in the `quant` value (`"quant": 3`) and resolved to `AT LEAST (n)` by {@see \oihana\arango\db\helpers\resolveQuantifier()}.

public string AT_LEAST = 'atLeast'

__ALIAS__

protected array<string|int, mixed> __ALIAS__ = [self::ALL => \oihana\arango\db\enums\ArrayComparator::ALL, self::ANY => \oihana\arango\db\enums\ArrayComparator::ANY, self::NONE => \oihana\arango\db\enums\ArrayComparator::NONE]

Methods

getAlias()

Returns the AQL quantifier keyword for a named quantifier code.

public static getAlias(mixed $value[, mixed $default = null ]) : mixed
Parameters
$value : mixed

The quantifier code (any, all, none).

$default : mixed = null

The value returned when the code is unknown (default null).

Return values
mixed

The AQL keyword (ANY, ALL, NONE), or $default when unknown.

On this page

Search results