-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathcallable.xml
More file actions
300 lines (260 loc) · 8.76 KB
/
callable.xml
File metadata and controls
300 lines (260 loc) · 8.76 KB
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
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 312c0c7b39d0722c419f6784cbda24823220dfb3 Maintainer: Marqitos Status: ready -->
<!-- Reviewed: no -->
<sect1 xml:id="language.types.callable">
<title>Callables</title>
<simpara>
Un callable es una referencia a una función o método que se pasa a
otra función como argumento.
Se representa con la declaración de tipo <type>callable</type>.
</simpara>
<informalexample>
<programlisting role="php" annotations="non-interactive">
<![CDATA[
<?php
function foo(callable $callback) {
$callback();
}
?>
]]>
</programlisting>
</informalexample>
<simpara>
Algunas funciones aceptan funciones de retrollamada como parámetro, por ejemplo
<function>array_map</function>, <function>usort</function>, o
<function>preg_replace_callback</function>.
</simpara>
<sect2 xml:id="language.types.callable.passing">
<title>Creación de callables</title>
<simpara>
Un callable es un tipo que representa algo que se puede invocar.
Los callables se pueden pasar como argumentos a funciones o métodos que
esperan un parámetro de retrollamada o se pueden invocar directamente.
El tipo <type>callable</type> no se puede usar como declaración de tipo para propiedades
de clase. En su lugar, use una declaración de tipo <classname>Closure</classname>.
</simpara>
<simpara>
Los callables se pueden crear de varias maneras diferentes:
</simpara>
<itemizedlist>
<listitem>
<simpara>Un objeto <classname>Closure</classname></simpara>
</listitem>
<listitem>
<simpara>Un &string; conteniendo el nombre de una función o método</simpara>
</listitem>
<listitem>
<simpara>
Un &array; conteniendo un nombre de clase o un <type>object</type>
en el índice 0 y el nombre del método en el índice 1
</simpara>
</listitem>
<listitem>
<simpara>
Un &object; implementando el método mágico
<link linkend="object.invoke">__invoke()</link>
</simpara>
</listitem>
</itemizedlist>
<simpara>
Un objeto <classname>Closure</classname> puede ser creado usando la sintaxis de
<link linkend="functions.anonymous">funciones anónimas</link>, sintaxis de
<link linkend="functions.arrow">funciones de flecha</link>,
<link linkend="functions.first_class_callable_syntax">sintaxis callable de primera
clase</link>, o el método <methodname>Closure::fromCallable</methodname>.
</simpara>
<note>
<simpara>
La <link linkend="functions.first_class_callable_syntax">sintaxis callable de primera
clase</link> solo está disponible a partir de PHP 8.1.0.
</simpara>
</note>
<example>
<title>
Ejemplo de callback usando una <classname>Closure</classname>
</title>
<programlisting role="php">
<![CDATA[
<?php
// Usando sintaxis de función anónima
$double1 = function ($a) {
return $a * 2;
};
// Usando sintaxis de callable de primera clase
function double_function($a) {
return $a * 2;
}
$double2 = double_function(...);
// Usando sintaxis de función de flecha
$double3 = fn($a) => $a * 2;
// Usando Closure::fromCallable
$double4 = Closure::fromCallable('double_function');
// Utilizar clousure como función de devolución de retrollamada
// para duplicar el tamaño de cada elemento en nuestro rango
$new_numbers = array_map($double1, range(1, 5));
print implode(' ', $new_numbers) . PHP_EOL;
$new_numbers = array_map($double2, range(1, 5));
print implode(' ', $new_numbers) . PHP_EOL;
$new_numbers = array_map($double3, range(1, 5));
print implode(' ', $new_numbers) . PHP_EOL;
$new_numbers = array_map($double4, range(1, 5));
print implode(' ', $new_numbers);
?>
]]>
</programlisting>
&example.outputs.81;
<screen>
<![CDATA[
2 4 6 8 10
2 4 6 8 10
2 4 6 8 10
2 4 6 8 10
]]>
</screen>
</example>
<simpara>
Un callable también puede ser un string que contenga el nombre de una función o
método estático.
Cualquier función interna o definida por el usuario puede ser usada, excepto las construcciones del lenguaje
como: <function>array</function>, <function>echo</function>,
<function>empty</function>, <function>eval</function>,
<function>isset</function>,
<function>list</function>, <function>print</function>, o
<function>unset</function>.
</simpara>
<simpara>
Un método de clase estático puede ser usado sin instanciar un
<type>object</type> de esa clase, ya sea creando un array con
el nombre de la clase en el índice 0 y el nombre del método en el índice 1, o usando
la sintaxis especial con el operador de resolución de ámbito
<literal>::</literal>, como en <literal>'ClassName::methodName'</literal>.
</simpara>
<simpara>
Un método de un <type>object</type> instanciado puede ser un callable
cuando se pasa como un array con el <type>object</type> en el índice 0
y el nombre del método en el índice 1.
</simpara>
<simpara>
La principal diferencia entre un objeto <classname>Closure</classname> y el
tipo <type>callable</type> es que un objeto <classname>Closure</classname> es
independiente del ámbito y siempre se puede invocar, mientras que un tipo
callable puede depender del ámbito y puede que no se pueda invocar directamente.
<classname>Closure</classname> es la forma preferida de crear callables.
</simpara>
<note>
<simpara>
Mientras que los objetos <classname>Closure</classname> están vinculados al ámbito
donde se crean, los callables que hacen referencia a métodos de clase como strings
o arrays se resuelven en el ámbito donde se llaman.
Para crear un callable a partir de un método privado o protegido, que luego se pueda
invocar desde fuera del ámbito de la clase, use
<methodname>Closure::fromCallable</methodname> o la
<link linkend="functions.first_class_callable_syntax">sintaxis callable de primera
clase</link>.
</simpara>
</note>
<simpara>
PHP permite la creación de callables que pueden ser usados como argumento de retrollamada
pero que no pueden ser llamados directamente.
Estos son callables dependientes del contexto que hacen referencia a un método de clase en la
jerarquía de herencia de una clase, por ejemplo
<literal>'parent::method'</literal> o <literal>["static", "method"]</literal>.
</simpara>
<note>
<simpara>
A partir de PHP 8.2.0, los callables dependientes del contexto
están obsoletos. Elimine la dependencia del contexto reemplazando
<literal>'parent::method'</literal> con
<literal>parent::class . '::method'</literal> o use la
<link linkend="functions.first_class_callable_syntax">sintaxis callable de primera
clase</link>.
</simpara>
</note>
<example>
<title>
Invocando varios tipos de callables con <function>call_user_func</function>
</title>
<programlisting role="php">
<![CDATA[
<?php
// Un ejemplo de función de retrollamada
function my_callback_function() {
echo '¡hola mundo!', PHP_EOL;
}
// Un ejemplo de método de retrollamada
class MyClass {
static function myCallbackMethod() {
echo '¡Hola Mundo!', PHP_EOL;
}
}
// Tipo 1: Función de retrollamada simple
call_user_func('my_callback_function');
// Tipo 2: Llamada a un método estático de clase
call_user_func(['MyClass', 'myCallbackMethod']);
// Tipo 3: Llamada a un método de objeto
$obj = new MyClass();
call_user_func([$obj, 'myCallbackMethod']);
// Tipo 4: Llamada a un método estático de clase
call_user_func('MyClass::myCallbackMethod');
// Type 5: Llamada a un método estático de clase usando la palabla clave ::class
call_user_func([MyClass::class, 'myCallbackMethod']);
// Tipo 6: Llamada a un método estático de clase relativo
class A {
public static function who() {
echo 'A', PHP_EOL;
}
}
class B extends A {
public static function who() {
echo 'B', PHP_EOL;
}
}
call_user_func(['B', 'parent::who']); // obsoleto a partir de PHP 8.2.0
// Tipo 7: Los objetos que implementan __invoke pueden ser utilizados como callables
class C {
public function __invoke($name) {
echo 'Hola ', $name;
}
}
$c = new C();
call_user_func($c, 'PHP!');
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
¡hola mundo!
¡Hola Mundo!
¡Hola Mundo!
¡Hola Mundo!
¡Hola Mundo!
Deprecated: Callables of the form ["B", "parent::who"] are deprecated in script on line 41
A
Hola PHP!
]]>
</screen>
</example>
¬e.func-callback-exceptions;
</sect2>
</sect1>
<!-- 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
-->