-
Notifications
You must be signed in to change notification settings - Fork 50
/
array-column.xml
313 lines (299 loc) · 7.58 KB
/
array-column.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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 9eea2fa6a6ea3bc71c5e1b19c8f23494654503ef Maintainer: seros Status: ready -->
<!-- Reviewed: yes Maintainer: seros -->
<refentry xml:id="function.array-column" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>array_column</refname>
<refpurpose>Devuelve los valores de una sola columna del array de entrada</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>array_column</methodname>
<methodparam><type>array</type><parameter>input</parameter></methodparam>
<methodparam><type>mixed</type><parameter>column_key</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>index_key</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<function>array_column</function> devuelve los valores de una sola columna de
<parameter>input</parameter>, identificado por la clave de columna
<parameter>column_key</parameter>. Opcionalmente, se
podría proporcionar una clave de índice, <parameter>index_key</parameter>,
para indexar los valores del array devuelto por los valores de la columna
<parameter>index_key</parameter> del array de entrada.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>input</parameter></term>
<listitem>
<para>
Un array multidimensional o un array de objetos desde el que extraer una
columna de valores. Si se proporciona un array de objetos, entonces se podrá
extraer directamente las propiedades públicas. Para poder extraer las proiedades
protegidas o privadas, la clase debe implementar los métodos mágicos
<function>__get</function> y
<function>__isset</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>column_key</parameter></term>
<listitem>
<para>
La columna de valores a devolver. Este valor podría ser una clave de tipo integer de la
columna de la cual obtener los datos, o podría ser una clave de tipo string para un
array asociativo o nombre de propiedad. También prodría ser &null; para devolver
array completos u objetos (útil junto con
<parameter>index_key</parameter> para reindexar el array).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>index_key</parameter></term>
<listitem>
<para>
La columna a usar como los índices/claves para el array devuelto. Este valor
podría ser la clave de tipo integer de la columna, o podría ser el nombre de la clave de tipo string.
El valor es <link linkend="language.types.array.key-casts">cast</link>
como es habitual para las claves de array (Sin embargo, también se permiten los objetos que
soportan la conversión a string).
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Devuelve un array de valores que representa una sola columna del array de entrada.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>7.0.0</entry>
<entry>
Se añadió la capacidad de que el parámetro <parameter>input</parameter> sea
un array de objetos.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Obtener la columna de nombres del conjunto de resultados</title>
<programlisting role="php">
<![CDATA[
<?php
// Array representando un conjunto de registros posibles devueltos desde una base de datos
$registros = array(
array(
'id' => 2135,
'nombre' => 'John',
'apellido' => 'Doe',
),
array(
'id' => 3245,
'nombre' => 'Sally',
'apellido' => 'Smith',
),
array(
'id' => 5342,
'nombre' => 'Jane',
'apellido' => 'Jones',
),
array(
'id' => 5623,
'nombre' => 'Peter',
'apellido' => 'Doe',
)
);
$nombres = array_column($registros, 'nombre');
print_r($nombres);
?>
]]>
</programlisting>
&example.outputs;
<screen role="php">
<![CDATA[
Array
(
[0] => John
[1] => Sally
[2] => Jane
[3] => Peter
)
]]>
</screen>
</example>
</para>
<para>
<example>
<title>
Obtener la columna de apellidos del conjunto de resultados, indexada por la columna "id"
</title>
<programlisting role="php">
<![CDATA[
<?php
// Se emplea el array $registros del Ejemplo #1
$apellidos = array_column($registros, 'apellido', 'id');
print_r($apellidos);
?>
]]>
</programlisting>
&example.outputs;
<screen role="php">
<![CDATA[
Array
(
[2135] => Doe
[3245] => Smith
[5342] => Jones
[5623] => Doe
)
]]>
</screen>
</example>
</para>
<para>
<example>
<title>
Obtener la columna de nombres de usuarios de la propiedad pública "nombre_usuario" de un
objeto
</title>
<programlisting role="php">
<![CDATA[
<?php
class Usuario
{
public $nombre_usuario;
public function __construct(string $nombre_usuario)
{
$this->nombre_usuario = $nombre_usuario;
}
}
$usuarios = [
new Usuario('usuario 1'),
new Usuario('usuario 2'),
new Usuario('usuario 3'),
];
print_r(array_column($usuarios, 'nombre_usuario'));
?>
]]>
</programlisting>
&example.outputs;
<screen role="php">
<![CDATA[
Array
(
[0] => usuario 1
[1] => usuario 2
[2] => usuario 3
)
]]>
</screen>
</example>
</para>
<para>
<example>
<title>
Obtener la columna de nombres de la propiedad privada "nombre" de un objeto
empleando el método mágico <function>__get</function>.
</title>
<programlisting role="php">
<![CDATA[
<?php
class Persona
{
private $name;
public function __construct(string $nombre)
{
$this->nombre = $nombre;
}
public function __get($prop)
{
return $this->$prop;
}
public function __isset($prop) : bool
{
return isset($this->$prop);
}
}
$gente = [
new Persona('Fred'),
new Persona('Jane'),
new Persona('John'),
];
print_r(array_column($gente, 'nombre'));
?>
]]>
</programlisting>
&example.outputs;
<screen role="php">
<![CDATA[
Array
(
[0] => Fred
[1] => Jane
[2] => John
)
]]>
</screen>
</example>
Si no se proporciona <function>__isset</function>, será devuelto un array
vacío.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member>
<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="&url.arraycolumn.compat;">Implementación
del espacio de usuario recomendada para PHP menor que 5.5</link>
</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
-->