Chris@0: <?php
Chris@0: namespace Consolidation\AnnotatedCommand\Options;
Chris@0: 
Chris@0: use Consolidation\AnnotatedCommand\AnnotatedCommand;
Chris@0: use Symfony\Component\Console\Application;
Chris@0: use Symfony\Component\Console\Command\Command;
Chris@0: use Symfony\Component\Console\ConsoleEvents;
Chris@0: use Symfony\Component\Console\Event\ConsoleCommandEvent;
Chris@0: use Symfony\Component\EventDispatcher\EventSubscriberInterface;
Chris@0: 
Chris@0: /**
Chris@0:  * AlterOptionsCommandEvent is a subscriber to the Command Event
Chris@0:  * that looks up any additional options (e.g. from an OPTION_HOOK)
Chris@0:  * that should be added to the command.  Options need to be added
Chris@0:  * in two circumstances:
Chris@0:  *
Chris@0:  * 1. When 'help' for the command is called, so that the additional
Chris@0:  *    command options may be listed in the command description.
Chris@0:  *
Chris@0:  * 2. When the command itself is called, so that option validation
Chris@0:  *    may be done.
Chris@0:  *
Chris@0:  * We defer the addition of options until these times so that we
Chris@0:  * do not invoke the option hooks for every command on every run
Chris@0:  * of the program, and so that we do not need to defer the addition
Chris@0:  * of all of the application hooks until after all of the application
Chris@0:  * commands have been added. (Hooks may appear in the same command files
Chris@0:  * as command implementations; applications may support command file
Chris@0:  * plug-ins, and hooks may add options to commands defined in other
Chris@0:  * commandfiles.)
Chris@0:  */
Chris@0: class AlterOptionsCommandEvent implements EventSubscriberInterface
Chris@0: {
Chris@0:     /** var Application */
Chris@0:     protected $application;
Chris@0: 
Chris@0:     public function __construct(Application $application)
Chris@0:     {
Chris@0:         $this->application = $application;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @param ConsoleCommandEvent $event
Chris@0:      */
Chris@0:     public function alterCommandOptions(ConsoleCommandEvent $event)
Chris@0:     {
Chris@0:         /* @var Command $command */
Chris@0:         $command = $event->getCommand();
Chris@0:         $input = $event->getInput();
Chris@0:         if ($command->getName() == 'help') {
Chris@0:             // Symfony 3.x prepares $input for us; Symfony 2.x, on the other
Chris@0:             // hand, passes it in prior to binding with the command definition,
Chris@0:             // so we have to go to a little extra work.  It may be inadvisable
Chris@0:             // to do these steps for commands other than 'help'.
Chris@0:             if (!$input->hasArgument('command_name')) {
Chris@0:                 $command->ignoreValidationErrors();
Chris@0:                 $command->mergeApplicationDefinition();
Chris@0:                 $input->bind($command->getDefinition());
Chris@0:             }
Chris@0: 
Chris@0:             // Symfony Console helpfully swaps 'command_name' and 'command'
Chris@0:             // depending on whether the user entered `help foo` or `--help foo`.
Chris@0:             // One of these is always `help`, and the other is the command we
Chris@0:             // are actually interested in.
Chris@0:             $nameOfCommandToDescribe = $event->getInput()->getArgument('command_name');
Chris@0:             if ($nameOfCommandToDescribe == 'help') {
Chris@0:                 $nameOfCommandToDescribe = $event->getInput()->getArgument('command');
Chris@0:             }
Chris@0:             $commandToDescribe = $this->application->find($nameOfCommandToDescribe);
Chris@0:             $this->findAndAddHookOptions($commandToDescribe);
Chris@0:         } else {
Chris@0:             $this->findAndAddHookOptions($command);
Chris@0:         }
Chris@0:     }
Chris@0: 
Chris@0:     public function findAndAddHookOptions($command)
Chris@0:     {
Chris@0:         if (!$command instanceof AnnotatedCommand) {
Chris@0:             return;
Chris@0:         }
Chris@0:         $command->optionsHook();
Chris@0:     }
Chris@0: 
Chris@0: 
Chris@0:     /**
Chris@0:      * @{@inheritdoc}
Chris@0:      */
Chris@0:     public static function getSubscribedEvents()
Chris@0:     {
Chris@0:         return [ConsoleEvents::COMMAND => 'alterCommandOptions'];
Chris@0:     }
Chris@0: }