unshift()

Prepend a value to the beginning of an array.

UNSHIFT([2, 4, 6], 1)           // returns [1, 2, 4, 6]
UNSHIFT([2, 4, 6], 4)           // returns [4, 2, 4, 6]
UNSHIFT([2, 4, 6], 4, true)     // returns [2, 4, 6] (4 already exists)
UNSHIFT([2, 4, 6], 1, true)     // returns [1, 2, 4, 6] (1 is new)

Parameters

$anyArray : mixed

Array expression to prepend value to.

$value : mixed

Value to prepend to the array.

$unique : bool = false

When true, value is added only if not already present.

Tags

example

use function oihana\arango\db\functions\arrays\unshift;

$expr = unshift('[2,4,6,8]', 4);
// Produces: 'UNSHIFT([2,4,6,8], 4)'

$expr = unshift('[2,4,6,8]', 4, true);
// Produces: 'UNSHIFT([2,4,6,8], 4, true)'

see

https://docs.arangodb.com/stable/aql/functions/array/#unshift

push()

For appending values to the end.

shift()

For removing elements from the beginning.

since

1.0.0

author

Marc Alcaraz