/
fetch-fields.xml
280 lines (252 loc) · 8.11 KB
/
fetch-fields.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
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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 809b8ab4fd8bce37105d2e65a5267095ad470cf8 Maintainer: seros Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="mysqli-result.fetch-fields" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli_result::fetch_fields</refname>
<refname>mysqli_fetch_fields</refname>
<refpurpose>Devuelve un array de objetos que representan los campos de un conjunto de resultados</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<type>array</type><methodname>mysqli_result::fetch_fields</methodname>
<void/>
</methodsynopsis>
<para>&style.procedural;</para>
<methodsynopsis>
<type>array</type><methodname>mysqli_fetch_fields</methodname>
<methodparam><type>mysqli_result</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>
Esta función sirve de propósito idéntico a la
función <function>mysqli_fetch_field</function> con la única
diferencia de que, en lugar de devolver un objeto por cada campo,
las columnas son devueltas en un array de objetos.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&mysqli.result.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Devuelve un array de objetos que contiene la información de definición de los campos o
&false; si no hay información de campo disponible.
</para>
<para>
<table>
<title>Propiedades del objeto</title>
<tgroup cols="2">
<thead>
<row>
<entry>Propiedad</entry>
<entry>Descripción</entry>
</row>
</thead>
<tbody>
<row>
<entry>name</entry>
<entry>El nombre de la columna</entry>
</row>
<row>
<entry>orgname</entry>
<entry>El nombre original de la columna si se especificó un alias</entry>
</row>
<row>
<entry>table</entry>
<entry>El nombre de la tabla al que pertenece el campo (si no es calculado)</entry>
</row>
<row>
<entry>orgtable</entry>
<entry>El nombre original de la tabla si se especificó un alias</entry>
</row>
<row>
<entry>max_length</entry>
<entry>El ancho máximo del campo del conjunto de resultados.</entry>
</row>
<row>
<entry>length</entry>
<entry>
El ancho del campo, en bytes, como se especificó en la definición de la tabla. Observe que
este número (bytes) podría diferir del valor de la definición de la tabla (caracteres), dependiendo
del conjunto de caracteres que se emplee. Por ejemplo, el conjunto de caracteres utf8 tiene 3 bytes por carácter,
por lo que varchar(10) devolverá una longitud de 30 para utf8 (10*3), aunque devuelve 10 para latin1 (10*1).
</entry>
</row>
<row>
<entry>charsetnr</entry>
<entry>El número del conjunto de caracteres (id) del campo.</entry>
</row>
<row>
<entry>flags</entry>
<entry>Un entero que representa las banderas de bits del campo.</entry>
</row>
<row>
<entry>type</entry>
<entry>El tipo de datos usado por el campo</entry>
</row>
<row>
<entry>decimals</entry>
<entry>El número de decimales usado (para campos integer)</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>&style.oop;</title>
<programlisting role="php">
<![CDATA[
<?php
$mysqli = new mysqli("127.0.0.1", "root", "foofoo", "sakila");
/* comprobar la conexión */
if (mysqli_connect_errno()) {
printf("Falló la conexión: %s\n", $mysqli->connect_error);
exit();
}
foreach (array('latin1', 'utf8') as $conj_caract) {
// Establecer el conjunto de caracteres para mostrar su impacto en algunos valores (p.ej., longitud en bytes)
$mysqli->set_charset($conj_caract);
$consulta = "SELECT actor_id, last_name from actor ORDER BY actor_id";
echo "======================\n";
echo "Conjunto de caracteres: $conj_caract\n";
echo "======================\n";
if ($resultado = $mysqli->query($consulta)) {
/* Obtener la información del campo para todas las columnas */
$info_campo = $resultado->fetch_fields();
foreach ($info_campo as $valor) {
printf("Nombre: %s\n", $valor->name);
printf("Tabla: %s\n", $valor->table);
printf("Longitud máx.: %d\n", $valor->max_length);
printf("Longitud: %d\n", $valor->length);
printf("Nº conj. caract.: %d\n", $valor->charsetnr);
printf("Banderas: %d\n", $valor->flags);
printf("Tipo: %d\n\n", $valor->type);
}
$resultado->free();
}
}
$mysqli->close();
?>
]]>
</programlisting>
</example>
<example>
<title>&style.procedural;</title>
<programlisting role="php">
<![CDATA[
<?php
$enlace = mysqli_connect("127.0.0.1", "mi_usuario", "mi_contraseña", "sakila");
/* comprobar la conexión */
if (mysqli_connect_errno()) {
printf("Falló la conexión: %s\n", mysqli_connect_error());
exit();
}
foreach (array('latin1', 'utf8') as $conj_caract) {
// Establecer el conjunto de caracteres para mostrar su impacto en algunos valores (p.ej., longitud en bytes)
mysqli_set_charset($enlace, $conj_caract);
$consulta = "SELECT actor_id, last_name from actor ORDER BY actor_id";
echo "===============================\n";
echo "Conjunto de caracteres: $conj_caract\n";
echo "===============================\n";
if ($resultado = mysqli_query($enlace, $consulta)) {
/* Obtener la información del campo para todas las columnas */
$info_campo = mysqli_fetch_fields($resultado);
foreach ($info_campo as $valor) {
printf("Nombre: %s\n", $valor->name);
printf("Tabla: %s\n", $valor->table);
printf("Longitud máx.: %d\n", $valor->max_length);
printf("Longitud: %d\n", $valor->length);
printf("Nº conj. caract.: %d\n", $valor->charsetnr);
printf("Banderas: %d\n", $valor->flags);
printf("Tipo: %d\n\n", $valor->type);
}
mysqli_free_result($resultado);
}
}
mysqli_close($enlace);
?>
]]>
</programlisting>
&examples.outputs;
<screen>
<![CDATA[
===============================
Conjunto de caracteres: latin1
===============================
Nombre: actor_id
Tabla: actor
Longitud máx.: 3
Longitud: 5
Nº conj. caract.: 63
Banderas: 49699
Tipo: 2
Nombre: last_name
Tabla: actor
Longitud máx.: 12
Longitud: 45
Nº conj. caract.: 8
Banderas: 20489
Tipo: 253
===============================
Conjunto de caracteres: utf8
===============================
Nombre: actor_id
Tabla: actor
Longitud máx.: 3
Longitud: 5
Nº conj. caract.: 63
Banderas: 49699
Tipo: 2
Nombre: last_name
Tabla: actor
Longitud máx.: 12
Longitud: 135
Nº conj. caract.: 33
Banderas: 20489
]]>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>mysqli_num_fields</function></member>
<member><function>mysqli_fetch_field_direct</function></member>
<member><function>mysqli_fetch_field</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:"~/.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
-->