zlikavac32 / symfony-extras
Various extra functionality for Symfony
Requires
- php: ^7.2
Requires (Dev)
- php-ds/php-ds: ^1.2
- phpunit/phpunit: ^7.5.6
- symfony/config: ^4.2
- symfony/console: ^4.2
- symfony/dependency-injection: ^4.2
- symfony/event-dispatcher: ^4.2
- symfony/var-dumper: ^4.2
- zlikavac32/nsb-decorators: ^0.1.0
Suggests
- ext-ds: To use this library at all
- php-ds/php-ds: If you can't install ext-ds
- symfony/config: To use console runnable
- symfony/console: To use console runnable
- symfony/dependency-injection: To use compiler passes
- symfony/event-dispatcher: To use dynamic event dispatcher
- zlikavac32/nsb-decorators: To use decorator proxies
This package is auto-updated.
Last update: 2024-03-29 03:51:24 UTC
README
This repository adds a few extra functionality that I miss in the Symfony components. Functionality is currently only DIC and console related.
Table of contents
Introduction
Idea of this library is to use what you need. No dependency is explicitly required as no code is run by default. It provides few things, like various compiler passes to make a life a bit easier.
Compiler passes are all idempotent.
Installation
Recommended installation is through Composer.
composer require zlikavac32/symfony-extras
Usage
Different concepts exist in this library.
Runnable
symfony/console is a great package, but one can get into trouble when trying to decorate commands. This library defines \Zlikavac32\SymfonyExtras\Command\Runnable\Runnable interface which is then injected into \Zlikavac32\SymfonyExtras\Command\Runnable\RunnableCommand.
DIC compiler pass that automates this is provided in \Zlikavac32\SymfonyExtras\DependencyInjection\Compiler\ConsoleRunnablePass.
Read more about this concept in docs/runnable.md.
Dynamic service decorators and service linker
Symfony provides out of the box service decoration, but it can get messy when there is to much decoration involved. This library offers two compiler passes to tackle that. First is \Zlikavac32\SymfonyExtras\DependencyInjection\Compiler\DecoratorPass and the second is \Zlikavac32\SymfonyExtras\DependencyInjection\Compiler\ServiceLinkerPass.
Idea is to define template services that are decorators, and then tag services that need decoration. Since certain decorators need other services or arguments, service linker is used to link services through tags.
Read more about this concept in docs/dynamic-decorator.md and docs/linker.md.
Dynamic event dispatchers
Symfony provides \Symfony\Component\EventDispatcher\DependencyInjection\RegisterListenersPass to register event dispatchers. Compiler pass that can automate that process is provided in \Zlikavac32\SymfonyExtras\DependencyInjection\Compiler\EventDispatcherPass.
Read more about this concept in docs/dynamic-event-dispatcher.md.
Dynamic composite services
Certain services have composite nature in a sense that they require other services either in their constructor, or through method injection. Symfony provides solution in some degree through tagged service injection. This library provides compiler pass in \Zlikavac32\SymfonyExtras\DependencyInjection\Compiler\DynamicCompositePass that provides a bit more functionality.
Read more about this concept in docs/dynamic-composite.md.
One might say that here is to much magic involved, but if you understand how it all works, there is hardly any magic left.
buildMapOfTagsAndServiceIds()
Method findTaggedServiceIds() on the \Symfony\Component\DependencyInjection\ContainerBuilder finds tags in linear time depending on the number of services, so for M queries and N services, we have N * M operations.
Function buildMapOfTagsAndServiceIds() provided in this repo builds a map of tag names to the sets of service ids that are tagged with them. If we assume access to the hash map is in constant time, now we have N + M operations.
Do note that by not calling findTaggedServiceIds(), method \Symfony\Component\DependencyInjection\ContainerBuilder::findUnusedTags() will return more tags than it should. If you relay on that method, then this library is not for you.
Examples
Check examples folder for examples.