[prev in list] [next in list] [prev in thread] [next in thread] 

List:       php-doc-cvs
Subject:    [DOC-CVS] =?utf-8?q?svn:_/phpdoc/en/trunk/reference/mongo/_mongocursor/getnext.xml_mongocursor/hasne
From:       Kristina_Chodorow <kristina () php ! net>
Date:       2010-03-30 20:05:30
Message-ID: svn-kristina-1269979530-297199-1669668817 () svn ! php ! net
[Download RAW message or body]

kristina                                 Tue, 30 Mar 2010 20:05:30 +0000

Revision: http://svn.php.net/viewvc?view=revision&revision=297199

Log:
timeout exceptions, equivalences

Changed paths:
    U   phpdoc/en/trunk/reference/mongo/mongocursor/getnext.xml
    U   phpdoc/en/trunk/reference/mongo/mongocursor/hasnext.xml
    U   phpdoc/en/trunk/reference/mongo/mongocursor/next.xml
    U   phpdoc/en/trunk/reference/mongo/mongocursor/rewind.xml
    U   phpdoc/en/trunk/reference/mongo/mongocursor.xml

Modified: phpdoc/en/trunk/reference/mongo/mongocursor/getnext.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/mongocursor/getnext.xml	2010-03-30 19:49:19 UTC (rev 297198)
+++ phpdoc/en/trunk/reference/mongo/mongocursor/getnext.xml	2010-03-30 20:05:30 UTC (rev 297199)
@@ -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>

Modified: phpdoc/en/trunk/reference/mongo/mongocursor/hasnext.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/mongocursor/hasnext.xml	2010-03-30 19:49:19 UTC (rev 297198)
+++ phpdoc/en/trunk/reference/mongo/mongocursor/hasnext.xml	2010-03-30 20:05:30 UTC (rev 297199)
@@ -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>

Modified: phpdoc/en/trunk/reference/mongo/mongocursor/next.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/mongocursor/next.xml	2010-03-30 19:49:19 UTC (rev 297198)
+++ phpdoc/en/trunk/reference/mongo/mongocursor/next.xml	2010-03-30 20:05:30 UTC (rev 297199)
@@ -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>

Modified: phpdoc/en/trunk/reference/mongo/mongocursor/rewind.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/mongocursor/rewind.xml	2010-03-30 19:49:19 UTC (rev 297198)
+++ phpdoc/en/trunk/reference/mongo/mongocursor/rewind.xml	2010-03-30 20:05:30 UTC (rev 297199)
@@ -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:

Modified: phpdoc/en/trunk/reference/mongo/mongocursor.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/mongocursor.xml	2010-03-30 19:49:19 UTC (rev 297198)
+++ phpdoc/en/trunk/reference/mongo/mongocursor.xml	2010-03-30 20:05:30 UTC (rev 297199)
@@ -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



-- 
PHP Documentation Commits Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php

[prev in list] [next in list] [prev in thread] [next in thread]