Oihana PHP Arango

PrepareBoundsTrait

Prepares the list of bound fields whose numeric `{ min, max }` extent is computed alongside the document list (see {@see \oihana\arango\models\traits\documents\DocumentsBoundsTrait::bounds()}).

Driven by ?bounds=key1,key2 (CSV). Each key must be a configured bound (AQL::BOUNDS); unknown keys are ignored at the model layer.

Tags
since
1.0.0
author

Marc Alcaraz

Table of Contents

Methods

prepareBounds()  : array<string|int, mixed>|null
Resolves the bound fields for a list query.

Methods

prepareBounds()

Resolves the bound fields for a list query.

protected prepareBounds(ServerRequestInterface|null $request[, array<string|int, mixed> $args = [] ][, array<string|int, mixed>|null &$params = null ]) : array<string|int, mixed>|null
Parameters
$request : ServerRequestInterface|null

The HTTP request.

$args : array<string|int, mixed> = []

Predefined options ($args[Arango::BOUNDS] as base).

$params : array<string|int, mixed>|null = null

Echoed query params, populated by reference.

Return values
array<string|int, mixed>|null

The list of bound keys, or null when none requested.

On this page

Search results