MongoCommandCursor

class MongoCommandCursor implements MongoCursorInterface (View source)

Methods

TValue
current()

Return the current element

void
next()

Move forward to next element

TKey|null
key()

Return the key of the current element

bool
valid()

Checks if current position is valid

void
rewind()

Rewind the Iterator to the first element

MongoCursorInterface
batchSize(int $batchSize)

No description

bool
dead()

No description

array
info()

No description

array
getReadPreference()

No description

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

No description

MongoCursorInterface
timeout(int $ms)

No description

Details

at line 1623
TValue current()

Since: 5.0.0

Return the current element

Return Value

TValue

Can return any type.

at line 1631
void next()

Since: 5.0.0

Move forward to next element

Return Value

void

Any returned value is ignored.

at line 1639
TKey|null key()

Since: 5.0.0

Return the key of the current element

Return Value

TKey|null

TKey on success, or null on failure.

at line 1648
bool valid()

Since: 5.0.0

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.

at line 1656
void rewind()

Since: 5.0.0

Rewind the Iterator to the first element

Return Value

void

Any returned value is ignored.

at line 1658
MongoCursorInterface batchSize(int $batchSize)

No description

Parameters

int $batchSize

Return Value

MongoCursorInterface

at line 1660
bool dead()

No description

Return Value

bool

at line 1662
array info()

No description

Return Value

array

at line 1664
array getReadPreference()

No description

Return Value

array

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

No description

Parameters

string $read_preference
array|null $tags

Return Value

MongoCursorInterface

at line 1668
MongoCursorInterface timeout(int $ms)

No description

Parameters

int $ms

Return Value

MongoCursorInterface