README

PHP does not have the option to call a method or instance an object using named parameters. This is a library I use in other projects to simplify the task of create objects based on named parameters.

See PHP RFC: Named Parameters

Instalation

Use composer to install this library composer require eclipxe/construct-named-parameters

Basic use

<?php

class Foo
{
    public function __construct($a, $b, $c, $d) {}
}

$foo = construct_named_parameters(Foo::class, [
    'd' => 123,
    'b' => 'second',
    'a' => 'a argument',
    'c' => false,
    'xtra' => 'baz',
]);

// this will return the result of:
new Foo('a argument', 'second', false, 123);

Why this library exists?

My motivation start in a project that contains a lot of domain objects that need to be instantiated and commonly I had all the information in one single array. This library result very useful in those cases.

It even contains a method that put all parameters and values as lowercase to easily match the constructor requirement. Be aware that in some weird cases a constructor can contain two parameters with the same name but in different case.

How it knows the constructor arguments?

The only way I found is using \Reflection.

The bad is that reflection can be expensive.

The good part is that the function \ConstructNamedParameters\Builder::retrieveArguments has a cache of the name of the class, so, it will only investigate the constructor the first time and the second will use the cached information.

The cache can not be cleaned or forced to reload, and there is no need to do it. A constructor of a class cannot change once it exists, right?

About the public functions:

Public function	Actual calls
`construct_named_parameters`	`\ConstructNamedParameters\Builder::create`
`construct_named_parameters_uncase`	`\ConstructNamedParameters\Builder::createIgnoreCase`
`constructor_arguments`	`\ConstructNamedParameters\Builder::retrieveArguments`

Contributing

Contributions are welcome! Please read CONTRIBUTING for details and don't forget to take a look in the TODO and CHANGELOG files.

eclipxe / construct-named-parameters

Maintainers

Details