cvs: peardoc /en/package/database/db/db-common getassoc.xml getcol.xml getone.xml getrow.xml
| From: | Daniel Convissor | Date: | Wed, 14 Apr 2004 06:06:26 +0000 |
| Subject: | cvs: peardoc /en/package/database/db/db-common getassoc.xml getcol.xml getone.xml getrow.xml | ||
| Groups: | php.pear.doc | ||
| Request: | Send a blank email to pear-doc+get-3402@lists.php.net to get a copy of this message | ||
danielc Wed Apr 14 02:06:26 2004 EDT
Modified files:
/peardoc/en/package/database/db/db-common getassoc.xml getcol.xml
getone.xml getrow.xml
Log:
Clean up returns section: use type entity, simplify text.
http://cvs.php.net/diff.php/peardoc/en/package/database/db/db-common/getassoc.xml?r1=1.20&r2=1.21&ty=u
Index: peardoc/en/package/database/db/db-common/getassoc.xml
diff -u peardoc/en/package/database/db/db-common/getassoc.xml:1.20
peardoc/en/package/database/db/db-common/getassoc.xml:1.21
--- peardoc/en/package/database/db/db-common/getassoc.xml:1.20 Tue Apr 13 18:12:59 2004
+++ peardoc/en/package/database/db/db-common/getassoc.xml Wed Apr 14 02:06:25 2004
@@ -1,4 +1,4 @@
-<!-- $Revision: 1.20 $ -->
+<!-- $Revision: 1.21 $ -->
<refentry id="package.database.db.db-common.getassoc">
<refnamediv>
@@ -131,8 +131,8 @@
<refsect1 id="package.database.db.db-common.getassoc.return">
&title.returns;
<para>
- <parameter>array</parameter> - associative array with results from the
- query.
+ &type.array; - associative array with the query results
+ or a &class.db-error; object on failure
</para>
</refsect1>
http://cvs.php.net/diff.php/peardoc/en/package/database/db/db-common/getcol.xml?r1=1.19&r2=1.20&ty=u
Index: peardoc/en/package/database/db/db-common/getcol.xml
diff -u peardoc/en/package/database/db/db-common/getcol.xml:1.19
peardoc/en/package/database/db/db-common/getcol.xml:1.20
--- peardoc/en/package/database/db/db-common/getcol.xml:1.19 Tue Apr 13 18:12:59 2004
+++ peardoc/en/package/database/db/db-common/getcol.xml Wed Apr 14 02:06:25 2004
@@ -1,4 +1,4 @@
-<!-- $Revision: 1.19 $ -->
+<!-- $Revision: 1.20 $ -->
<refentry id="package.database.db.db-common.getcol">
<refnamediv>
@@ -84,8 +84,10 @@
<refsect1 id="package.database.db.db-common.getcol.return">
&title.returns;
<para>
- <parameter>array</parameter> - the first row of results as an array
- indexed from 0 or a &class.db-error;, if fail
+ &type.array; - an ordered array containing data from a
+ result set column
+ or a &class.db-error; object on failure.
+ The array's index starts at 0.
</para>
</refsect1>
http://cvs.php.net/diff.php/peardoc/en/package/database/db/db-common/getone.xml?r1=1.19&r2=1.20&ty=u
Index: peardoc/en/package/database/db/db-common/getone.xml
diff -u peardoc/en/package/database/db/db-common/getone.xml:1.19
peardoc/en/package/database/db/db-common/getone.xml:1.20
--- peardoc/en/package/database/db/db-common/getone.xml:1.19 Tue Apr 13 18:12:59 2004
+++ peardoc/en/package/database/db/db-common/getone.xml Wed Apr 14 02:06:25 2004
@@ -1,4 +1,4 @@
-<!-- $Revision: 1.19 $ -->
+<!-- $Revision: 1.20 $ -->
<refentry id="package.database.db.db-common.getone">
<refnamediv>
@@ -68,8 +68,8 @@
<refsect1 id="package.database.db.db-common.getone.return">
&title.returns;
<para>
- <parameter>mixed</parameter> - the returned value or
- a &class.db-error;, if fail
+ &type.mixed; - the first column's data
+ or a &class.db-error; object on failure
</para>
</refsect1>
http://cvs.php.net/diff.php/peardoc/en/package/database/db/db-common/getrow.xml?r1=1.19&r2=1.20&ty=u
Index: peardoc/en/package/database/db/db-common/getrow.xml
diff -u peardoc/en/package/database/db/db-common/getrow.xml:1.19
peardoc/en/package/database/db/db-common/getrow.xml:1.20
--- peardoc/en/package/database/db/db-common/getrow.xml:1.19 Tue Apr 13 18:12:59 2004
+++ peardoc/en/package/database/db/db-common/getrow.xml Wed Apr 14 02:06:25 2004
@@ -1,4 +1,4 @@
-<!-- $Revision: 1.19 $ -->
+<!-- $Revision: 1.20 $ -->
<refentry id="package.database.db.db-common.getrow">
<refnamediv>
@@ -83,8 +83,11 @@
<refsect1 id="package.database.db.db-common.getrow.return">
&title.returns;
<para>
- <parameter>array</parameter> - the first row of results as an array
- indexed from 0 or a &class.db-error;, if fail
+ &type.array; - the first row's data in an array
+ or a &class.db-error; object on failure.
+ The array may be ordered or associative depending on
+ <parameter>$fetchmode</parameter>.
+ The column index starts at 0 for orderd arrays.
</para>
</refsect1>