PDOStatement::fetchSingle becomes PDOStatement::fetchColumn.

Add new parameter to PDOStatement::fetchColumn.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@186675 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Dan Scott 2005-05-20 18:51:02 +00:00
parent 6973b509e1
commit 8dd919817d
6 changed files with 133 additions and 112 deletions

View file

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
<refentry id="function.PDOStatement-bindColumn">
<refnamediv>
@ -143,7 +143,7 @@ strawberry red 25
<member><function>PDOStatement::execute</function></member>
<member><function>PDOStatement::fetch</function></member>
<member><function>PDOStatement::fetchAll</function></member>
<member><function>PDOStatement::fetchSingle</function></member>
<member><function>PDOStatement::fetchColumn</function></member>
</simplelist>
</para>
</refsect1>

View file

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
<refentry id="function.PDOStatement-fetch">
<refnamediv>
@ -237,7 +237,7 @@ Reading backwards:
<simplelist>
<member><function>PDO::query</function></member>
<member><function>PDOStatement::fetchAll</function></member>
<member><function>PDOStatement::fetchSingle</function></member>
<member><function>PDOStatement::fetchColumn</function></member>
<member><function>PDOStatement::prepare</function></member>
<member><function>PDOStatement::setFetchMode</function></member>
</simplelist>

View file

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
<refentry id="function.PDOStatement-fetchAll">
<refnamediv>
@ -106,7 +106,7 @@ Array
<simplelist>
<member><function>PDO::query</function></member>
<member><function>PDOStatement::fetch</function></member>
<member><function>PDOStatement::fetchSingle</function></member>
<member><function>PDOStatement::fetchColumn</function></member>
<member><function>PDOStatement::prepare</function></member>
<member><function>PDOStatement::setFetchMode</function></member>
</simplelist>

View file

@ -0,0 +1,123 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
<refentry id="function.PDOStatement-fetchColumn">
<refnamediv>
<refname>PDOStatement::fetchColumn</refname>
<refpurpose>
Returns a single column from the next row of a result set
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>PDOStatement::fetchColumn</methodname>
<methodparam choice="opt"><type>int</type><parameter>column_number</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
Returns a single column from the next row of a result set.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>column_number</parameter></term>
<listitem>
<para>
Number of the column you wish to retrieve from the row. If no value is
supplied, <function>PDOStatement::fetchColumn</function> fetches the
first column.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>PDOStatement::fetchColumn</function> returns a single column
in the next row of a result set.
</para>
<warning>
<para>
There is no way to return a second column from the same row if you
use <function>PDOStatement::fetchColumn</function> to retrieve data.
</para>
</warning>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example><title>Return first column of the next row</title>
<programlisting role="php">
<![CDATA[
<?php
$sth = $dbh->prepare("SELECT name, colour FROM fruit");
$sth->execute();
/* Fetch the first column from the next row in the result set */
print("Fetch the first column from the next row in the result set:\n");
$result = $sth->fetchColumn();
print("$result\n");
$result = $sth->fetchColumn();
print("$result\n");
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Fetch the first column from the next row in the result set:
lemon
orange
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>PDO::query</function></member>
<member><function>PDOStatement::fetch</function></member>
<member><function>PDOStatement::fetchAll</function></member>
<member><function>PDOStatement::prepare</function></member>
<member><function>PDOStatement::setFetchMode</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
-->

View file

@ -1,102 +0,0 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<!-- 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 the first column in the next row of a result set
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>PDOStatement::fetchSingle</methodname>
<void/>
</methodsynopsis>
&warn.experimental.func;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>PDOStatement::fetchSingle</function> returns the first column
in the next row of a result set as a <literal>string</literal> value.
</para>
<warning>
<para>
There is no way to return the second or subsequent columns from a row
if you use this method to retrieve data.
</para>
</warning>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example><title>Return first column of the next row</title>
<programlisting role="php">
<![CDATA[
<?php
$sth = $dbh->prepare("SELECT name, colour FROM fruit");
$sth->execute();
/* Fetch the first column from the next row in the result set */
print("Fetch the first column from the next row in the result set:\n");
$result = $sth->fetchSingle();
print("$result\n");
$result = $sth->fetchSingle();
print("$result\n");
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Fetch the first column from the next row in the result set:
lemon
orange
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>PDO::query</function></member>
<member><function>PDOStatement::fetch</function></member>
<member><function>PDOStatement::fetchAll</function></member>
<member><function>PDOStatement::prepare</function></member>
<member><function>PDOStatement::setFetchMode</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
-->

View file

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
<refentry id="function.PDOStatement-rowCount">
<refnamediv>
@ -66,7 +66,7 @@ Deleted 9 rows.
return the number of rows affected by a SELECT statement. Instead, use
<function>PDO::query</function> to issue a SELECT COUNT(*) statement
with the same predicates as your intended SELECT statement, then use
<function>PDOStatement::fetchSingle</function> to retrieve the number
<function>PDOStatement::fetchColumn</function> to retrieve the number
of rows that will be returned. Your application can then perform the
correct action.
</para>
@ -77,7 +77,7 @@ $sql = "SELECT COUNT(*) FROM fruit WHERE calories > 100";
if ($res = $conn->query($sql)) {
// Check the number of rows that match the SELECT statement
if ($res->fetchSingle() > 0) {
if ($res->fetchColumn() > 0) {
// Issue the real SELECT statement and work with the results
$sql = "SELECT name FROM fruit WHERE calories > 100";
@ -114,8 +114,8 @@ pear
<para>
<simplelist>
<member><function>PDOStatement::columnCount</function></member>
<member><function>PDOStatement::fetchColumn</function></member>
<member><function>PDOStatement::query</function></member>
<member><function>PDOStatement::fetchSingle</function></member>
</simplelist>
</para>