Oihana PHP Arango

isObject.php

Table of Contents

Functions

isObject()  : string
Builds an AQL expression that checks whether a value is an object/document.

Functions

isObject()

Builds an AQL expression that checks whether a value is an object/document.

isObject(string $value) : string

This helper wraps the ArangoDB AQL function IS_OBJECT(), which returns true if the provided value is an object (e.g., a document in AQL), and false otherwise.

Example AQL output:

IS_OBJECT(doc.user)
Parameters
$value : string

The AQL field or expression to check (e.g., 'doc.user').

Tags
example 
use function oihana\arango\db\functions\isObject;

$expr = isObject('doc.user');
// Produces: 'IS_OBJECT(doc.user)'
see
https://docs.arangodb.com/stable/aql/functions/type-check-and-cast/#is_object
since
1.0.0

author Marc Alcaraz

Return values
string —

The formatted AQL expression (e.g., 'IS_OBJECT(doc.user)').

On this page

Search results