yiisoft / factory
Yii Factory
Fund package maintenance!
Opencollective
yiisoft
Installs: 357 398
Dependents: 33
Suggesters: 1
Security: 0
Stars: 34
Watchers: 19
Forks: 14
Open Issues: 5
Requires
- php: ^8.0
- psr/container: ^1.0|^2.0
- yiisoft/definitions: ^1.0|^2.0|^3.0.1
Requires (Dev)
- maglnet/composer-require-checker: ^4.2
- phpunit/phpunit: ^9.5
- rector/rector: ^0.18.0
- roave/infection-static-analysis-plugin: ^1.16
- spatie/phpunit-watcher: ^1.23
- vimeo/psalm: ^4.30|^5.4
- yiisoft/test-support: ^1.3
This package is auto-updated.
Last update: 2024-11-01 08:24:32 UTC
README
Yii Factory
This package provides abstract object factory allowing to create objects by given definition with dependencies resolved by a PSR-11 container.
Requirements
- PHP 8.0 or higher.
Installation
The package could be installed with Composer:
composer require yiisoft/factory
General usage
The 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([ 'class' => 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.
Tuning for production
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);
Documentation
If you need help or have a question, the Yii Forum is a good place for that. You may also check out other Yii Community Resources.
License
The 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.