Base
in package
implements
CursorInterface, Countable
AbstractYes
Base class for Cursors
Tags
Table of Contents
Interfaces
- CursorInterface
- Common interface for Cursors
- Countable
Constants
- BASE_URL = 'baseurl'
- Cursor baseUrl entry
- CACHE = 'cache'
- Cursor cache entry
- CACHED = 'cached'
- Cursor cached entry
- COUNT = 'count'
- Cursor count entry
- EXTRA = 'extra'
- Cursor extra entry
- FULL_COUNT = 'fullCount'
- Cursor fullCount entry
- HAS_MORE = 'hasMore'
- 'hasMore' flag
- ID = 'id'
- Cursor ID entry
- RESULT = 'result'
- Cursor result entry
- SANITIZE = '_sanitize'
- Cursor sanitize option
- STATS = 'stats'
- Cursor stats entry
- TYPE = 'objectType'
- Cursor type entry
Properties
- $cached : bool
- If the result query was served from cached results
- $connection : Connection
- Connection object
- $count : int
- Number of documents in cursor,
- $data : ArrayList
- Result data
- $extra : array<string|int, mixed>
- Extra data (stats)
- $fetches : int
- Number of HTTP calls made to build the cursor
- $fullCount : int
- Full cont of the result set
- $hasMore : bool
- 'hasMore' indicator
- $id : mixed
- Cursor id
- $length : int
- Total length of current set
- $options : array<string|int, mixed>
- Cursor Options
- $position : int
- Current position
- $result : ArrayList
- Result set
Methods
- getId() : mixed
- Returns the cursor ID
- isCached() : bool
- Return if the Cursor has cached results on server
- fetch() : void
- Fetch more results from the server
Constants
BASE_URL
Cursor baseUrl entry
protected
mixed
BASE_URL
= 'baseurl'
CACHE
Cursor cache entry
protected
mixed
CACHE
= 'cache'
CACHED
Cursor cached entry
protected
mixed
CACHED
= 'cached'
COUNT
Cursor count entry
protected
mixed
COUNT
= 'count'
EXTRA
Cursor extra entry
protected
mixed
EXTRA
= 'extra'
FULL_COUNT
Cursor fullCount entry
protected
mixed
FULL_COUNT
= 'fullCount'
HAS_MORE
'hasMore' flag
protected
mixed
HAS_MORE
= 'hasMore'
ID
Cursor ID entry
protected
mixed
ID
= 'id'
RESULT
Cursor result entry
protected
mixed
RESULT
= 'result'
SANITIZE
Cursor sanitize option
protected
mixed
SANITIZE
= '_sanitize'
STATS
Cursor stats entry
protected
mixed
STATS
= 'stats'
TYPE
Cursor type entry
protected
mixed
TYPE
= 'objectType'
Properties
$cached
If the result query was served from cached results
protected
bool
$cached
= false
$connection
Connection object
protected
Connection
$connection
$count
Number of documents in cursor,
protected
int
$count
$data
Result data
protected
ArrayList
$data
$extra
Extra data (stats)
protected
array<string|int, mixed>
$extra
$fetches
Number of HTTP calls made to build the cursor
protected
int
$fetches
= 0
$fullCount
Full cont of the result set
protected
int
$fullCount
$hasMore
'hasMore' indicator
protected
bool
$hasMore
$id
Cursor id
protected
mixed
$id
$length
Total length of current set
protected
int
$length
$options
Cursor Options
protected
array<string|int, mixed>
$options
$position
Current position
protected
int
$position
= 0
$result
Result set
protected
ArrayList
$result
Methods
getId()
Returns the cursor ID
public
getId() : mixed
isCached()
Return if the Cursor has cached results on server
public
isCached() : bool
Return values
boolfetch()
Fetch more results from the server
protected
abstract fetch() : void