dantleech / invoke
Emulate named parameters
Installs: 223 472
Dependents: 9
Suggesters: 0
Security: 0
Stars: 5
Watchers: 2
Forks: 2
Open Issues: 1
Requires
- php: ^7.2||^8.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^2.13
- phpbench/phpbench: ^1.0
- phpstan/phpstan: ^0.12.0
- phpunit/phpunit: ^8.0
README
Utility class to create new classes or invoke methods using named arguments.
PHP does not currently support named parameters, this utility provides a convenient way to emulate them.
Installation
Require with composer:
$ composer require dantleech/invoke
Why
Sometimes arguments may be sourced from arrays e.g. for "deserialization" or instantiating configuration nodes).
Validating the existence of array keys, checking their types etc. is error prone and time consuming.
By using Invoke::new(MyObject::class, $array)
you can map the array keys
directly to the __construct
parameters.
This library will, throw descriptive exceptions:
- If there are extra keys.
- If there are missing required keys (i.e. non-nullable values).
- If the types are wrong.
Performance
Inoke::new(Class::class, [])
is around 50x slower than new Class()
, or
260,000 operations per second vs. ~13,000,000.
+--------------------------+---------+
| subject | mode |
+--------------------------+---------+
| benchInvokeNewClass | 3.720μs |
| benchInstantiateNewClass | 0.076μs |
+--------------------------+---------+
Usage
Instantiate a new class:
<?php use DTL\Invoke\Invoke; class Foobar { public function __construct(string $arg1, string $arg2 = 'val1') { } } $foo = Invoke::new(Foobar::class, [ 'arg1' => 'value1' ]);
Invoke a method:
<?php use DTL\Invoke\Invoke; class Foobar { // ... public function one(string $two) { } } $foo = Invoke::new(Foobar::class, [ 'arg1' => 'value1' ]); $bar= Invoke::method($foo, 'one', [ 'two' => 'bar' ]);
Alternatives
nikolaposa/cascader Utility for creating objects in PHP from constructor parameters definitions.
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.