https://github.com/dotkernel/dot-dependency-injection
Dependency Injection (DI) handler
https://github.com/dotkernel/dot-dependency-injection
Last synced: about 2 months ago
JSON representation
Dependency Injection (DI) handler
- Host: GitHub
- URL: https://github.com/dotkernel/dot-dependency-injection
- Owner: dotkernel
- License: mit
- Created: 2024-06-07T09:45:20.000Z (about 1 year ago)
- Default Branch: 1.0
- Last Pushed: 2025-03-14T15:26:44.000Z (3 months ago)
- Last Synced: 2025-04-09T10:27:13.000Z (3 months ago)
- Language: PHP
- Homepage: https://docs.dotkernel.org/dot-dependency-injection/
- Size: 89.8 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# dot-dependency-injection
`dot-dependency-injection` is Dotkernel's dependency injection service.
By providing reusable factories for service and repository injection, it reduces code complexity in projects.
## Documentation
Documentation is available at: https://docs.dotkernel.org/dot-dependency-injection/.
## Badges
[](https://github.com/dotkernel/dot-dependency-injection/issues)
[](https://github.com/dotkernel/dot-dependency-injection/network)
[](https://github.com/dotkernel/dot-dependency-injection/stargazers)
[](https://github.com/dotkernel/dot-dependency-injection/blob/1.0/LICENSE.md)
[](https://github.com/dotkernel/dot-dependency-injection/actions/workflows/continuous-integration.yml)
[](https://codecov.io/gh/dotkernel/dot-dependency-injection)
[](https://github.com/dotkernel/dot-dependency-injection/actions/workflows/docs-build.yml)
[](https://github.com/dotkernel/dot-dependency-injection/actions/workflows/static-analysis.yml)
## Installation
Install `dot-dependency-injection` by running the following command in your project directory:
```shell
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`):
```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:
```php
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;
```php
#[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;
```php
#[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:
```php
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`.
```php
use Api\App\Entity\Example;
use Doctrine\ORM\EntityRepository;
use Dot\DependencyInjection\Attribute\Entity;
#[Entity(name: Example::class)]
class ExampleRepository extends EntityRepository
{
}
```
> Dependencies injected via the`#[Entity]`/`#[Inject]` attributes are not cached
> Injecting dependencies into property setters are not supported