1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="pdostatement.fetchcolumn" xmlns="http://docbook.org/ns/docbook">
<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 role="PDOStatement">
<modifier>public</modifier> <type>mixed</type><methodname>PDOStatement::fetchColumn</methodname>
<methodparam choice="opt"><type>int</type><parameter>column</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Returns a single column from the next row of a result set or &false; if
there are no more rows.
</para>
<note>
<para>
<methodname>PDOStatement::fetchColumn</methodname> should not be used to
retrieve boolean columns, as it is impossible to distinguish a value of
&false; from there being no more rows to retrieve. Use
<methodname>PDOStatement::fetch</methodname> instead.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>column</parameter></term>
<listitem>
<para>
0-indexed number of the column you wish to retrieve from the row. If
no value is supplied, <methodname>PDOStatement::fetchColumn</methodname>
fetches the first column.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<methodname>PDOStatement::fetchColumn</methodname> returns a single column
from the next row of a result set or &false; if there are no more rows.
</para>
<warning>
<para>
There is no way to return another column from the same row if you
use <methodname>PDOStatement::fetchColumn</methodname> to retrieve data.
</para>
</warning>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
&pdo.errors;
</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();
print "Fetch the first column from the first row in the result set:\n";
$result = $sth->fetchColumn();
print "name = $result\n";
print "Fetch the second column from the second row in the result set:\n";
$result = $sth->fetchColumn(1);
print "colour = $result\n";
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Fetch the first column from the first row in the result set:
name = lemon
Fetch the second column from the second row in the result set:
colour = red
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>PDO::query</methodname></member>
<member><methodname>PDOStatement::fetch</methodname></member>
<member><methodname>PDOStatement::fetchAll</methodname></member>
<member><methodname>PDO::prepare</methodname></member>
<member><methodname>PDOStatement::setFetchMode</methodname></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
-->
|
