[PHP-DOC] cvs: phpdoc /en/reference/pdo reference.xml /en/reference/pdo/functions PDOStatement-nextRowset.xml

[Dan Scott]

dbs             Sat Apr  9 11:57:10 2005 EDT

  Added files:                 
    /phpdoc/en/reference/pdo/functions  PDOStatement-nextRowset.xml 

  Modified files:              
    /phpdoc/en/reference/pdo    reference.xml 
  Log:
  Document PDOStatement::nextRowset so I don't forget about it again
  
  
http://cvs.php.net/diff.php/phpdoc/en/reference/pdo/reference.xml?r1=1.21&r2=1.22&ty=u
Index: phpdoc/en/reference/pdo/reference.xml
diff -u phpdoc/en/reference/pdo/reference.xml:1.21 
phpdoc/en/reference/pdo/reference.xml:1.22
--- phpdoc/en/reference/pdo/reference.xml:1.21  Thu Feb 10 14:58:02 2005
+++ phpdoc/en/reference/pdo/reference.xml       Sat Apr  9 11:57:09 2005
@@ -1,5 +1,5 @@
 <?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.21 $ -->
+<!-- $Revision: 1.22 $ -->
 <!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. 
-->
  <reference id="ref.pdo">
   <title>PDO Functions</title>
@@ -380,6 +380,12 @@
        </listitem>
        <listitem>
         <para>
+         <link linkend='function.PDOStatement-nextRowset'>nextRowset</link> 
+         - retrieves the next rowset (result set)
+        </para>
+       </listitem>
+       <listitem>
+        <para>
          <link linkend='function.PDOStatement-rowCount'>rowCount</link> 
          - returns the number of rows that were affected by the execution of 
          an SQL statement

http://cvs.php.net/co.php/phpdoc/en/reference/pdo/functions/PDOStatement-nextRowset.xml?r=1.1&p=1
Index: phpdoc/en/reference/pdo/functions/PDOStatement-nextRowset.xml
+++ phpdoc/en/reference/pdo/functions/PDOStatement-nextRowset.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.PDOStatement-nextRowset">
 <refnamediv>
  <refname>PDOStatement::nextRowset</refname>
  <refpurpose>
   Advances to the next rowset in a multi-rowset statement handle
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>PDOStatement::nextRowset</methodname>
   <void/>
  </methodsynopsis>

  &warn.experimental.func;

  <para>
   Some database servers support stored procedures that return more than one
   rowset (also known as a result set).
   <function>PDOStatement::nextRowSet</function> enables you to access the
   second and subsequent rowsets associated with a PDOStatement object. Each
   rowset can have a different set of columns from the preceding rowset.
  </para>

 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Fetching multiple rowsets returned from a stored procedure</title>
    <para>
     The following example shows how to call a stored procedure,
     MULTIPLE_RESULTS, that returns three rowsets. We use a do / while loop to
     loop over the <function>PDOStatement::nextRowset</function> method, which
     returns false and terminates the loop when no more rowsets can be returned.
    </para>
    <programlisting role="php">
<![CDATA[
<?php
$sql = 'CALL multiple_rowsets()';
$stmt = $conn->query($sql);
$i = 1;
do {
    $rowset = $stmt->fetchAll(PDO_FETCH_NUM);
    if ($rowset) {
        printResultSet($rowset, $i);
    }
    $i++;
} while ($stmt->nextRowset());

function printResultSet(&$rowset, $i) {
    print "Result set $i:\n";
    foreach ($rowset as $row) {
        foreach ($row as $col) {
            print $col . "\t";
        }
        print "\n";
    }
    print "\n";
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Result set 1:
apple    red
banana   yellow

Result set 2:
orange   orange    150
banana   yellow    175

Result set 3:
lime     green
apple    red
banana   yellow
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>PDOStatement::columnCount</function></member>
    <member><function>PDOStatement::execute</function></member>
    <member><function>PDOStatement::getColumnMeta</function></member>
    <member><function>PDOStatement::query</function></member>
   </simplelist>
  </para>
 </refsect1>


</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->