dotkernel / dot-dependency-injection
DotKernel dependency injection component using class attributes.
Installs: 3 339
Dependents: 3
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Requires
- php: ~8.2.0 || ~8.3.0
- doctrine/orm: ^2.9 || ^3.0
- psr/container: ^1.0 || ^2.0
Requires (Dev)
- laminas/laminas-coding-standard: ^2.5
- phpunit/phpunit: ^10.5
- vimeo/psalm: ^5.20
This package is auto-updated.
Last update: 2024-09-07 12:56:13 UTC
README
DotKernel dependency injection service.
This package can clean up your code, by getting rid of all the factories you write, sometimes just to inject a dependency or two.
Installation
Install dot-dependency-injection
by running the following command in your project directory:
composer require dotkernel/dot-dependency-injection
After installing, register dot-dependency-injection
in your project by adding the below line to your configuration
aggregate (usually: config/config.php
):
Dot\DependencyInjection\ConfigProvider::class,
Usage
Using the AttributedServiceFactory
You can register services in the service manager using AttributedServiceFactory
as seen in the below example:
return [
'factories' => [
ServiceClass::class => AttributedServiceFactory::class,
],
];
NOTE
You can use only the fully qualified class name as the service key
The next step is to add the #[Inject]
attribute to the service constructor with the service FQCNs to inject:
use Dot\DependencyInjection\Attribute\Inject;
#[Inject(
App\Srevice\Dependency1::class,
App\Srevice\Dependency2::class,
"config",
)]
public function __construct(
protected App\Srevice\Dependency1 $dep1,
protected App\Srevice\Dependency2 $dep2,
protected array $config
) {
}
The #[Inject]
attribute is telling AttributedServiceFactory
to inject the services specified as parameters.
Valid service names should be provided, as registered in the service manager.
To inject an array value from the service manager, you can use dot notation as below
use Dot\DependencyInjection\Attribute\Inject;
#[Inject(
"config.debug",
)]
which will inject $container->get('config')['debug'];
.
NOTE
Even if using dot notation,
AttributedServiceFactory
will check first if a service name exists with that name.
Using the AttributedRepositoryFactory
You can register doctrine repositories and inject them using the AttributedRepositoryFactory
as below:
return [
'factories' => [
ExampleRepository::class => AttributedRepositoryFactory::class,
],
];
The next step is to add the #[Entity]
attribute in the repository class.
The name
field has to be the fully qualified class name.
Every repository should extend Doctrine\ORM\EntityRepository
.
use Api\App\Entity\Example;
use Doctrine\ORM\EntityRepository;
use Dot\DependencyInjection\Attribute\Entity;
#[Entity(name: Example::class)]
class ExampleRepository extends EntityRepository
{
}
NOTE
- dependencies injected via the
#[Entity]
/#[Inject]
attributes are not cached - injecting dependencies into property setters are not supported