ReflectionMethod::invokeArgs

(PHP 5 >= 5.1.2, PHP 7, PHP 8)

ReflectionMethod::invokeArgs — Invoke args

Beschreibung

public ReflectionMethod::invokeArgs(?object $object, array $args): mixed

Invokes the reflected method and pass its arguments as array.

Parameter-Liste

object: The object to invoke the method on. In case of static methods, you can pass null to this parameter.
args: The parameters to be passed to the function, as an array.

Rückgabewerte

Returns the method result.

Fehler/Exceptions

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.

Changelog

Version	Beschreibung
8.0.0	`args` keys will now be interpreted as parameter names, instead of being silently ignored.

Beispiele

Beispiel #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'));
?>

Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

Hello Mike

Anmerkungen

Hinweis:
Wenn die Funktion einige Argumente per Referenz akzeptiert, so müssen diese als Referenzen in die Argument-Liste gegeben werden.

Siehe auch

ReflectionMethod::invoke() - Invoke
__invoke()
call_user_func_array() - Call a callback with an array of parameters

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 4 notes

down

serg dot smertin at gmail dot com ¶

14 years ago

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);

      }

?>

down

agent_harris at secure-mail dot biz ¶

13 years ago

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.

down

CodeCoutureXX at gmail dot com ¶

9 years ago

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:

19

down

cweiske at cweiske dot de ¶

13 years ago

Passing arguments by reference works:
<?php $rm->invokeArgs($object, array(&$foo, $bar)); ?>

＋add a note