Иногда требуется добавить опцию или аргумент в консольные команды, но прописывать в каждую команду, если их 100+ или это вендорные консольные команды , долго или невозможно. Хорошим решением в данном случае будет использование слушателя событий.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 |
<?php declare(strict_types=1); namespace AppBundle\Listener; use Symfony\Component\Console\Event\ConsoleCommandEvent; use Symfony\Component\Console\Input\ArgvInput; use Symfony\Component\Console\Input\InputDefinition; use Symfony\Component\Console\Input\InputOption; class ConsoleCommandListener { /** * @param ConsoleCommandEvent $event */ public function onConsoleCommand(ConsoleCommandEvent $event): void { // добавление опции в консольную команду $this->addCommandOption($event->getCommand()->getDefinition()); // добавление опции в консольное приложение // без этого опция не будет отображаться в справке, например, cache:clear --help $this->addCommandOption($event->getCommand()->getApplication()->getDefinition()); // объединение опций команды и приложения $event->getCommand()->mergeApplicationDefinition(true); $input = new ArgvInput(); $input->bind($event->getCommand()->getDefinition()); } /** * @param InputDefinition $inputDefinition */ private function addCommandOption(InputDefinition $inputDefinition): void { $inputDefinition->addOption( new InputOption( 'custom_command_option', null, InputOption::VALUE_OPTIONAL, 'Console command option description', null ) ); } } |
Конфигурация сервиса
|
1 2 3 4 5 6 7 8 9 |
app.console_command_listener: class: AppBundle\Listener\ConsoleCommandListener arguments: [] tags: - { name: kernel.event_listener, event: console.command, method: onConsoleCommand } |
Теперь использование опции
|
1 2 3 4 5 |
php bin/console cache:clear --custom_command_option=value |
не вызовет ошибку
|
1 2 3 4 5 |
The "--custom_command_option" option does not exist. |