The MongoCursorInterface interface

(PECL mongo >=1.5.0)

Introduction

Interface for cursors, which can be used to iterate through results of a database query or command. This interface is implemented by the MongoCursor and MongoCommandCursor classes.

Note: Similar to Traversable, this interface cannot be implemented in PHP scripts.

Class synopsis

MongoCursorInterface extends Iterator {

/* Methods */

abstract public MongoCursorInterface batchSize ( int $batchSize )

abstract public bool dead ( void )

abstract public array getReadPreference ( void )

abstract public array info ( void )

abstract public MongoCursorInterface setReadPreference ( string $read_preference [, array $tags ] )

abstract public MongoCursorInterface timeout ( int $ms )

/* Inherited methods */

abstract public mixed Iterator::current ( void )

abstract public scalar Iterator::key ( void )

abstract public void Iterator::next ( void )

abstract public void Iterator::rewind ( void )

abstract public boolean Iterator::valid ( void )

}

MongoCursorInterface::batchSize — Limits the number of elements returned in one batch.
MongoCursorInterface::dead — Checks if there are results that have not yet been sent from the database
MongoCursorInterface::getReadPreference — Get the read preference for this query
MongoCursorInterface::info — Gets information about the cursor's creation and iteration
MongoCursorInterface::setReadPreference — Set the read preference for this query
MongoCursorInterface::timeout — Sets a client-side timeout for this query

User Contributed Notes

There are no user contributed notes for this page.

The MongoCursorInterface interface

Introduction

Class synopsis

Table of Contents

User Contributed Notes