MongoCursorInterface

interface MongoCursorInterface implements Iterator (View source)

Methods

mixed
current()

Return the current element

from  Iterator
void
next()

Move forward to next element

from  Iterator
mixed
key()

Return the key of the current element

from  Iterator
bool
valid()

Checks if current position is valid

from  Iterator
void
rewind()

Rewind the Iterator to the first element

from  Iterator
MongoCursorInterface
batchSize(int $batchSize)

No description

bool
dead()

No description

array
info()

No description

array
getReadPreference()

No description

MongoCursorInterface
setReadPreference(string $read_preference, array $tags = null)

No description

MongoCursorInterface
timeout(int $ms)

No description

Details

in Iterator at line 69
mixed current()

Return the current element

Return Value

mixed

Can return any type.

in Iterator at line 77
void next()

Move forward to next element

Return Value

void

Any returned value is ignored.

in Iterator at line 85
mixed key()

Return the key of the current element

Return Value

mixed

TKey on success, or null on failure.

in Iterator at line 94
bool valid()

Checks if current position is valid

Return Value

bool

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

in Iterator at line 102
void rewind()

Rewind the Iterator to the first element

Return Value

void

Any returned value is ignored.

at line 1673
MongoCursorInterface batchSize(int $batchSize)

No description

Parameters

int $batchSize

Return Value

MongoCursorInterface

at line 1675
bool dead()

No description

Return Value

bool

at line 1677
array info()

No description

Return Value

array

at line 1679
array getReadPreference()

No description

Return Value

array

at line 1681
MongoCursorInterface setReadPreference(string $read_preference, array $tags = null)

No description

Parameters

string $read_preference
array $tags

Return Value

MongoCursorInterface

at line 1683
MongoCursorInterface timeout(int $ms)

No description

Parameters

int $ms

Return Value

MongoCursorInterface