MongoDB\Driver\Cursor::isDead

(mongodb >=1.0.0)

MongoDB\Driver\Cursor::isDeadПроверяет, может ли курсор содержать дополнительные результаты

Описание

final public MongoDB\Driver\Cursor::isDead ( void ) : bool

Проверяет, есть ли у курсора дополнительные результаты для чтения. Курсор изначально «живой», но может стать «мертвым» по любой из следующих причин:

  • Продвижение курсора, не имеющего хвоста не вернуло документ
  • Курсор обнаружил ошибку
  • Курсор читает его последнюю массовую операцию до завершения
  • Курсор достиг установленного предела
Это в первую очередь полезно с помощью хвостовых курсоров.

Список параметров

У этой функции нет параметров.

Возвращаемые значения

Возвращает TRUE, если дополнительные результаты не доступны, и FALSE в противном случае.

Ошибки

Примеры

Пример #1 Пример выполнения MongoDB\Driver\Cursor::isDead()

<?php

$manager 
= new MongoDB\Driver\Manager("mongodb://localhost:27017");
$query = new MongoDB\Driver\Query([]);

$bulk = new MongoDB\Driver\BulkWrite;
$bulk->insert(['x' => 1]);
$bulk->insert(['x' => 2]);
$bulk->insert(['x' => 3]);
$manager->executeBulkWrite('db.collection'$bulk);

$cursor $manager->executeQuery('db.collection'$query);

$iterator = new IteratorIterator($cursor);

$iterator->rewind();
var_dump($cursor->isDead());

$iterator->next();
var_dump($cursor->isDead());

$iterator->next();
var_dump($cursor->isDead());

$iterator->next();
var_dump($cursor->isDead());

?>

Результат выполнения данного примера:

bool(false)
bool(false)
bool(false)
bool(true)