Oihana PHP Arango

ArangoDocumentsModel extends DocumentsModel

ArangoDB-specific documents model contract.

Extends the generic DocumentsModel with the extra operations the ArangoDB Documents model provides on top of the standard CRUD/list surface — total-rows accounting, per-value facet counts and numeric bounds — which the ArangoDB controllers rely on. Keeping them on a dedicated interface avoids polluting the generic model contract with ArangoDB/search-specific methods.

Tags
author

Marc Alcaraz (ekameleon)

since
1.6.0

Table of Contents

Methods

bounds()  : array<string|int, mixed>
Returns the numeric `{ min, max }` bounds requested alongside a list query.
facetCounts()  : array<string|int, mixed>
Returns the per-value facet counts requested alongside a list query.
foundRows()  : int
Returns the total number of rows the last list query would have returned without its `LIMIT` clause (the `fullCount` figure), for pagination.

Methods

bounds()

Returns the numeric `{ min, max }` bounds requested alongside a list query.

public bounds([array<string|int, mixed> $init = [] ]) : array<string|int, mixed>
Parameters
$init : array<string|int, mixed> = []

The init array forwarded to the model.

Return values
array<string|int, mixed>

facetCounts()

Returns the per-value facet counts requested alongside a list query.

public facetCounts([array<string|int, mixed> $init = [] ]) : array<string|int, mixed>
Parameters
$init : array<string|int, mixed> = []

The init array forwarded to the model.

Return values
array<string|int, mixed>

foundRows()

Returns the total number of rows the last list query would have returned without its `LIMIT` clause (the `fullCount` figure), for pagination.

public foundRows() : int
Return values
int
On this page

Search results