Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/olvlvl/symfony-dependency-injection-proxy
Generate super tiny proxies for Symfony's dependency injection
https://github.com/olvlvl/symfony-dependency-injection-proxy
dependency-injection proxy
Last synced: 23 days ago
JSON representation
Generate super tiny proxies for Symfony's dependency injection
- Host: GitHub
- URL: https://github.com/olvlvl/symfony-dependency-injection-proxy
- Owner: olvlvl
- License: other
- Created: 2018-10-14T13:48:27.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-11-02T22:36:24.000Z (3 months ago)
- Last Synced: 2024-12-02T12:57:39.507Z (about 2 months ago)
- Topics: dependency-injection, proxy
- Language: PHP
- Size: 71.3 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Proxy generator for Symfony's DIC
[](https://packagist.org/packages/olvlvl/symfony-dependency-injection-proxy)
[](https://packagist.org/packages/olvlvl/symfony-dependency-injection-proxy)
[](https://scrutinizer-ci.com/g/olvlvl/symfony-dependency-injection-proxy)
[](https://coveralls.io/r/olvlvl/symfony-dependency-injection-proxy)
This package provides a proxy generator for [Symfony's dependency injection component][1] that
generates super tiny, super simple proxies, especially when [compared to Symfony's default
implementation][2]. Here are some differences:
- Can proxy `final` classes.
- Can only proxy classes with interfaces.
- The generated proxies are self-contained.
- The package is ~10Kb and doesn't have dependencies.
- The package can be removed once the proxies have been generated.
If you're not familiar with proxy services, better have a look at [Symfony's documentation][3]
before going any further.
#### Installation
```bash
composer require olvlvl/symfony-dependency-injection-proxy
```
## How it works
The generator works with the following assumptions: the service we want to proxy implements an
interface, and services using that service expect that interface, following the [dependency
inversion principle][4]. Now, consider the following code, where an `ExceptionHandler` service
requires a logger implementing `LoggerInterface`:
```php
the same, except we would have to define `class` for the factory
one.
Now let's see how to build our container.
## Building the dependency injection container
The following code demonstrates how to build, compile, and dump a container:
```php
compile();
$dumper = new PhpDumper($builder);
$dumper->setProxyDumper(new ProxyDumper());
/* @var string $containerFile */
file_put_contents($containerFile, $dumper->dump());
```
There you have it. We can use our container as usual and everything is awesome.
### What if my lazy service implements multiple interfaces?
The basic interface resolver will have a hard time figuring out which interface to implement if a
service implements many. For instance, if a service was an instance of `ArrayObject` the following
exception would be thrown:
```
Don't know which interface to choose from for ArrayObject: IteratorAggregate, Traversable, ArrayAccess, Serializable, Countable.
```
We can specify the interface to implement using the `lazy` attribute:
```yaml
ArrayObject:
lazy: ArrayAccess
```
----------
## Continuous Integration
The project is continuously tested by [GitHub actions](https://github.com/olvlvl/symfony-dependency-injection-proxy/actions).
[](https://github.com/olvlvl/symfony-dependency-injection-proxy/actions?query=workflow%3Atest)
[](https://github.com/olvlvl/symfony-dependency-injection-proxy/actions?query=workflow%3Astatic-analysis)
[](https://github.com/olvlvl/symfony-dependency-injection-proxy/actions?query=workflow%3Acode-style)
## Code of Conduct
This project adheres to a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in
this project and its community, you are expected to uphold this code.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## License
**olvlvl/symfony-dependency-injection-proxy** is released under the [BSD-3-Clause](LICENSE).
[1]: https://symfony.com/doc/current/components/dependency_injection.html
[2]: https://github.com/olvlvl/symfony-dependency-injection-proxy/wiki/Comparison
[3]: https://symfony.com/doc/current/service_container/lazy_services.html
[4]: https://en.wikipedia.org/wiki/Dependency_inversion_principle