fmasa / auto-di
Installs: 21 447
Dependents: 0
Suggesters: 0
Security: 0
Stars: 15
Watchers: 3
Forks: 3
Open Issues: 2
Requires
- php: ^7.1
- nette/di: ^3.0
- nette/robot-loader: ^2.4.2 || ^3.0
Requires (Dev)
- nette/bootstrap: ^3.0
- phpunit/phpcov: ^3.0
- phpunit/phpunit: ^5.7
- satooshi/php-coveralls: ^1.0
This package is auto-updated.
Last update: 2024-10-24 02:02:47 UTC
README
fmasa\autoDI
is package intended to make registration and configuration
of services easier.
Future of extension
In Nette 3.0, SearchExtension was introduced.
It builds on the same concept as this extension (in which I stole the concept from Symfony DependencyInjection).
Unfortunately there are still a few problems that need to be fixed in order to fully replace fmasa/auto-di
(i.e. nette/di#215), but it's on the other hand part of Nette DI core and supports several features, that fmasa/auto-di
doesn't (yet).
These are ways to register services implementing specific interface or extending specific class.
So long-term goal is to deprecate this extension in favor of SearchExtension, when (and if) SearchExtension reaches feature parity. Until then I plan to maintain and improve this package since I use it myself in many projects.
Installation
The best way to install fmasa/auto-di is using Composer:
$ composer require fmasa/auto-di
To enable auto registration register extension in your config.neon
:
extensions: autoDI: Fmasa\AutoDI\DI\AutoDIExtension
Pattern based definition
autoDI
registers services defined by regex:
autoDI: services: - class: App\Model\**\*Repository
This registers every class under namespace App\Model
which name ends with Repository
:
- App\Model\Eshop\UserRepository
- App\Model\CMS\Comments\CommentsRepository
There are several simple operators that can be used in patterns:
*
matches class name, one namespace level or part of it (without \)**
matches any part of namespace or classname (including \){Eshop,CMS}
options list, any item of list matches this pattern
Apart from these, any PCRE regular expression can be used.
Classes and generated factories
Package supports both classes and generated factories.
Classes are matched agains class
field, factories againts implement
field,
which corresponds to way Nette use these fields.
When using class
field, all matching interfaces are skipped and vice versa.
autoDI: services: # Repositories - class: App\Model\**\*Repository # Component factories - implement: App\Components\very**\I*Factory
Tags, autowiring, ...
Every option supported in DI (tags, inject, autowiring, ...) is supported with same syntax as normal service registration
autoDI: services: # Repositories - class: App\Model\Subscribers\** tags: [eventBus.subscriber]
The snippet above registers all classes in App\Model\Subscribers
namespace
with eventBus.subscriber
tag.
Exclude services
Sometimes we wan't to exlude certain services from registration. For that we can use exclude
field,
that accepts pattern or list of patterns:
autoDI: services: - class: App\Model\** exclude: App\Model\{Entities,DTO}**
which is same as
autoDI: services: - class: App\Model\** exclude: - App\Model\Entities** - App\Model\DTO**
Already registered services
When extension founds service, that is already registered
(by services
section, different extension or previous autoDI
definition), it's skipped.
This allows manual registration of specific services that need specific configuration.
Defaults section
To specify base configuration for all services registered via autoDI
, defaults
section
can be used:
autoDI: defaults: tags: [ my.auto.service ] services: # these services will have tag my.auto.service - class: App\Model\Repositories\** # these services will have only tag eventBus.subscriber - class: app\Model\Subscribers\** tags: [ eventBus.subscriber ]
Configuring directories
By default extension searches for services in %appDir%
, but other directories can be specified:
autoDI: directories: - %appDir% - %appDir%/../vendor
Register services on configuration
Compiler extensions such as AutoDIExtension manipulates the DI container in two phases (configuration loading and before compilation). By default this extension registers all services before compilation. This may not be optimal if you wan't to use this extension with other extensions such as decorator.
You can enforce registration in configuration phase
by setting registerOnConfiguration
option to true.
When no service is registered for configuration entry, either because no class/interface
matches the pattern or all matched services were already registered in container, exception
is thrown. This check can be disabled by setting errorOnNotMatchedDefinitions
option to false.