From f96b346ba564453a7343706bde5b5817d3d83a6c Mon Sep 17 00:00:00 2001
From: Kristina Chodorow <kristina@php.net>
Date: Tue, 30 Mar 2010 20:05:30 +0000
Subject: [PATCH] timeout exceptions, equivalences

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297199 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/mongo/mongocursor.xml         |  1 +
 reference/mongo/mongocursor/getnext.xml | 19 ++++++++++++++++---
 reference/mongo/mongocursor/hasnext.xml |  4 +++-
 reference/mongo/mongocursor/next.xml    |  6 ++++--
 reference/mongo/mongocursor/rewind.xml  | 24 ++++++++++++++++++++++++
 5 files changed, 48 insertions(+), 6 deletions(-)

diff --git a/reference/mongo/mongocursor.xml b/reference/mongo/mongocursor.xml
index 0641314fc6..498efaa90f 100644
--- a/reference/mongo/mongocursor.xml
+++ b/reference/mongo/mongocursor.xml
@@ -36,6 +36,7 @@
     <programlisting role="php">
 <![CDATA[
 <?php
+
 $cursor = $collection->find()->limit(10);
 
 // database has not yet been queried, so more search options can be added
diff --git a/reference/mongo/mongocursor/getnext.xml b/reference/mongo/mongocursor/getnext.xml
index d8740e8754..4bdedcbb49 100644
--- a/reference/mongo/mongocursor/getnext.xml
+++ b/reference/mongo/mongocursor/getnext.xml
@@ -14,9 +14,20 @@
    <void/>
   </methodsynopsis>
   <para>
-   This equivalent to calling <function>MongoCursor::next</function>, then
-   <function>MongoCursor::current</function>.
+   This is identical to the function:
   </para>
+  <programlisting role="php">
+<![CDATA[
+<?php
+
+public function getNext() {
+    $this->next();
+    return $this->current();
+}
+
+?>
+]]>
+  </programlisting>
  </refsect1>
 
  <refsect1 role="parameters">
@@ -34,7 +45,9 @@
  <refsect1 role="errors">
   &reftitle.errors;
   <para>
-   Throws <classname>MongoConnectionException</classname> if it cannot reach the database.
+   Throws <classname>MongoConnectionException</classname> if it cannot reach 
+   the database and <classname>MongoCursorTimeoutException</classname> if the
+   timeout is exceeded.
   </para>
  </refsect1>
 </refentry>
diff --git a/reference/mongo/mongocursor/hasnext.xml b/reference/mongo/mongocursor/hasnext.xml
index 8a4a30cc43..285d8ed1dc 100644
--- a/reference/mongo/mongocursor/hasnext.xml
+++ b/reference/mongo/mongocursor/hasnext.xml
@@ -30,7 +30,9 @@
  <refsect1 role="errors">
   &reftitle.errors;
   <para>
-   Throws <classname>MongoConnectionException</classname> if it cannot reach the database.
+   Throws <classname>MongoConnectionException</classname> if it cannot reach 
+   the database and <classname>MongoCursorTimeoutException</classname> if the
+   timeout is exceeded.
   </para>
  </refsect1>
 </refentry>
diff --git a/reference/mongo/mongocursor/next.xml b/reference/mongo/mongocursor/next.xml
index 3d9d24f13c..805e364bb1 100644
--- a/reference/mongo/mongocursor/next.xml
+++ b/reference/mongo/mongocursor/next.xml
@@ -26,11 +26,13 @@
    &null;.
   </para>
  </refsect1>
+
  <refsect1 role="errors">
   &reftitle.errors;
   <para>
-   Throws <classname>MongoConnectionException</classname> if it cannot reach the 
-   database.
+   Throws <classname>MongoConnectionException</classname> if it cannot reach the
+   database and <classname>MongoCursorTimeoutException</classname> if the
+   timeout is exceeded.
   </para>
  </refsect1>
 </refentry>
diff --git a/reference/mongo/mongocursor/rewind.xml b/reference/mongo/mongocursor/rewind.xml
index ff0fc49b2f..011e3e0cb0 100644
--- a/reference/mongo/mongocursor/rewind.xml
+++ b/reference/mongo/mongocursor/rewind.xml
@@ -13,6 +13,21 @@
    <modifier>public</modifier> <type>void</type><methodname>MongoCursor::rewind</methodname>
    <void/>
   </methodsynopsis>
+  <para>
+   This is identical to the function:
+  </para>
+  <programlisting role="php">
+<![CDATA[
+<?php
+
+public function rewind() {
+    $this->reset();
+    $this->next();
+}
+
+?>
+]]>
+  </programlisting>
  </refsect1>
 
  <refsect1 role="parameters">
@@ -26,6 +41,15 @@
    &null;.
   </para>
  </refsect1>
+
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   Throws <classname>MongoConnectionException</classname> if it cannot reach the
+   database and <classname>MongoCursorTimeoutException</classname> if the
+   timeout is exceeded.
+  </para>
+ </refsect1>
 </refentry>
 <!-- Keep this comment at the end of the file
 Local variables: