class LoopResult implements Iterator, JsonSerializable

Properties

$resultsCollection

Methods

__construct($resultsCollection)

No description

setCountable( boolean $countable = true)

No description

setTimestamped( boolean $timestamped = true)

No description

setVersioned( boolean $versioned = true)

No description

isEmpty()

No description

addRow( LoopResultRow $row)

No description

getCount()

No description

getResultDataCollectionCount()

No description

getResultDataCollection()

No description

current()

(PHP 5 >= 5.0.0)
Return the current element

void
next()

(PHP 5 >= 5.0.0)
Move forward to next element

mixed
key()

(PHP 5 >= 5.0.0)
Return the key of the current element

boolean
valid()

(PHP 5 >= 5.0.0)
Checks if current position is valid

void
rewind()

(PHP 5 >= 5.0.0)
Rewind the Iterator to the first element

jsonSerialize()

No description

Details

at line 29
__construct($resultsCollection)

Parameters

$resultsCollection

at line 38
setCountable( boolean $countable = true)

Parameters

boolean $countable

at line 46
setTimestamped( boolean $timestamped = true)

Parameters

boolean $timestamped

at line 54
setVersioned( boolean $versioned = true)

Parameters

boolean $versioned

at line 59
isEmpty()

at line 64
addRow( LoopResultRow $row)

Parameters

LoopResultRow $row

at line 84
getCount()

at line 89
getResultDataCollectionCount()

at line 100
getResultDataCollection()

at line 111
LoopResultRow current()

(PHP 5 >= 5.0.0)
Return the current element

Return Value

LoopResultRow

at line 122
void next()

(PHP 5 >= 5.0.0)
Move forward to next element

Return Value

void Any returned value is ignored.

at line 133
mixed key()

(PHP 5 >= 5.0.0)
Return the key of the current element

Return Value

mixed scalar on success, or null on failure.

at line 145
boolean valid()

(PHP 5 >= 5.0.0)
Checks if current position is valid

Return Value

boolean The return value will be casted to boolean and then evaluated. Returns true on success or false on failure.

at line 156
void rewind()

(PHP 5 >= 5.0.0)
Rewind the Iterator to the first element

Return Value

void Any returned value is ignored.

at line 181
jsonSerialize()