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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.PDOStatement-getColumnMeta">
<refnamediv>
<refname>PDOStatement::getColumnMeta</refname>
<refpurpose>
Returns metadata for a column in a result set
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>PDOStatement::getColumnMeta</methodname>
<methodparam><type>int</type><parameter>column</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
Retrieves the metadata for a 0-indexed column in a result set as an
associative array.
</para>
<warning>
<simpara>
Not all PDO drivers support
<function>PDOStatement::getColumnMeta</function>.
</simpara>
</warning>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>column</parameter></term>
<listitem>
<para>
The 0-indexed column in the result set.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an associative array containing the following values representing
the metadata for a single column:
</para>
<table>
<title>Column metadata</title>
<tgroup cols='2'>
<colspec colname='c1'/>
<colspec colname='c2'/>
<thead>
<row>
<entry>Name</entry>
<entry>Value</entry>
</row>
</thead>
<tbody>
<row>
<entry><literal>native_type</literal></entry>
<entry>The PHP native type used to represent the column value.</entry>
</row>
<row>
<entry><literal><varname>driver</varname>:decl_type</literal></entry>
<entry>The SQL type used to represent the column value in the database.
If the column in the result set is the result of a function, this value
is not returned by <function>PDOStatement::getColumnMeta</function>.
</entry>
</row>
<row>
<entry><literal>flags</literal></entry>
<entry>Any flags set for this column.</entry>
</row>
<row>
<entry><literal>name</literal></entry>
<entry>The name of this column as returned by the database.</entry>
</row>
<row>
<entry><literal>len</literal></entry>
<entry>The length of this column. Normally <literal>-1</literal> for
types other than floating point decimals.</entry>
</row>
<row>
<entry><literal>precision</literal></entry>
<entry>The numeric precision of this column. Normally
<literal>0</literal> for types other than floating point
decimals.</entry>
</row>
<row>
<entry><literal>pdo_type</literal></entry>
<entry>The type of this column as represented by the
<literal>PDO::PARAM_*</literal> constants.</entry>
</row>
</tbody>
</tgroup>
</table>
<para>
Returns &false; if the requested column does not exist in the result set,
or if no result set exists.
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here
<entry>Description of change
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Retrieving column metadata</title>
<para>
The following example shows the results of retrieving the metadata for a
single column generated by a function (COUNT) in a PDO_SQLITE driver.
</para>
<programlisting role="php">
<![CDATA[
<?php
$select = $DB->query('SELECT COUNT(*) FROM fruit');
$meta = $select->getColumnMeta(0);
var_dump($meta);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
array(6) {
["native_type"]=>
string(7) "integer"
["flags"]=>
array(0) {
}
["name"]=>
string(8) "COUNT(*)"
["len"]=>
int(-1)
["precision"]=>
int(0)
["pdo_type"]=>
int(2)
}
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>PDOStatement::columnCount</function></member>
<member><function>PDOStatement::rowCount</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
-->
|
