https://github.com/elie29/zend-di-config
PSR-11 PHP-DI container configurator for Laminas, Mezzio, ZF, Expressive applications or any framework that needs a PSR-11 container
https://github.com/elie29/zend-di-config
container expressive-composer-installer laminas mezzio mezzio-skeleton php-di php-di-container psr-11 zend-expressive zend-expressive-skeleton zend-framework zend-servicemanager
Last synced: 5 months ago
JSON representation
PSR-11 PHP-DI container configurator for Laminas, Mezzio, ZF, Expressive applications or any framework that needs a PSR-11 container
- Host: GitHub
- URL: https://github.com/elie29/zend-di-config
- Owner: elie29
- License: mit
- Created: 2018-04-04T14:41:57.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2025-03-11T13:16:27.000Z (about 1 year ago)
- Last Synced: 2025-03-24T09:38:17.987Z (about 1 year ago)
- Topics: container, expressive-composer-installer, laminas, mezzio, mezzio-skeleton, php-di, php-di-container, psr-11, zend-expressive, zend-expressive-skeleton, zend-framework, zend-servicemanager
- Language: PHP
- Homepage:
- Size: 1.85 MB
- Stars: 19
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# zend-phpdi-config
[](https://github.com/elie29/zend-di-config/)
[](https://coveralls.io/github/elie29/zend-di-config)
[](https://packagist.org/packages/elie29/zend-phpdi-config)
[](https://packagist.org/packages/elie29/zend-phpdi-config)
---
## 🚀 Quick Start
```bash
composer require elie29/zend-phpdi-config
```
```php
[
'services' => [],
'invokables' => [],
'autowires' => [], // A new key added to support PHP-DI autowire technique
'factories' => [],
'aliases' => [],
'delegators' => [],
],
// ... other configuration
// Enable compilation
Config::DI_CACHE_PATH => __DIR__, // Folder path
// Write proxies to file: cf. https://php-di.org/doc/lazy-injection.html
Config::DI_PROXY_PATH => __DIR__, // Folder path
// Disable autowire (enabled by default)
Config::USE_AUTOWIRE => false
// Enable cache
Config::ENABLE_CACHE_DEFINITION => false, // boolean, true if APCu is activated
])
);
```
### Configuration Keys
The `dependencies` configuration array supports the following keys:
- **`services`**: Maps a service name to a specific service instance, class name, or callable.
- Values can be object instances, class names, or callables
- Used for registering pre-instantiated services or simple service definitions
- See [ServicesTest.php](tests/ServicesTest.php) for comprehensive examples
- **`invokables`**: Maps service names to classes with no constructor dependencies.
- Can be an associative array (alias => class name) or indexed array (class names)
- When alias differs from class name, the alias is created automatically
- Classes must have no required constructor parameters
- See [InvokablesTest.php](tests/InvokablesTest.php) for comprehensive examples
- **`autowires`**: Array of fully qualified class names to be autowired by PHP-DI.
- PHP-DI automatically resolves constructor dependencies through type-hinting
- Works with or without constructor parameters
- Create aliases separately in the `aliases` configuration if needed
- **`factories`**: Maps service names to factory classes or callables.
- Factory classes must implement `__invoke(ContainerInterface $container)`
- Can reference other registered factories by name
- Factories must return the actual service instance (object, array, scalar, etc.), not service names
- Used when service instantiation requires custom or dynamic logic
- See [FactoriesTest.php](tests/FactoriesTest.php) for comprehensive examples
- **`aliases`**: Maps alias names to service names or other aliases.
- Allows multiple names to resolve to the same service instance
- Can chain aliases (alias → alias → service)
- Only **`invokables`** create aliases automatically
- **`delegators`**: Maps service names to arrays of delegator factory classes.
- Decorates or wraps services with additional functionality
- Delegators are applied in the order specified
- See [Laminas delegators documentation](https://docs.laminas.dev/laminas-servicemanager/delegators/) for details
> **N.B.:** All configuration except `dependencies` is merged into a `config` key within the `$container`:
>
> ```php
> $config = $container->get('config');
> ```
---
## 💻 CLI Usage
The CLI command `add-autowires-entry` creates the configuration file if it doesn't exist, otherwise it adds the entry
to the autowires key.
Example of adding ConsoleHelper to a config.php:
```console
./vendor/bin/add-autowires-entry config.php "Laminas\\Stdlib\\ConsoleHelper"
[DONE] Changes written to config.php
```
You can also add this as a Composer script:
```json
"scripts": {
"add-autowire": "add-autowires-entry config.php \"My\\Service\\Class\""
}
```
---
## 🧪 Development & Testing
### Running Tests
```bash
# Run tests (no coverage)
composer test
# Run with coverage (requires Xdebug)
composer test-coverage
# Run coverage + serve HTML report
composer cover # Opens localhost:5001
```
### Git Hooks with GrumPHP
This project uses [GrumPHP](https://github.com/phpro/grumphp) to automatically run tests before each commit.
After running `composer install`, GrumPHP will:
- Install git hooks automatically
- Run `composer test` before every commit
- Block commits if tests fail
**Bypass the hook** (not recommended):
```bash
git commit --no-verify -m "Your message"
```
**Configure GrumPHP**: Edit [grumphp.yml](grumphp.yml) to customize tasks and behavior.
---
## 🐞 Troubleshooting / FAQ
**Q: My service is not autowired.**
A: Ensure it is listed in the `autowires` array and all dependencies are available.
**Q: The CLI tool fails with a permissions error.**
A: Make sure the config file directory is writable.
**Q: How do I debug container errors?**
A: Check that all dependencies are correctly defined and that your factories do not throw exceptions.
---
## Using with Mezzio (formerly Expressive)
Replace contents of `config/container.php` with the following:
```php
$this->getDependencies()
];
}
/**
* Returns the container dependencies
*/
public function getDependencies(): array
{
return [
'autowires' => [
UserManager::class
]
];
}
}
```
Where UserManager depends on Mailer as follows:
```php
mailer = $mailer;
}
public function register($email, $password)
{
$this->mailer->mail($email, 'Hello and welcome!');
}
}
class Mailer
{
public function mail($recipient, $content)
{
}
}
```
## Switching back to another container
To switch back to another container is straightforward:
1. Create your factories with `__invoke` function
2. Replace `autowires` key in ConfigProvider by `factories` key, then for each class name attach its correspondent
factory.
## PSR 11 and Interop\Container\ContainerInterface
V4.x supports as well Interop\Container\ContainerInterface
## Migration guides
- [Migration from 3.x to 4.0](docs/migration-4.0.md)
- Migration from 4.x to 5.0: container-interop/container-interop was dropped in favor
of [PSR-11](https://packagist.org/packages/psr/container).
---
## 🤝 Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on how to contribute, run tests, and submit pull requests.
---
## 📄 License
This project is licensed under the MIT License. See [LICENSE](LICENSE) for details.