This package provides abstract object factory allowing to create objects by given definition with dependencies resolved by a PSR-11 container.
- PHP 7.4 or higher.
The package could be installed with composer:
composer require yiisoft/definitions --prefer-distThe factory is useful if you need to create objects using definition syntax and/or want to configure defaults for objects created.
$container = new PSR11DependencyInjectionContainer();
$factoryConfig = [
EngineInterface::class => [
'class' => EngineMarkOne::class,
'__construct()' => [
'power' => 42,
],
]
];
$factory = new Factory($container, $factoryConfig);
$one = $factory->create(EngineInterface::class);
$two = $factory->create(EngineInterface::class, [
'__construct()' => [
'power' => 146,
],
]);In the code above we define factory config specifying that when we need EngineInterface, an instance of EngineMarkOne
will be created with power constructor argument equals to 42. We also specify that all the dependencies requested by
the object created should be resolved by PSR11DependencyInjectionContainer.
First call to create() uses default configuration of EngineInterface as is. Second call specifies custom
configuration for power constructor argument. In this case, configuration specified is merged with default
configuration overriding its keys when the key name is the same.
By default, the factory validates definitions right when they are set. In production environment, it makes sense to
turn it off by passing false as a third constructor argument:
$factory = new Factory($container, $factoryConfig, false);The package is tested with PHPUnit. To run tests:
./vendor/bin/phpunitThe package tests are checked with Infection mutation framework. To run it:
./vendor/bin/infectionThe code is statically analyzed with Psalm. To run static analysis:
./vendor/bin/psalmThe Yii Factory is free software. It is released under the terms of the BSD License.
Please see LICENSE for more information.
Maintained by Yii Software.
