Oihana PHP Arango

randomToken.php

Table of Contents

Functions

randomToken()  : string
Generate a pseudo-random token string with the specified length.

Functions

randomToken()

Generate a pseudo-random token string with the specified length.

randomToken(int $length) : string

This helper wraps the ArangoDB AQL function RANDOM_TOKEN(length) which generates a pseudo-random token string. The algorithm for token generation should be treated as opaque. The length must be between 0 and 65536.

Example AQL usage:

RANDOM_TOKEN(8)               // returns a random 8-character string
RANDOM_TOKEN(16)              // returns a random 16-character string
RANDOM_TOKEN(0)               // returns "" (empty string)
RANDOM_TOKEN(32)              // returns a random 32-character string
Parameters
$length : int

Desired string length for the token (0-65536).

Tags
example
use function oihana\arango\db\functions\strings\randomToken;

$expr = randomToken(16);
// Produces: 'RANDOM_TOKEN(16)'
see
https://docs.arangodb.com/stable/aql/functions/string/#random_token
uuid()

For generating UUIDs.

since
1.0.0
author

Marc Alcaraz

Return values
string

The formatted AQL expression.

On this page

Search results