rybakit / arguments-resolver
ArgumentsResolver allows you to determine the arguments to pass to a function or method.
Fund package maintenance!
rybakit
Installs: 89 074
Dependents: 11
Suggesters: 1
Security: 0
Stars: 26
Watchers: 5
Forks: 1
Open Issues: 0
Requires
- php: ^7.1|^8
Requires (Dev)
- friendsofphp/php-cs-fixer: ^2.13
- phpunit/phpunit: ^7.1|^8|^9
README
ArgumentsResolver allows you to determine the arguments to pass to a function or method.
Installation
The recommended way to install ArgumentsResolver is through Composer:
composer require rybakit/arguments-resolver
Usage example
use ArgumentsResolver\InDepthArgumentsResolver; $greet = function ($username, DateTime $date, $greeting = 'Hello %s!') { // ... }; $parameters = [ 'Welcome %s!', ['foo'], new DateTime(), 'username' => 'Stranger', 'bar', ]; $arguments = (new InDepthArgumentsResolver($greet))->resolve($parameters); print_r($arguments);
The above example will output:
Array ( [0] => Stranger [1] => DateTime Object (...) [2] => Welcome %s! )
Resolvers
The library ships with two resolvers, the InDepthArgumentsResolver and NamedArgumentsResolver. They both expect a function to be supplied as a single constructor argument. The function can be any callable, a string representing a class method or an instance of ReflectionFunctionAbstract:
new InDepthArgumentsResolver(['MyClass', 'myMethod']); new InDepthArgumentsResolver([new MyClass(), 'myMethod']); new InDepthArgumentsResolver(['MyClass', 'myStaticMethod']); new InDepthArgumentsResolver('MyClass::myStaticMethod'); new InDepthArgumentsResolver('MyClass::__construct'); new InDepthArgumentsResolver(['MyClass', '__construct']); new InDepthArgumentsResolver(new MyInvokableClass()); new InDepthArgumentsResolver(function ($foo) {}); new InDepthArgumentsResolver('MyNamespace\my_function'); new InDepthArgumentsResolver(new ReflectionMethod('MyClass', 'myMethod')); new InDepthArgumentsResolver(new ReflectionFunction('MyNamespace\my_function'));
There is also an utility class which helps in creating a reflection instance:
use ArgumentsResolver\ReflectionFactory; $reflection = ReflectionFactory::create('MyClass::__construct'); $resolver = new InDepthArgumentsResolver($reflection);
InDepthArgumentsResolver
In the InDepthArgumentsResolver
, the decision about whether an argument matched the parameter value or not
is influenced by multiple factors, namely the argument's type, the class hierarchy (if it's an object),
the argument name and the argument position.
To clarify, consider each circumstance in turn:
Argument type
function foo(array $array, stdClass $object, callable $callable) {} (new InDepthArgumentsResolver('foo'))->resolve([ ... function () {}, // $callable ... new stdClass(), // $object ... [42], // $array ... ]);
Class hierarchy
function foo(Exception $e, RuntimeException $re) {} (new InDepthArgumentsResolver('foo'))->resolve([ ... new RuntimeException(), // $re ... new Exception(), // $e ... ]);
Argument name
function foo($a, $b) {} (new InDepthArgumentsResolver('foo'))->resolve([ ... 'c' => 3, 'b' => 2, // $b 'a' => 1, // $a ... ]);
Argument position
function foo($a, $b) {} (new InDepthArgumentsResolver('foo'))->resolve([ 1, // $a 2, // $b ... ]);
NamedArgumentsResolver
The NamedArgumentsResolver
is a very simple resolver which does the matching only by the argument name.
Therefore this requires parameters to be an associative array:
function foo($a, array $b, $c = null) {} (new NamedArgumentsResolver('foo'))->resolve([ ... 'b' => [], // $b 'a' => 1, // $a 'c' => 'bar', // $c ... ]);
Tests
ArgumentsResolver uses PHPUnit for unit testing. In order to run the tests, you'll first need to setup the test suite using composer:
composer install
You can then run the tests:
vendor/bin/phpunit
License
ArgumentsResolver is released under the MIT License. See the bundled LICENSE file for details.