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 callable.
<?php
function foo(callable $callback) {
$callback();
}
?>Algunas funciones aceptan funciones de retrollamada como parámetro, por ejemplo array_map(), usort(), o preg_replace_callback().
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 callable no se puede usar como declaración de tipo para propiedades de clase. En su lugar, use una declaración de tipo Closure.
Los callables se pueden crear de varias maneras diferentes:
Un objeto Closure puede ser creado usando la sintaxis de funciones anónimas, sintaxis de funciones de flecha, sintaxis callable de primera clase, o el método Closure::fromCallable().
Nota: La sintaxis callable de primera clase solo está disponible a partir de PHP 8.1.0.
Ejemplo #1 Ejemplo de callback usando una Closure
<?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);
?>Resultado del ejemplo anterior en PHP 8.1:
2 4 6 8 10 2 4 6 8 10 2 4 6 8 10 2 4 6 8 10
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: array(), echo, empty(), eval(), isset(), list(), print, o unset().
Un método de clase estático puede ser usado sin instanciar un
object 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
::, como en 'ClassName::methodName'.
Un método de un object instanciado puede ser un callable cuando se pasa como un array con el object en el índice 0 y el nombre del método en el índice 1.
La principal diferencia entre un objeto Closure y el tipo callable es que un objeto Closure 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. Closure es la forma preferida de crear callables.
Nota: Mientras que los objetos Closure 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 Closure::fromCallable() o la sintaxis callable de primera clase.
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
'parent::method' o ["static", "method"].
Nota: A partir de PHP 8.2.0, los callables dependientes del contexto están obsoletos. Elimine la dependencia del contexto reemplazando
'parent::method'conparent::class . '::method'o use la sintaxis callable de primera clase.
Ejemplo #2 Invocando varios tipos de callables con call_user_func()
<?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!');
?>El ejemplo anterior mostrará:
¡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!
Nota:
Las devoluciónes de llamada registradas con funciones como call_user_func() y call_user_func_array() no serán llamadas si una excepción no es interceptada cuando ha sido lanzada en una función de devolución de llamada anterior.
You can also use the $this variable to specify a callback:
<?php
class MyClass {
public $property = 'Hello World!';
public function MyMethod()
{
call_user_func(array($this, 'myCallbackMethod'));
}
public function MyCallbackMethod()
{
echo $this->property;
}
}
?>Performance note: The callable type hint, like is_callable(), will trigger an autoload of the class if the value looks like a static method callback.When specifying a call back in array notation (ie. array($this, "myfunc") ) the method can be private if called from inside the class, but if you call it from outside you'll get a warning:
<?php
class mc {
public function go(array $arr) {
array_walk($arr, array($this, "walkIt"));
}
private function walkIt($val) {
echo $val . "<br />";
}
public function export() {
return array($this, 'walkIt');
}
}
$data = array(1,2,3,4);
$m = new mc;
$m->go($data); // valid
array_walk($data, $m->export()); // will generate warning
?>
Output:
1<br />2<br />3<br />4<br />
Warning: array_walk() expects parameter 2 to be a valid callback, cannot access private method mc::walkIt() in /in/tfh7f on line 22A note on differences when calling callbacks as "variable functions" without the use of call_user_func() (e.g. "<?php $callback = 'printf'; $callback('Hello World!') ?>"):
- Using the name of a function as string has worked since at least 4.3.0
- Calling anonymous functions and invokable objects has worked since 5.3.0
- Using the array structure [$object, 'method'] has worked since 5.4.0
Note, however, that the following are not supported when calling callbacks as variable functions, even though they are supported by call_user_func():
- Calling static class methods via strings such as 'foo::doStuff'
- Calling parent method using the [$object, 'parent::method'] array structure
All of these cases are correctly recognized as callbacks by the 'callable' type hint, however. Thus, the following code will produce an error "Fatal error: Call to undefined function foo::doStuff() in /tmp/code.php on line 4":
<?php
class foo {
static function callIt(callable $callback) {
$callback();
}
static function doStuff() {
echo "Hello World!";
}
}
foo::callIt('foo::doStuff');
?>
The code would work fine, if we replaced the '$callback()' with 'call_user_func($callback)' or if we used the array ['foo', 'doStuff'] as the callback instead.You can use 'self::methodName' as a callable, but this is dangerous. Consider this example:
<?php
class Foo {
public static function doAwesomeThings() {
FunctionCaller::callIt('self::someAwesomeMethod');
}
public static function someAwesomeMethod() {
// fantastic code goes here.
}
}
class FunctionCaller {
public static function callIt(callable $func) {
call_user_func($func);
}
}
Foo::doAwesomeThings();
?>
This results in an error:
Warning: class 'FunctionCaller' does not have a method 'someAwesomeMethod'.
For this reason you should always use the full class name:
<?php
FunctionCaller::callIt('Foo::someAwesomeMethod');
?>
I believe this is because there is no way for FunctionCaller to know that the string 'self' at one point referred to to `Foo`.you can pass an object as a callable if its class defines the __invoke() magic method..I needed a function that would determine the type of callable being passed, and, eventually,
normalized it to some extent. Here's what I came up with:
<?php
/**
* The callable types and normalizations are given in the table below:
*
* Callable | Normalization | Type
* ---------------------------------+---------------------------------+--------------
* function (...) use (...) {...} | function (...) use (...) {...} | 'closure'
* $object | $object | 'invocable'
* "function" | "function" | 'function'
* "class::method" | ["class", "method"] | 'static'
* ["class", "parent::method"] | ["parent of class", "method"] | 'static'
* ["class", "self::method"] | ["class", "method"] | 'static'
* ["class", "method"] | ["class", "method"] | 'static'
* [$object, "parent::method"] | [$object, "parent::method"] | 'object'
* [$object, "self::method"] | [$object, "method"] | 'object'
* [$object, "method"] | [$object, "method"] | 'object'
* ---------------------------------+---------------------------------+--------------
* other callable | idem | 'unknown'
* ---------------------------------+---------------------------------+--------------
* not a callable | null | false
*
* If the "strict" parameter is set to true, additional checks are
* performed, in particular:
* - when a callable string of the form "class::method" or a callable array
* of the form ["class", "method"] is given, the method must be a static one,
* - when a callable array of the form [$object, "method"] is given, the
* method must be a non-static one.
*
*/
function callableType($callable, $strict = true, callable& $norm = null) {
if (!is_callable($callable)) {
switch (true) {
case is_object($callable):
$norm = $callable;
return 'Closure' === get_class($callable) ? 'closure' : 'invocable';
case is_string($callable):
$m = null;
if (preg_match('~^(?<class>[a-z_][a-z0-9_]*)::(?<method>[a-z_][a-z0-9_]*)$~i', $callable, $m)) {
list($left, $right) = [$m['class'], $m['method']];
if (!$strict || (new \ReflectionMethod($left, $right))->isStatic()) {
$norm = [$left, $right];
return 'static';
}
} else {
$norm = $callable;
return 'function';
}
break;
case is_array($callable):
$m = null;
if (preg_match('~^(:?(?<reference>self|parent)::)?(?<method>[a-z_][a-z0-9_]*)$~i', $callable[1], $m)) {
if (is_string($callable[0])) {
if ('parent' === strtolower($m['reference'])) {
list($left, $right) = [get_parent_class($callable[0]), $m['method']];
} else {
list($left, $right) = [$callable[0], $m['method']];
}
if (!$strict || (new \ReflectionMethod($left, $right))->isStatic()) {
$norm = [$left, $right];
return 'static';
}
} else {
if ('self' === strtolower($m['reference'])) {
list($left, $right) = [$callable[0], $m['method']];
} else {
list($left, $right) = $callable;
}
if (!$strict || !(new \ReflectionMethod($left, $right))->isStatic()) {
$norm = [$left, $right];
return 'object';
}
}
}
break;
}
$norm = $callable;
return 'unknown';
}
$norm = null;
return false;
}
?>
Hope someone else finds it useful.When trying to make a callable from a function name located in a namespace, you MUST give the fully qualified function name (regardless of the current namespace or use statements).
<?php
namespace MyNamespace;
function doSomethingFancy($arg1)
{
// do something...
}
$values = [1, 2, 3];
array_map('doSomethingFancy', $values);
// array_map() expects parameter 1 to be a valid callback, function 'doSomethingFancy' not found or invalid function name
array_map('MyNamespace\doSomethingFancy', $values);
// => [..., ..., ...]If you pass a callable method to a function with a callable type declaration, the error message is misleading:
<?php
class X {
protected function foo(): void {}
}
function bar(callable $c) {}
$x = new X;
$c = [$x, 'foo'];
bar($c);
?>
Error message will be something like "Argument #1 ($c) must be of type callable, array given" while the actual problem here is only the visibility of method "foo". All you need to do is changing it to public (or use a different approach, e.g. with a Closure).I tried many possible ways of calling functions by function name directly and assigned to a variable on 3v4l. Not mentioned yet, it is possible to use an array as a caller, at least since PHP 7.1.25. The following script contains all the information I gained:
<?php
// Call function via function name:
// Basics:
// A function can also be called by using its string name:
function callbackFunc() {
echo 'Hello World';
}
'callbackFunc'(); // Hello World
// A function can also be called if its name is assigned to a variable:
function callbackFunc() {
echo 'Hello World';
}
$funcName = 'callbackFunc';
$funcName(); // Hello World
// Static class method:
// It is also possible to call a public static class method via 'ClassName::functioName' notation:
class A {
public static function callbackMethod() {
echo "Hello World\n";
}
}
'A::callbackMethod'(); // Hello World
$funcName = 'A::callbackMethod';
$funcName(); // Hello World
// Non static class method:
// It is also possible to call non static class methods by creating an array which first element is the object the method should be called on and the second element is the non static method to be called. The array can directly be used as a caller:
class A {
private $prop = "Hello World\n";
public function callbackMethod() {
echo $this->prop;
}
}
$a = new A;
[$a, 'callbackMethod']();
$funcCallArr = [$a, 'callbackMethod'];
$funcCallArr();
// Of course this also works inside the class with '$this':
class A {
private function privCallback() {
echo 'Private';
}
public function privCallbackCaller($funcName) {
[$this, $funcName]();
}
}
(new A)->privCallbackCaller('privCallback'); // Private
?>@edanschwartz at gmail dot com
You can use ::class property to always indicate the class you're in when using static methods:
<?php
class Foo {
public static function doAwesomeThings() {
FunctionCaller::callIt(self::class . '::someAwesomeMethod');
}
public static function someAwesomeMethod() {
// fantastic code goes here.
}
}
class FunctionCaller {
public static function callIt(callable $func) {
call_user_func($func);
}
}
Foo::doAwesomeThings();
?>Having read this line in the manual above,
"A method of an instantiated object is passed as an array containing an object at index 0 and the method name at index 1. Accessing protected and private methods from within a class is allowed."
I decided to do some testing to see if I could access private methods using the call_user_func methods. Thankfully not, but for completeness here is my test which also covers using static and object contexts
<?php
class foo {
public static $isInstance = false;
public function __construct() {
self::$isInstance = true;
}
public function bar() {
var_dump(self::$isInstance);
echo __METHOD__;
}
private function baz() {
var_dump(self::$isInstance);
echo __METHOD__;
}
public function qux() {
$this->baz();
}
public function quux() {
self::baz();
}
}
call_user_func(['foo','bar']); //fase, foo:bar
call_user_func(['foo','baz']); //warning, cannot access private method
call_user_func(['foo','quux']); //false, foo::baz
call_user_func(['foo','qux']); //fatal, Using $this when not in object context
$foo = new foo;
call_user_func([$foo,'bar']); //true, foo::bar
call_user_func([$foo,'baz']); //warning, cannot access private method
call_user_func([$foo,'qux']); //true, foo::baz
call_user_func(['foo','bar']); //true, foo::bar (static call, yet $isInstance is true)
?>