Wraps the ArangoDB AQL function ATTRIBUTES(document, removeSystemAttrs, sort) (also aliased as KEYS()).

Example AQL usage:

ATTRIBUTES({b: 2, _key: "x", a: 1})              // returns ["b", "_key", "a"]
ATTRIBUTES({b: 2, _key: "x", a: 1}, true)        // returns ["b", "a"]
ATTRIBUTES({b: 2, _key: "x", a: 1}, true, true)  // returns ["a", "b"]

Wraps the ArangoDB AQL function COUNT(document).

Example AQL usage:

COUNT({a: 1, b: 2})   // returns 2

Wraps the ArangoDB AQL function ENTRIES(document).

Example AQL usage:

ENTRIES({a: 1, b: 2})   // returns [["a", 1], ["b", 2]]

This helper wraps the ArangoDB AQL function HAS(document, attributeName) which returns true if the document has an attribute named attributeName, even if its value is falsy (null, 0, false, or empty string).

Example AQL usage:

HAS(doc, "name")              // returns true if doc has a "name" attribute
HAS(doc, "email")             // returns true if doc has an "email" attribute
HAS(doc, "nonExistent")       // returns false if attribute doesn't exist

Wraps the ArangoDB AQL function IS_SAME_COLLECTION(collectionName, documentIdentifier). The collection name is emitted as a quoted string literal (json_encode); the document identifier stays a raw expression (typically doc._id).

Example AQL usage:

IS_SAME_COLLECTION("products", "products/123")   // returns true
IS_SAME_COLLECTION("products", doc._id)          // true if doc lives in products

Wraps the ArangoDB AQL function KEEP(document, attributeName1, … attributeNameN). The attribute names are emitted as quoted string literals (json_encode), so AQL receives a valid call; the document stays a raw expression.

Example AQL usage:

KEEP(doc, "name", "age")   // a copy of doc with only its name and age attributes

Wraps the ArangoDB AQL function KEEP_RECURSIVE(document, attributeName1, … attributeNameN). The attribute names are emitted as quoted string literals (json_encode); the document stays a raw expression.

Example AQL usage:

KEEP_RECURSIVE(doc, "name", "meta")   // keeps name/meta at every nesting level

Wraps the ArangoDB AQL function KEYS(document, removeSystemAttrs, sort).

Example AQL usage:

KEYS({b: 2, a: 1})         // returns ["b", "a"]
KEYS({b: 2, a: 1}, false, true)   // returns ["a", "b"] (sorted)

Wraps the ArangoDB AQL function LENGTH(document) (also aliased as COUNT()).

Example AQL usage:

LENGTH({a: 1, b: 2})   // returns 2

Wraps the ArangoDB AQL function MATCHES(document, examples, returnIndex). The examples argument is emitted as a JSON literal when given as a PHP array; a string is passed through as a raw AQL expression. With $returnIndex = true, the function returns the (zero-based) index of the first matching example instead of a boolean.

Example AQL usage:

MATCHES(doc, {age: 30})                       // true if doc.age == 30
MATCHES(doc, [{age: 30}, {age: 40}], true)    // index of the first matching example, or -1

This helper wraps the ArangoDB AQL function MERGE(document1, document2, ... documentN) which merges multiple documents into a single document. Later documents override attributes from earlier documents if they have the same key.

Example AQL usage:

MERGE(doc1, doc2)             // merges doc1 and doc2
MERGE(doc1, doc2, doc3)       // merges three documents
MERGE({a: 1}, {b: 2})         // returns {a: 1, b: 2}
MERGE({a: 1}, {a: 2})         // returns {a: 2} (later overrides)

Wraps the ArangoDB AQL function MERGE_RECURSIVE(document1, … documentN). Unlike merge(), sub-documents with the same key are merged recursively rather than replaced wholesale.

Example AQL usage:

MERGE_RECURSIVE({a: {b: 1}}, {a: {c: 2}})   // returns {a: {b: 1, c: 2}}

Wraps the ArangoDB AQL function PARSE_COLLECTION(documentIdentifier).

Example AQL usage:

PARSE_COLLECTION("products/123")   // returns "products"
PARSE_COLLECTION(doc._id)          // collection of the current document

Wraps the ArangoDB AQL function PARSE_IDENTIFIER(documentIdentifier), which returns { collection, key }.

Example AQL usage:

PARSE_IDENTIFIER("products/123")   // returns {collection: "products", key: "123"}
PARSE_IDENTIFIER(doc._id)          // parts of the current document handle

Wraps the ArangoDB AQL function PARSE_KEY(documentIdentifier).

Example AQL usage:

PARSE_KEY("products/123")   // returns "123"
PARSE_KEY(doc._id)          // key of the current document

This helper wraps the ArangoDB AQL function TRANSLATE(value, lookupDocument, defaultValue) which performs a lookup operation. If the value is a key in the lookup document, it returns the corresponding value. If not found, it returns the default value (if specified) or the original value unchanged.

Example AQL usage:

TRANSLATE("draft", {"draft": "D", "published": "P"})           // returns "D"
TRANSLATE("unknown", {"draft": "D", "published": "P"})         // returns "unknown"
TRANSLATE("unknown", {"draft": "D", "published": "P"}, "X")    // returns "X"

Wraps the ArangoDB AQL function UNSET(document, attributeName1, … attributeNameN). The attribute names are emitted as quoted string literals (json_encode); the document stays a raw expression.

Named unsetAttributes() rather than unset() because unset is a reserved PHP keyword.

Example AQL usage:

UNSET(doc, "_id", "_rev")   // a copy of doc without its _id and _rev attributes

Wraps the ArangoDB AQL function UNSET_RECURSIVE(document, attributeName1, … attributeNameN). The attribute names are emitted as quoted string literals (json_encode); the document stays a raw expression.

Example AQL usage:

UNSET_RECURSIVE(doc, "_id", "_rev")   // strips _id/_rev at every nesting level

This helper wraps the ArangoDB AQL function VALUE(document, path) which extracts a value from a document using a path array. The path can contain strings (object keys) and integers (array indices) to navigate through nested structures.

Example AQL usage:

VALUE(doc, ["author", "name"])        // extracts doc.author.name
VALUE(doc, ["tags", 0])               // extracts first element of doc.tags array
VALUE(doc, ["metadata", "version"])   // extracts doc.metadata.version

Wraps the ArangoDB AQL function VALUES(document, removeSystemAttrs).

Example AQL usage:

VALUES({a: 1, b: 2})                  // returns [1, 2]
VALUES({a: 1, _key: "x"}, true)       // returns [1]

Wraps the ArangoDB AQL function ZIP(keys, values). PHP arrays are emitted as JSON array literals (json_encode); strings are passed through as raw AQL expressions (e.g. doc.keys).

Example AQL usage:

ZIP(["a", "b"], [1, 2])   // returns {a: 1, b: 2}