From 72747a6aca3c702351540d920a7695c3dbf9d56b Mon Sep 17 00:00:00 2001
From: Esen Sagynov <cubrid@php.net>
Date: Fri, 19 Nov 2010 03:08:54 +0000
Subject: [PATCH] Add a new function cubrid_fetch_array

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@305544 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../cubrid/functions/cubrid-fetch-array.xml   | 111 ++++++++++++++++++
 reference/cubrid/versions.xml                 |   1 +
 2 files changed, 112 insertions(+)
 create mode 100644 reference/cubrid/functions/cubrid-fetch-array.xml

diff --git a/reference/cubrid/functions/cubrid-fetch-array.xml b/reference/cubrid/functions/cubrid-fetch-array.xml
new file mode 100644
index 0000000000..879bad6587
--- /dev/null
+++ b/reference/cubrid/functions/cubrid-fetch-array.xml
@@ -0,0 +1,111 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 303158 $ -->
+
+<refentry xml:id="function.cubrid-fetch" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>cubrid_fetch_array</refname>
+  <refpurpose>Fetch a result row as an associative array, a numeric array, or both</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>array</type><methodname>cubrid_fetch_array</methodname>
+   <methodparam><type>resource</type><parameter>req_identifier</parameter></methodparam>  
+   <methodparam choice="opt"><type>int</type><parameter>type = CUBRID_BOTH</parameter></methodparam>  
+  </methodsynopsis>
+  <para>
+    The <function>cubrid_fetch_array</function> function is used to get a
+    single row from the query result and returns an array. The cursor
+    automatically moves to the next row after getting the result.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+  <variablelist>
+   <varlistentry>
+    <term><parameter>req_identifier</parameter></term>
+    <listitem><para>Request identifier.</para></listitem>
+   </varlistentry>
+   <varlistentry>
+    <term><parameter>type</parameter></term>
+    <listitem><para>Array type of the fetched result CUBRID_NUM, CUBRID_ASSOC, CUBRID_BOTH.</para></listitem>
+   </varlistentry>
+  </variablelist>
+  </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>Returns an array of strings that corresponds to the fetched row, when process is successful.</para>
+  <para>&false;, when process is unsuccessful.</para>
+  <para>The type of returned array depends on how type is defined. By using CUBRID_BOTH (default), you'll get an array with both associative and number indices, and you can decide which data type to use by setting the <parameter>type</parameter> argument. The <parameter>type</parameter> variable can be set to one of the following values:</para>
+    <simplelist>
+        <member>CUBRID_NUM : Numerical array (0-based)</member>
+        <member>CUBRID_ASSOC : Associative array</member>
+        <member>CUBRID_BOTH : Numerical &amp; Associative array (default)</member>
+    </simplelist>  
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <example>
+   <title><function>cubrid_fetch_array</function> example</title>
+   <programlisting role="php">
+<![CDATA[
+<?php
+$req = cubrid_execute($con, "select * from members", CUBRID_INCLUDE_OID | CUBRID_ASYNC);
+if ($req) {
+   while (list($id, $name) = cubrid_fetch_array($req)){
+      echo $id;
+      echo $name;
+   }
+   cubrid_close_request($req);
+}
+
+$req = cubrid_execute($con, "select * from teams");
+if ($req) {
+   while($row = cubrid_fetch_array($req, CUBRID_ASSOC)) {
+      echo $row["id"];
+      echo $row["name"];
+   }
+}
+?>
+]]>
+   </programlisting>
+  </example>
+ </refsect1>
+
+    <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+   <member><function>cubrid_execute</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:"~/.phpdoc/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
+-->
diff --git a/reference/cubrid/versions.xml b/reference/cubrid/versions.xml
index 6c6e5f412c..9e51a206cd 100644
--- a/reference/cubrid/versions.xml
+++ b/reference/cubrid/versions.xml
@@ -29,6 +29,7 @@
  <function name='cubrid_error_msg' from='PECL CUBRID >= 8.3.0'/>
  <function name='cubrid_execute' from='PECL CUBRID >= 8.3.0'/>
  <function name='cubrid_fetch' from='PECL CUBRID >= 8.3.0'/>
+ <function name='cubrid_fetch_array' from='PECL CUBRID >=8.3.0'/>
  <function name='cubrid_fetch_assoc' from='PECL CUBRID >= 8.3.0'/>
  <function name='cubrid_fetch_field' from='PECL CUBRID >= 8.3.0'/>
  <function name='cubrid_fetch_lengths' from='PECL CUBRID >= 8.3.0'/>