Oihana PHP Arango

isString.php

Table of Contents

Functions

isString()  : string
Builds an AQL expression that checks whether a value is a string.

Functions

isString()

Builds an AQL expression that checks whether a value is a string.

isString(string $value) : string

This helper wraps the ArangoDB AQL function IS_STRING(), which returns true if the provided value is a string, and false otherwise.

Example AQL output:

IS_STRING(doc.title)
Parameters
$value : string

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

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

$expr = isString('doc.title');
// Produces: 'IS_STRING(doc.title)'
see
https://docs.arangodb.com/stable/aql/functions/type-check-and-cast/#is_string
since
1.0.0

author Marc Alcaraz

Return values
string

The formatted AQL expression (e.g., 'IS_STRING(doc.title)').

On this page

Search results