vrana Thu Nov 11 03:16:32 2004 EDT
Modified files: /phpdoc/en/reference/pdo reference.xml /phpdoc/en/reference/pdo/functions PDO-errorInfo.xml PDO-exec.xml PDO-lastInsertId.xml PDOStatement-bindColumn.xml PDOStatement-bindParam.xml PDOStatement-errorInfo.xml PDOStatement-execute.xml PDOStatement-fetchAll.xml PDOStatement-fetchSingle.xml PDOStatement-rowCount.xml Log: Tidy a bit
http://cvs.php.net/diff.php/phpdoc/en/reference/pdo/reference.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/pdo/reference.xml diff -u phpdoc/en/reference/pdo/reference.xml:1.3 phpdoc/en/reference/pdo/reference.xml:1.4 --- phpdoc/en/reference/pdo/reference.xml:1.3 Wed Nov 10 17:21:18 2004 +++ phpdoc/en/reference/pdo/reference.xml Thu Nov 11 03:16:29 2004 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. --> <reference id="ref.pdo"> <title>pdo Functions</title> @@ -68,8 +68,8 @@ &reftitle.constructor; <itemizedlist> <listitem> - <para><link linkend='function.PDO-construct'>PDO</link> - constructs a new PDO - object</para> + <para><link linkend='function.PDO-construct'>PDO</link> - constructs a new PDO + object</para> </listitem> </itemizedlist> </section> @@ -77,42 +77,42 @@ &reftitle.methods; <itemizedlist> <listitem> - <para><link linkend='function.PDO-beginTransaction'>beginTransaction - </link> - begins a transaction</para> + <para><link linkend='function.PDO-beginTransaction'>beginTransaction + </link> - begins a transaction</para> </listitem> <listitem> - <para><link linkend='function.PDO-commit'>commit</link> - commits a - transaction</para> + <para><link linkend='function.PDO-commit'>commit</link> - commits a + transaction</para> </listitem> <listitem> - <para><link linkend='function.PDO-exec'>exec</link> - issues an SQL - statement</para> + <para><link linkend='function.PDO-exec'>exec</link> - issues an SQL + statement</para> </listitem> <listitem> - <para><link linkend='function.PDO-errorCode'>errorCode</link> - - retrieves an error code, if any, from the database</para> + <para><link linkend='function.PDO-errorCode'>errorCode</link> - + retrieves an error code, if any, from the database</para> </listitem> <listitem> - <para><link linkend='function.PDO-errorInfo'>errorInfo</link> - - retrieves an array of error information, if any, from the - database</para> + <para><link linkend='function.PDO-errorInfo'>errorInfo</link> - + retrieves an array of error information, if any, from the + database</para> </listitem> <listitem> - <para><link linkend='function.PDO-lastInsertID'>lastInsertID</link> - - retrieves the value of the last row that was inserted into a - table</para> + <para><link linkend='function.PDO-lastInsertID'>lastInsertID</link> - + retrieves the value of the last row that was inserted into a + table</para> </listitem> <listitem> - <para><link linkend='function.PDO-prepare'>prepare</link> - prepares - an SQL statement for execution</para> + <para><link linkend='function.PDO-prepare'>prepare</link> - prepares + an SQL statement for execution</para> </listitem> <listitem> - <para><link linkend='function.PDO-rollback'>rollback</link> - roll - back a transaction</para> + <para><link linkend='function.PDO-rollback'>rollback</link> - roll + back a transaction</para> </listitem> <listitem> - <para><link linkend='function.PDO-setAttribute'>setAttribute</link> - - sets a database connection attribute</para> + <para><link linkend='function.PDO-setAttribute'>setAttribute</link> - + sets a database connection attribute</para> </listitem> </itemizedlist> </section> @@ -125,40 +125,40 @@ &reftitle.methods; <itemizedlist> <listitem> - <para><link linkend='function.PDOStatement-bindColumn'>bindColumn</link> - binds a - PHP variable to an output column in a result set</para> + <para><link linkend='function.PDOStatement-bindColumn'>bindColumn</link> - binds a + PHP variable to an output column in a result set</para> </listitem> <listitem> - <para><link linkend='function.PDOStatement-bindParam'>bindParam</link> - binds a - PHP variable to a parameter in the prepared statement</para> + <para><link linkend='function.PDOStatement-bindParam'>bindParam</link> - binds a + PHP variable to a parameter in the prepared statement</para> </listitem> <listitem> - <para><link linkend='function.PDOStatement-errorCode'>errorCode</link> - - retrieves an error code, if any, from the statement</para> + <para><link linkend='function.PDOStatement-errorCode'>errorCode</link> - + retrieves an error code, if any, from the statement</para> </listitem> <listitem> - <para><link linkend='function.PDOStatement-errorInfo'>errorInfo</link> - - retrieves an array of error information, if any, from the statement</para> + <para><link linkend='function.PDOStatement-errorInfo'>errorInfo</link> - + retrieves an array of error information, if any, from the statement</para> </listitem> <listitem> - <para><link linkend='function.PDOStatement-execute'>execute</link> - executes a - prepared statement</para> + <para><link linkend='function.PDOStatement-execute'>execute</link> - executes a + prepared statement</para> </listitem> <listitem> - <para><link linkend='function.PDOStatement-fetch'>fetch</link> - fetches a - row from a result set</para> + <para><link linkend='function.PDOStatement-fetch'>fetch</link> - fetches a + row from a result set</para> </listitem> <listitem> - <para><link linkend='function.PDOStatement-fetchAll'>fetchAll</link> - fetches an - array containing all of the rows from a result set</para> + <para><link linkend='function.PDOStatement-fetchAll'>fetchAll</link> - fetches an + array containing all of the rows from a result set</para> </listitem> <listitem> - <para><link linkend='function.PDOStatement-fetchSingle'>fetchSingle</link> - returns - the data from the first column in a result set</para> + <para><link linkend='function.PDOStatement-fetchSingle'>fetchSingle</link> - returns + the data from the first column in a 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</para> + <para><link linkend='function.PDOStatement-rowCount'>rowCount</link> - returns the + number of rows that were affected by the execution of an SQL statement</para> </listitem> </itemizedlist> </section> http://cvs.php.net/diff.php/phpdoc/en/reference/pdo/functions/PDO-errorInfo.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/pdo/functions/PDO-errorInfo.xml diff -u phpdoc/en/reference/pdo/functions/PDO-errorInfo.xml:1.1 phpdoc/en/reference/pdo/functions/PDO-errorInfo.xml:1.2 --- phpdoc/en/reference/pdo/functions/PDO-errorInfo.xml:1.1 Wed Nov 10 17:21:21 2004 +++ phpdoc/en/reference/pdo/functions/PDO-errorInfo.xml Thu Nov 11 03:16:32 2004 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. --> <refentry id="function.PDO-errorInfo"> <refnamediv> @@ -11,7 +11,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>int</type><methodname>PDO::errorInfo</methodname> + <type>array</type><methodname>PDO::errorInfo</methodname> <void/> </methodsynopsis> http://cvs.php.net/diff.php/phpdoc/en/reference/pdo/functions/PDO-exec.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/pdo/functions/PDO-exec.xml diff -u phpdoc/en/reference/pdo/functions/PDO-exec.xml:1.1 phpdoc/en/reference/pdo/functions/PDO-exec.xml:1.2 --- phpdoc/en/reference/pdo/functions/PDO-exec.xml:1.1 Wed Nov 10 17:21:21 2004 +++ phpdoc/en/reference/pdo/functions/PDO-exec.xml Thu Nov 11 03:16:32 2004 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. --> <refentry id="function.PDO-exec"> <refnamediv> @@ -11,7 +11,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>long</type><methodname>PDO::exec</methodname> + <type>int</type><methodname>PDO::exec</methodname> <methodparam><type>string</type><parameter>query</parameter></methodparam> </methodsynopsis> http://cvs.php.net/diff.php/phpdoc/en/reference/pdo/functions/PDO-lastInsertId.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/pdo/functions/PDO-lastInsertId.xml diff -u phpdoc/en/reference/pdo/functions/PDO-lastInsertId.xml:1.1 phpdoc/en/reference/pdo/functions/PDO-lastInsertId.xml:1.2 --- phpdoc/en/reference/pdo/functions/PDO-lastInsertId.xml:1.1 Wed Nov 10 17:21:22 2004 +++ phpdoc/en/reference/pdo/functions/PDO-lastInsertId.xml Thu Nov 11 03:16:32 2004 @@ -1,11 +1,11 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. --> <refentry id="function.PDO-lastInsertId"> <refnamediv> <refname>PDO::lastInsertId</refname> <refpurpose> - Returns the number id of rows that we affected by the last call to PDO::exec(). Not always meaningful. + Returns the number id of rows that we affected by the last call to PDO::exec() </refpurpose> </refnamediv> <refsect1> @@ -16,7 +16,11 @@ </methodsynopsis> &warn.undocumented.func; - + <note> + <para> + Not always meaningful. + </para> + </note> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdo/functions/PDOStatement-bindColumn.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/pdo/functions/PDOStatement-bindColumn.xml diff -u phpdoc/en/reference/pdo/functions/PDOStatement-bindColumn.xml:1.1 phpdoc/en/reference/pdo/functions/PDOStatement-bindColumn.xml:1.2 --- phpdoc/en/reference/pdo/functions/PDOStatement-bindColumn.xml:1.1 Wed Nov 10 17:21:23 2004 +++ phpdoc/en/reference/pdo/functions/PDOStatement-bindColumn.xml Thu Nov 11 03:16:32 2004 @@ -1,25 +1,31 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. --> <refentry id="function.PDOStatement-bindColumn"> <refnamediv> <refname>PDOStatement::bindColumn</refname> <refpurpose> - bind a column to a PHP variable. On each row fetch $param will contain the value of the corresponding column. $column is the 1-based offset of the column, or the column name. For portability, don't call this before execute(). + Bind a column to a PHP variable </refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>bool</type><methodname>PDOStatement::bindColumn</methodname> - <methodparam><type>mixed</type><parameter>$column</parameter></methodparam> - <methodparam><type>mixed</type><parameter role="reference">$param</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>$type</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>$maxlen</parameter></methodparam> - <methodparam choice="opt"><type>mixed</type><parameter>$driverdata</parameter></methodparam> + <methodparam><type>mixed</type><parameter>column</parameter></methodparam> + <methodparam><type>mixed</type><parameter role="reference">param</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>type</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>maxlen</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter>driverdata</parameter></methodparam> </methodsynopsis> &warn.undocumented.func; + <para> + On each row fetch <parameter>param</parameter> will contain the value of + the corresponding column. <parameter>column</parameter> is the 1-based + offset of the column, or the column name. For portability, don't call + this before <function>PDO::execute</function>. + </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdo/functions/PDOStatement-bindParam.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/pdo/functions/PDOStatement-bindParam.xml diff -u phpdoc/en/reference/pdo/functions/PDOStatement-bindParam.xml:1.1 phpdoc/en/reference/pdo/functions/PDOStatement-bindParam.xml:1.2 --- phpdoc/en/reference/pdo/functions/PDOStatement-bindParam.xml:1.1 Wed Nov 10 17:21:23 2004 +++ phpdoc/en/reference/pdo/functions/PDOStatement-bindParam.xml Thu Nov 11 03:16:32 2004 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. --> <refentry id="function.PDOStatement-bindParam"> <refnamediv> @@ -34,7 +34,7 @@ </para> <example><title>Execute a prepared statement with named placeholders</title> <programlisting role='php'> - <![CDATA[ +<![CDATA[ <?php /* Execute a prepared statement by binding PHP variables */ $calories = 150; @@ -45,13 +45,14 @@ $sth->bindParam(':calories', $calories, PDO_PARAM_INT); $sth->bindParam(':colour', $colour, PDO_PARAM_STR, 12); $sth->execute(); +?> ]]> </programlisting> </example> <example><title>Execute a prepared statement with question mark placeholders</title> <programlisting role='php'> - <![CDATA[ +<![CDATA[ <?php /* Execute a prepared statement by binding PHP variables */ $calories = 150; http://cvs.php.net/diff.php/phpdoc/en/reference/pdo/functions/PDOStatement-errorInfo.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/pdo/functions/PDOStatement-errorInfo.xml diff -u phpdoc/en/reference/pdo/functions/PDOStatement-errorInfo.xml:1.1 phpdoc/en/reference/pdo/functions/PDOStatement-errorInfo.xml:1.2 --- phpdoc/en/reference/pdo/functions/PDOStatement-errorInfo.xml:1.1 Wed Nov 10 17:21:23 2004 +++ phpdoc/en/reference/pdo/functions/PDOStatement-errorInfo.xml Thu Nov 11 03:16:32 2004 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. --> <refentry id="function.PDOStatement-errorInfo"> <refnamediv> @@ -11,7 +11,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>int</type><methodname>PDOStatement::errorInfo</methodname> + <type>array</type><methodname>PDOStatement::errorInfo</methodname> <void/> </methodsynopsis> http://cvs.php.net/diff.php/phpdoc/en/reference/pdo/functions/PDOStatement-execute.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/pdo/functions/PDOStatement-execute.xml diff -u phpdoc/en/reference/pdo/functions/PDOStatement-execute.xml:1.1 phpdoc/en/reference/pdo/functions/PDOStatement-execute.xml:1.2 --- phpdoc/en/reference/pdo/functions/PDOStatement-execute.xml:1.1 Wed Nov 10 17:21:23 2004 +++ phpdoc/en/reference/pdo/functions/PDOStatement-execute.xml Thu Nov 11 03:16:32 2004 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. --> <refentry id="function.PDOStatement-execute"> <refnamediv> @@ -20,15 +20,15 @@ parameter markers, you must either: <itemizedlist> <listitem><para>call <function>PDOStatement::bindParam</function> to bind PHP variables - to the parameter markers: bound variables pass their value as input and receive the - output value, if any, of their associated parameter markers</para></listitem> + to the parameter markers: bound variables pass their value as input and receive the + output value, if any, of their associated parameter markers</para></listitem> <listitem><para>or pass an array of input-only parameter values</para></listitem> </itemizedlist> </para> <example><title>Execute a prepared statement with bound variables</title> <programlisting role='php'> - <![CDATA[ +<![CDATA[ <?php /* Execute a prepared statement by binding PHP variables */ $calories = 150; @@ -39,13 +39,14 @@ $sth->bindParam(':calories', $calories, PDO_PARAM_INT); $sth->bindParam(':colour', $colour, PDO_PARAM_STR, 12); $sth->execute(); +?> ]]> </programlisting> </example> <example><title>Execute a prepared statement with an array of insert values</title> <programlisting role='php'> - <![CDATA[ +<![CDATA[ <?php /* Execute a prepared statement by passing an arary of insert values */ $calories = 150; @@ -63,7 +64,7 @@ <example><title>Execute a prepared statement with question mark placeholders</title> <programlisting role='php'> - <![CDATA[ +<![CDATA[ <?php /* Execute a prepared statement by binding PHP variables */ $calories = 150; http://cvs.php.net/diff.php/phpdoc/en/reference/pdo/functions/PDOStatement-fetchAll.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/pdo/functions/PDOStatement-fetchAll.xml diff -u phpdoc/en/reference/pdo/functions/PDOStatement-fetchAll.xml:1.1 phpdoc/en/reference/pdo/functions/PDOStatement-fetchAll.xml:1.2 --- phpdoc/en/reference/pdo/functions/PDOStatement-fetchAll.xml:1.1 Wed Nov 10 17:21:23 2004 +++ phpdoc/en/reference/pdo/functions/PDOStatement-fetchAll.xml Thu Nov 11 03:16:32 2004 @@ -1,22 +1,27 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. --> <refentry id="function.PDOStatement-fetchAll"> <refnamediv> <refname>PDOStatement::fetchAll</refname> <refpurpose> - Returns an array of all of the results. + Returns an array of all of the results </refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>array</type><methodname>PDOStatement::fetchAll</methodname> - <methodparam choice="opt"><type>int</type><parameter>$how</parameter></methodparam> - <methodparam choice="opt"><type>=</type><parameter>PDO_FETCH_BOTH</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>how</parameter></methodparam> </methodsynopsis> &warn.undocumented.func; + <note> + <para> + <parameter>how</parameter> defaults to + <literal>PDO_FETCH_BOTH</literal>. + </para> + </note> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/pdo/functions/PDOStatement-fetchSingle.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/pdo/functions/PDOStatement-fetchSingle.xml diff -u phpdoc/en/reference/pdo/functions/PDOStatement-fetchSingle.xml:1.1 phpdoc/en/reference/pdo/functions/PDOStatement-fetchSingle.xml:1.2 --- phpdoc/en/reference/pdo/functions/PDOStatement-fetchSingle.xml:1.1 Wed Nov 10 17:21:23 2004 +++ phpdoc/en/reference/pdo/functions/PDOStatement-fetchSingle.xml Thu Nov 11 03:16:32 2004 @@ -1,11 +1,11 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. --> <refentry id="function.PDOStatement-fetchSingle"> <refnamediv> <refname>PDOStatement::fetchSingle</refname> <refpurpose> - Returns a data of the 1st column in the result set. + Returns a data of the first column in the result set </refpurpose> </refnamediv> <refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/pdo/functions/PDOStatement-rowCount.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/pdo/functions/PDOStatement-rowCount.xml diff -u phpdoc/en/reference/pdo/functions/PDOStatement-rowCount.xml:1.1 phpdoc/en/reference/pdo/functions/PDOStatement-rowCount.xml:1.2 --- phpdoc/en/reference/pdo/functions/PDOStatement-rowCount.xml:1.1 Wed Nov 10 17:21:24 2004 +++ phpdoc/en/reference/pdo/functions/PDOStatement-rowCount.xml Thu Nov 11 03:16:32 2004 @@ -1,11 +1,11 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. --> <refentry id="function.PDOStatement-rowCount"> <refnamediv> <refname>PDOStatement::rowCount</refname> <refpurpose> - Returns the number of rows in a result set, or the number of rows affected by the last execute(). It is not always meaningful. + Returns the number of rows in a result set, or the number of rows affected by the last PDOStatement::execute() </refpurpose> </refnamediv> <refsect1> @@ -16,7 +16,11 @@ </methodsynopsis> &warn.undocumented.func; - + <note> + <para> + Not always meaningful. + </para> + </note> </refsect1> </refentry>