Oihana PHP Arango

aqlBindRef.php

Table of Contents

Functions

aqlBindRef()  : AqlBindReference
Declares a reference to an AQL bind variable by name — a placeholder for a value supplied at query time, never inlined.

Functions

aqlBindRef()

Declares a reference to an AQL bind variable by name — a placeholder for a value supplied at query time, never inlined.

aqlBindRef(string $name) : AqlBindReference

Unlike aqlBind(), it registers no value and touches no bind map: it only names the slot. The value of @name is contributed by the caller via the existing top-level bind mechanism (AQL::BINDS), which merges into the query's single bindVars map.

The returned AqlBindReference is honored by the projection condition compiler (buildWhenLeaf()) on both the attribute (left) and the value (right) side of a leaf, so it composes with Field::WHERE and Field::WHEN.

Parameters
$name : string

The bind variable name, without the leading @.

Tags
throws
BindException

If $name is not a valid ArangoDB bind variable name.

example
aqlBindRef( 'allowedRegions' )->toAql() ; // '@allowedRegions'
aqlBindRef( '1bad' ) ;                     // throws BindException
since
1.6.0
author

Marc Alcaraz

Return values
AqlBindReference

The bind reference value object.

On this page

Search results