The MongoDB\Driver\CursorInterface interface

- « MongoDB\Driver\CursorId::unserialize

- MongoDB\Driver\CursorInterface::getId »

- PHP Manual
- MongoDB\Driver
- The MongoDB\Driver\CursorInterface interface

# 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 synopsis

class MongoDB\Driver\CursorInterface implements Traversable {
/* Methods */
abstract public getId(): MongoDB\Driver\CursorId|MongoDB\BSON\Int64
abstract public getServer(): MongoDB\Driver\Server
abstract public isDead(): bool
abstract public setTypeMap(array `$typemap`): void
abstract public toArray(): array
}

## Changelog

Version | Description
--- | ---
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.

## Table of Contents

- 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