/
getcolumnmeta.xml
186 lines (180 loc) · 5.34 KB
/
getcolumnmeta.xml
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
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 661e6858acade9f5a08fc8f9c07b605f42f4a700 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="pdostatement.getcolumnmeta" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>PDOStatement::getColumnMeta</refname>
<refpurpose>
Retourne les métadonnées pour une colonne d'un jeu de résultats
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="PDOStatement">
<modifier>public</modifier> <type class="union"><type>array</type><type>false</type></type><methodname>PDOStatement::getColumnMeta</methodname>
<methodparam><type>int</type><parameter>column</parameter></methodparam>
</methodsynopsis>
<para>
Récupère les métadonnées pour une colonne d'un jeu de résultats
dans un tableau associatif.
</para>
<warning>
<simpara>
Certains pilotes peuvent ne pas implémenter la fonction
<methodname>PDOStatement::getColumnMeta</methodname>, car elle est facultative.
Cependant, tous les <link linkend="pdo.drivers">pilotes PDO</link>
documentés dans le manuel implémentent cette fonction.
</simpara>
</warning>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>column</parameter></term>
<listitem>
<para>
Le nom de la colonne dans le jeu de résultats.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retourne un tableau associatif contenant les valeurs suivantes représentant les métadonnées
pour une colonne :
</para>
<table>
<title>Métadonnées d'une colonne</title>
<tgroup cols="2">
<colspec colname="c1"/>
<colspec colname="c2"/>
<thead>
<row>
<entry>Nom</entry>
<entry>Valeur</entry>
</row>
</thead>
<tbody>
<row>
<entry><literal>native_type</literal></entry>
<entry>Le type natif PHP utilisé pour représenter la valeur de la colonne.</entry>
</row>
<row>
<entry><literal>driver:decl_type</literal></entry>
<entry>Le type SQL utilisé pour représenter la valeur de la colonne dans la base de données.
Si la colonne du jeu de résultats est le résultat d'une fonction, cette valeur
n'est pas retournée par la fonction <methodname>PDOStatement::getColumnMeta</methodname>.
</entry>
</row>
<row>
<entry><literal>flags</literal></entry>
<entry>N'importe quelle balise définie pour cette colonne.</entry>
</row>
<row>
<entry><literal>name</literal></entry>
<entry>Le nom de cette colonne, comme retourné par la base de données.</entry>
</row>
<row>
<entry><literal>table</literal></entry>
<entry>Le nom de la table de cette colonne, tel que retourné par la base de données.</entry>
</row>
<row>
<entry><literal>len</literal></entry>
<entry>La longueur de cette colonne. Normalement, <literal>-1</literal>
pour les types autres que les nombres décimaux à virgule flottante.</entry>
</row>
<row>
<entry><literal>precision</literal></entry>
<entry>La précision numérique pour cette colonne. Normalement,
&zero; pour les types autres que les nombres décimaux à virgule flottante.</entry>
</row>
<row>
<entry><literal>pdo_type</literal></entry>
<entry>Le type de cette colonne comme représenté par la constante
<link linkend="pdo.constants"><literal>PDO::PARAM_*</literal></link>.</entry>
</row>
</tbody>
</tgroup>
</table>
<para>
Retourne &false; si la colonne demandée n'existe pas dans le jeu de résultats,
ou si aucun jeu de résultats n'existe.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Récupération des métadonnées pour une colonne</title>
<para>
L'exemple suivant montre le résultat de la récupération des métadonnées
pour une colonne générée par une fonction (COUNT) dans un pilote
PDO_SQLITE.
</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><methodname>PDOStatement::columnCount</methodname></member>
<member><methodname>PDOStatement::rowCount</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
-->