Oihana PHP Arango

checkDocument.php

Table of Contents

Functions

checkDocument()  : string
Returns true if document is a valid document object, i.e. a document without any duplicate attribute names.

Functions

checkDocument()

Returns true if document is a valid document object, i.e. a document without any duplicate attribute names.

checkDocument(mixed $document) : string

Will return false for any non-objects/non-documents or documents with duplicate attribute names.

This helper wraps the ArangoDB AQL function CHECK_DOCUMENT().

Example AQL output:

CHECK_DOCUMENT(doc)
Parameters
$document : mixed
Tags
example
use function oihana\arango\db\functions\firstDocument;

$expr = checkDocument('doc');
// Produces: 'CHECK_DOCUMENT(doc)'
see
https://docs.arangodb.com/stable/aql/functions/miscellaneous/#check_document
since
1.0.0

author Marc Alcaraz

Return values
string

The formatted AQL expression (e.g. 'CHECK_DOCUMENT(doc)').

On this page

Search results