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 batchSize(int $batchSize): MongoCursorInterface
abstract public dead(): bool
abstract public getReadPreference(): array
abstract public info(): array
abstract public setReadPreference(string $read_preference, array $tags = ?): MongoCursorInterface
abstract public timeout(int $ms): MongoCursorInterface
/* Inherited methods */
abstract public Iterator::current(): mixed
abstract public Iterator::key(): mixed
abstract public Iterator::next(): void
abstract public Iterator::rewind(): void
abstract public Iterator::valid(): bool
}

Table of Contents