(PHP 5 >= 5.1.2, PHP 7, PHP 8)
ReflectionMethod::invokeArgs — Invoke args
Invokes the reflected method and pass its arguments as array.
Returns the method result.
A ReflectionException if the object
parameter does not contain an instance of the class that this method was declared in.
A ReflectionException if the method invocation failed.
| Version | Description |
|---|---|
| 8.0.0 |
args keys will now be interpreted as parameter names, instead of being silently ignored.
|
Example #1 ReflectionMethod::invokeArgs() example
<?php
class HelloWorld {
public function sayHelloTo($name) {
return 'Hello ' . $name;
}
}
$reflectionMethod = new ReflectionMethod('HelloWorld', 'sayHelloTo');
echo $reflectionMethod->invokeArgs(new HelloWorld(), array('Mike'));
?>The above example will output:
Hello Mike
Note:
If the function has arguments that need to be references, then they must be references in the passed argument list.
We can do black magic, which is useful in templating block calls:
<?php
$object->__named('methodNameHere', array('arg3' => 'three', 'arg1' => 'one'));
...
/**
* Pass method arguments by name
*
* @param string $method
* @param array $args
* @return mixed
*/
public function __named($method, array $args = array())
{
$reflection = new ReflectionMethod($this, $method);
$pass = array();
foreach($reflection->getParameters() as $param)
{
/* @var $param ReflectionParameter */
if(isset($args[$param->getName()]))
{
$pass[] = $args[$param->getName()];
}
else
{
$pass[] = $param->getDefaultValue();
}
}
return $reflection->invokeArgs($this, $pass);
}
?>There is a simple workaround for the reference passing problem:
Since the reflection api has to handle all parameters in a generic way it has no chance to guess if you wish to pass data per value or reference.
But it seems that you can also decide to pass a reference from where you call the function or method (not just only by the ampersand prefix in its declaration).
So just do the following; which worked for me:
<?php
//...
$method->invoke($object, $inputValue, &$outputValue);
?>
Since this will only be necessary with arrays and primitive data types it should be acceptable in most cases to know in advance if you need to pass per reference. But it is probably although necessary to keep the ampersand always in the declaration (because of the at least two layers between the actual function and your invoke call).
If this is the expected behavior it will maybe make sense to mention it in the documentation for invoke and invokeArgs.If you need to call ReflectionMethod::invokeArgs() on a static function you can pass NULL in for the $object parameter.
Example:
<?php
class myClass {
public static myStaticFunc($a, $b) {
return $a + $b;
}
}
$ref = new ReflectionMethod('myClass', 'myStaticFunc');
echo $ref->invokeArgs(NULL, [12, 7]);
?>
produces the following output:
19Passing arguments by reference works:
<?php $rm->invokeArgs($object, array(&$foo, $bar)); ?>