The MongoDB\Driver\CursorInterface interface

(mongodb >=1.6.0)

Introduction

This interface is implemented by MongoDB\Driver\Cursor to be used as a parameter, return, or property type in userland classes.

class MongoDB\Driver\CursorInterface implements Iterator {

/* Methods */

abstract public function getId(): MongoDB\BSON\Int64

abstract public function isDead(): bool

abstract public function setTypeMap(array $typemap): void

abstract public function toArray(): array

}

Version	Description
PECL mongodb 2.0.0	This interface now extends Iterator. Return types previously declared as tentative are now enforced.
PECL mongodb 1.15.0	Return types for methods are declared as tentative on PHP 8.0 and newer, triggering deprecation notices in code that implements this interface without declaring the appropriate return types. The `#[ReturnTypeWillChange]` attribute can be added to silence the deprecation notice.

MongoDB\Driver\CursorInterface::getId — Returns the ID for this cursor
MongoDB\Driver\CursorInterface::getServer — Returns the server associated with this cursor
MongoDB\Driver\CursorInterface::isDead — Checks if the cursor may have additional results
MongoDB\Driver\CursorInterface::setTypeMap — Sets a type map to use for BSON unserialization
MongoDB\Driver\CursorInterface::toArray — Returns an array containing all results for this cursor