cvs: peardoc /en/package/database/db/db-common getall.xml getassoc.xml getcol.xml getone.xml getrow.xml

From: Date: Mon, 26 Jan 2004 23:59:22 +0000
Subject: cvs: peardoc /en/package/database/db/db-common getall.xml getassoc.xml getcol.xml getone.xml getrow.xml
Groups: php.pear.doc 
Request: Send a blank email to pear-doc+get-2186@lists.php.net to get a copy of this message
danielc Mon Jan 26 18:59:22 2004 EDT Modified files: /peardoc/en/package/database/db/db-common getall.xml getassoc.xml getcol.xml getone.xml getrow.xml Log: Clarify $params/prepare/excute mode.

http://cvs.php.net/diff.php/peardoc/en/package/database/db/db-common/getall.xml?r1=1.8&r2=1.9&ty=u Index: peardoc/en/package/database/db/db-common/getall.xml diff -u peardoc/en/package/database/db/db-common/getall.xml:1.8 peardoc/en/package/database/db/db-common/getall.xml:1.9 --- peardoc/en/package/database/db/db-common/getall.xml:1.8 Mon Jan 26 17:08:33 2004 +++ peardoc/en/package/database/db/db-common/getall.xml Mon Jan 26 18:59:22 2004 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <refentry id="package.database.db.db-common.getall"> <refnamediv> <refname>DB_Common::getAll()</refname> @@ -6,16 +6,13 @@ </refnamediv> <refsynopsisdiv> <funcsynopsis> - <funcsynopsisinfo> - require_once 'DB.php'; - </funcsynopsisinfo> <funcprototype> <funcdef>array <function>&amp;getAll</function></funcdef> <paramdef> string <parameter>$query</parameter> </paramdef> <paramdef> - array <parameter><optional>$params = array()</optional></parameter> + mixed <parameter><optional>$params</optional></parameter> </paramdef> <paramdef> integer <parameter><optional>$fetchmode = @@ -42,23 +39,25 @@ </term> <listitem> <para> - the SQL query + the SQL query or the statement to prepare </para> </listitem> </varlistentry> <varlistentry> <term> - &type.array; + &type.mixed; <parameter>$params</parameter> </term> <listitem> <para> - if supplied, + array, string or numeric data to be added to the prepared statement. + Quantity of items passed must match quantity of placeholders in the + prepared statement: meaning 1 placeholder for non-array + parameters or 1 placeholder per array element. + If if supplied, <link linkend="package.database.db.intro-execute"> <function>prepare</function>/ - <function>execute</function></link> will - be used with this array as - execute parameters + <function>execute</function></link> is used. </para> </listitem> </varlistentry> @@ -116,23 +115,24 @@ <entry> See the <link linkend="package.database.db.db-common.prepare"> <function>prepare</function> documentation</link>, - if you want to use a SQL statemt using wildcards. + if you want to use a SQL statemt using placeholders. </entry> </row> <row> <entry><constant>DB_ERROR_NEED_MORE_DATA</constant></entry> <entry> - &null; + &null; </entry> <entry> - To less data for filling the prepared SQL statment. + Quantity of parameters didn't match quantity of placeholders in + the prepared statment. </entry> <entry> - Check the number of wild cards given in the SQL statment + Check that the number of placeholders in the <link linkend="package.database.db.db-common.prepare"> - <function>prepare</function></link>. Check the count of - entries in the array for <parameter>$params</parameter>. The count - of entries have to be equal to the number of wild cards. + <function>prepare</function></link> statement passed to + <parameter>$query</parameter> equals the count of entries + passed to <parameter>$params</parameter>. </entry> </row> <row> http://cvs.php.net/diff.php/peardoc/en/package/database/db/db-common/getassoc.xml?r1=1.9&r2=1.10&ty=u Index: peardoc/en/package/database/db/db-common/getassoc.xml diff -u peardoc/en/package/database/db/db-common/getassoc.xml:1.9 peardoc/en/package/database/db/db-common/getassoc.xml:1.10 --- peardoc/en/package/database/db/db-common/getassoc.xml:1.9 Mon Jan 26 17:30:53 2004 +++ peardoc/en/package/database/db/db-common/getassoc.xml Mon Jan 26 18:59:22 2004 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.9 $ --> +<!-- $Revision: 1.10 $ --> <refentry id="package.database.db.db-common.getassoc"> <refnamediv> <refname>DB_Common::getAssoc()</refname> @@ -6,9 +6,6 @@ </refnamediv> <refsynopsisdiv> <funcsynopsis> - <funcsynopsisinfo> - require_once 'DB.php'; - </funcsynopsisinfo> <funcprototype> <funcdef>array <function>&amp;getAssoc</function></funcdef> <paramdef> @@ -19,8 +16,7 @@ <optional>$force_array = &false;</optional></parameter> </paramdef> <paramdef> - array <parameter> - <optional>$params = array()</optional></parameter> + mixed <parameter><optional>$params</optional></parameter> </paramdef> <paramdef>integer <parameter><optional>$fetchmode = @@ -59,7 +55,7 @@ </term> <listitem> <para> - the SQL query + the SQL query or the statement to prepare </para> </listitem> </varlistentry> @@ -79,17 +75,19 @@ </varlistentry> <varlistentry> <term> - &type.array; - <parameter>array $params</parameter> + &type.mixed; + <parameter>$params</parameter> </term> <listitem> <para> - if supplied, + array, string or numeric data to be added to the prepared statement. + Quantity of items passed must match quantity of placeholders in the + prepared statement: meaning 1 placeholder for non-array + parameters or 1 placeholder per array element. + If if supplied, <link linkend="package.database.db.intro-execute"> <function>prepare</function>/ - <function>execute</function></link> will - be used with this array as - execute parameters + <function>execute</function></link> is used. </para> </listitem> </varlistentry> @@ -157,7 +155,7 @@ <entry> See the <link linkend="package.database.db.db-common.prepare"> <function>prepare</function> documentation</link>, - if you want to use a SQL statemt using wildcards. + if you want to use a SQL statemt using placeholders. </entry> </row> <row> @@ -166,14 +164,15 @@ &null; </entry> <entry> - To less data for filling the prepared SQL statment. + Quantity of parameters didn't match quantity of placeholders in + the prepared statment. </entry> <entry> - Check the number of wild cards given in the SQL statment + Check that the number of placeholders in the <link linkend="package.database.db.db-common.prepare"> - <function>prepare</function></link>. Check the count of - entries in the array for <parameter>$params</parameter>. The count - of entries have to be equal to the number of wild cards. + <function>prepare</function></link> statement passed to + <parameter>$query</parameter> equals the count of entries + passed to <parameter>$params</parameter>. </entry> </row> <row> http://cvs.php.net/diff.php/peardoc/en/package/database/db/db-common/getcol.xml?r1=1.8&r2=1.9&ty=u Index: peardoc/en/package/database/db/db-common/getcol.xml diff -u peardoc/en/package/database/db/db-common/getcol.xml:1.8 peardoc/en/package/database/db/db-common/getcol.xml:1.9 --- peardoc/en/package/database/db/db-common/getcol.xml:1.8 Mon Jan 26 17:08:33 2004 +++ peardoc/en/package/database/db/db-common/getcol.xml Mon Jan 26 18:59:22 2004 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <refentry id="package.database.db.db-common.getcol"> <refnamediv> <refname>DB_Common::getCol()</refname> @@ -6,9 +6,6 @@ </refnamediv> <refsynopsisdiv> <funcsynopsis> - <funcsynopsisinfo> - require_once 'DB.php'; - </funcsynopsisinfo> <funcprototype> <funcdef>array <function>&amp;getCol</function></funcdef> <paramdef> @@ -18,7 +15,7 @@ mixed <parameter><optional>$col = 0</optional></parameter> </paramdef> <paramdef> - array <parameter><optional>$params = array()</optional></parameter> + mixed <parameter><optional>$params</optional></parameter> </paramdef> </funcprototype> </funcsynopsis> @@ -41,7 +38,7 @@ </term> <listitem> <para> - the SQL query + the SQL query or the statement to prepare </para> </listitem> </varlistentry> @@ -57,22 +54,24 @@ </para> </listitem> </varlistentry> - <varlistentry> - <term> - &type.array; - <parameter>$params</parameter> - </term> - <listitem> - <para> - if supplied, - <link linkend="package.database.db.intro-execute"> + <varlistentry> + <term> + &type.mixed; + <parameter>$params</parameter> + </term> + <listitem> + <para> + array, string or numeric data to be added to the prepared statement. + Quantity of items passed must match quantity of placeholders in the + prepared statement: meaning 1 placeholder for non-array + parameters or 1 placeholder per array element. + If if supplied, + <link linkend="package.database.db.intro-execute"> <function>prepare</function>/ - <function>execute</function></link> will - be used with this array as - execute parameters - </para> - </listitem> - </varlistentry> + <function>execute</function></link> is used. + </para> + </listitem> + </varlistentry> </variablelist> </para> </refsect1> @@ -109,23 +108,24 @@ <entry> See the <link linkend="package.database.db.db-common.prepare"> <function>prepare</function> documentation</link>, - if you want to use a SQL statemt using wildcards. + if you want to use a SQL statemt using placeholders. </entry> </row> <row> <entry><constant>DB_ERROR_NEED_MORE_DATA</constant></entry> <entry> - &null; + &null; </entry> <entry> - To less data for filling the prepared SQL statment. + Quantity of parameters didn't match quantity of placeholders in + the prepared statment. </entry> <entry> - Check the number of wild cards given in the SQL statment + Check that the number of placeholders in the <link linkend="package.database.db.db-common.prepare"> - <function>prepare</function></link>. Check the count of - entries in the array for <parameter>$params</parameter>. The count - of entries have to be equal to the number of wild cards. + <function>prepare</function></link> statement passed to + <parameter>$query</parameter> equals the count of entries + passed to <parameter>$params</parameter>. </entry> </row> <row> http://cvs.php.net/diff.php/peardoc/en/package/database/db/db-common/getone.xml?r1=1.8&r2=1.9&ty=u Index: peardoc/en/package/database/db/db-common/getone.xml diff -u peardoc/en/package/database/db/db-common/getone.xml:1.8 peardoc/en/package/database/db/db-common/getone.xml:1.9 --- peardoc/en/package/database/db/db-common/getone.xml:1.8 Mon Jan 26 17:30:53 2004 +++ peardoc/en/package/database/db/db-common/getone.xml Mon Jan 26 18:59:22 2004 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <refentry id="package.database.db.db-common.getone"> <refnamediv> <refname>DB_Common::getOne()</refname> @@ -6,14 +6,11 @@ </refnamediv> <refsynopsisdiv> <funcsynopsis> - <funcsynopsisinfo> - require_once 'DB.php'; - </funcsynopsisinfo> <funcprototype> <funcdef>mixed <function>&amp;getOne</function></funcdef> <paramdef>string <parameter>$query</parameter></paramdef> - <paramdef>array - <parameter><optional>$params = array</optional></parameter> + <paramdef> + mixed <parameter><optional>$params</optional></parameter> </paramdef> </funcprototype> </funcsynopsis> @@ -37,24 +34,25 @@ </term> <listitem> <para> - the SQL query or the statement to - prepare + the SQL query or the statement to prepare </para> </listitem> </varlistentry> <varlistentry> <term> - &type.array; + &type.mixed; <parameter>$params</parameter> </term> <listitem> <para> - if supplied, + array, string or numeric data to be added to the prepared statement. + Quantity of items passed must match quantity of placeholders in the + prepared statement: meaning 1 placeholder for non-array + parameters or 1 placeholder per array element. + If if supplied, <link linkend="package.database.db.intro-execute"> <function>prepare</function>/ - <function>execute</function></link> will - be used with this array as - execute parameters + <function>execute</function></link> is used. </para> </listitem> </varlistentry> @@ -94,7 +92,7 @@ <entry> See the <link linkend="package.database.db.db-common.prepare"> <function>prepare</function> documentation</link>, - if you want to use a SQL statemt using wildcards. + if you want to use a SQL statemt using placeholders. </entry> </row> <row> @@ -103,14 +101,15 @@ &null; </entry> <entry> - To less data for filling the prepared SQL statment. + Quantity of parameters didn't match quantity of placeholders in + the prepared statment. </entry> <entry> - Check the number of wild cards given in the SQL statment + Check that the number of placeholders in the <link linkend="package.database.db.db-common.prepare"> - <function>prepare</function></link>. Check the count of - entries in the array for <parameter>$params</parameter>. The count - of entries have to be equal to the number of wild cards. + <function>prepare</function></link> statement passed to + <parameter>$query</parameter> equals the count of entries + passed to <parameter>$params</parameter>. </entry> </row> <row> http://cvs.php.net/diff.php/peardoc/en/package/database/db/db-common/getrow.xml?r1=1.8&r2=1.9&ty=u Index: peardoc/en/package/database/db/db-common/getrow.xml diff -u peardoc/en/package/database/db/db-common/getrow.xml:1.8 peardoc/en/package/database/db/db-common/getrow.xml:1.9 --- peardoc/en/package/database/db/db-common/getrow.xml:1.8 Mon Jan 26 17:30:53 2004 +++ peardoc/en/package/database/db/db-common/getrow.xml Mon Jan 26 18:59:22 2004 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <refentry id="package.database.db.db-common.getrow"> <refnamediv> <refname>DB_Common::getRow()</refname> @@ -6,14 +6,12 @@ </refnamediv> <refsynopsisdiv> <funcsynopsis> - <funcsynopsisinfo> - require_once 'DB.php'; - </funcsynopsisinfo> <funcprototype> <funcdef>array <function>&amp;getRow</function></funcdef> <paramdef>string <parameter>$query</parameter></paramdef> - <paramdef>array - <parameter><optional>$params = array()</optional></parameter></paramdef> + <paramdef> + mixed <parameter><optional>$params</optional></parameter> + </paramdef> <paramdef>integer <parameter><optional>$fetchmode = <constant>DB_FETCHMODE_DEFAULT</constant> @@ -39,23 +37,25 @@ </term> <listitem> <para> - the SQL query + the SQL query or the statement to prepare </para> </listitem> </varlistentry> <varlistentry> <term> - &type.array; + &type.mixed; <parameter>$params</parameter> </term> <listitem> <para> - if supplied, + array, string or numeric data to be added to the prepared statement. + Quantity of items passed must match quantity of placeholders in the + prepared statement: meaning 1 placeholder for non-array + parameters or 1 placeholder per array element. + If if supplied, <link linkend="package.database.db.intro-execute"> <function>prepare</function>/ - <function>execute</function></link> will - be used with this array as - execute parameters + <function>execute</function></link> is used. </para> </listitem> </varlistentry> @@ -107,7 +107,7 @@ <entry> See the <link linkend="package.database.db.db-common.prepare"> <function>prepare</function> documentation</link>, - if you want to use a SQL statemt using wildcards. + if you want to use a SQL statemt using placeholders. </entry> </row> <row> @@ -116,14 +116,15 @@ &null; </entry> <entry> - To less data for filling the prepared SQL statment. + Quantity of parameters didn't match quantity of placeholders in + the prepared statment. </entry> <entry> - Check the number of wild cards given in the SQL statment + Check that the number of placeholders in the <link linkend="package.database.db.db-common.prepare"> - <function>prepare</function></link>. Check the count of - entries in the array for <parameter>$params</parameter>. The count - of entries have to be equal to the number of wild cards. + <function>prepare</function></link> statement passed to + <parameter>$query</parameter> equals the count of entries + passed to <parameter>$params</parameter>. </entry> </row> <row>
« previous php.pear.doc (#2186) next »