I'm not sure if it's realted to the original issue. But at the moment it's not easy to add application wide options to the commands. I have a use case where I need to add some global options to all commands, splitted in various listeners, and I'm having a hard time.

I think the command needs one more event :

An event dispatched before the "mergeApplicationDefinition" and "bind" methods are called, for example an event "ConsoleEvents::DEFINITION". This event is here to allow us to modify/add/remove some of the command defined options/arguments.
The actual "ConsoleEvents::COMMAND" is dispatched and allow us to set/work with the real input values.
Exception and terminate events as it's already done.

What do you think of this ?

ATM I've found a workaroung like this :

<?php

namespace AppBundle\EventListener;

use Symfony\Component\Console\ConsoleEvents;
use Symfony\Component\Console\Event\ConsoleCommandEvent;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;

class CommandEventListener implements EventSubscriberInterface
{
    /**
     * Returns an array of events this subscriber wants to listen to.
     *
     * @return array
     */
    public static function getSubscribedEvents()
    {
        return [
            ConsoleEvents::COMMAND => [
                // Adding options there. Must be called early.
                ['onCommandRunEarly', 2051],
                // Reading option values here. Must be called after.
                ['onCommandRunLately', 2050],
            ],
        ];
    }

    /**
     * On early command run event.
     *
     * Add an option "--without-indexation".
     *
     * @param ConsoleCommandEvent $event
     */
    public function onCommandRunEarly(ConsoleCommandEvent $event)
    {
        $definition = $event->getCommand()->getDefinition();

        // Add the --without-indexation option.
        $definition->addOption(new InputOption('without-indexation', 'wi', InputOption::VALUE_OPTIONAL, 'Disable indexation temporary.'));

        // Refresh definition of the command for later use.
        $event->getCommand()->setDefinition($definition);
        $event->getCommand()->mergeApplicationDefinition(false);
    }

    /**
     * On lately command run event.
     *
     * Reads the option "--without-indexation" value to disable indexation while migrating data.
     *
     * @param ConsoleCommandEvent $event
     */
    public function onCommandRunLately(ConsoleCommandEvent $event)
    {
        // Add the --without-indexation option.
        $definition = $event->getCommand()->getDefinition();
        $input = $event->getInput();
        $input->bind($definition);

        // Disable indexing if asked.
        if ($definition->hasOption('without-indexation') && $input->hasOption('without-indexation')) {
            // DO HERE YOUR PROCESSING.
        }
    }
}

<?php

namespace AppBundle\EventListener;

use Symfony\Component\Console\ConsoleEvents;
use Symfony\Component\Console\Event\ConsoleCommandEvent;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
use Symfony\Component\HttpKernel\Event\GetResponseEvent;
use Symfony\Component\HttpKernel\KernelEvents;

class OtherEventListener implements EventSubscriberInterface
{
    /**
     * Returns an array of events this subscriber wants to listen to.
     *
     * @return array
     */
    public static function getSubscribedEvents()
    {
        return [
            ConsoleEvents::COMMAND => [
                // Adding options there. Must be called early.
                ['onCommandRunEarly', 2051],
                // Reading option values here. Must be called after.
                ['onCommandRunLately', 2050],
            ],
        ];
    }

    /**
     * On early command run event.
     *
     * Add an option "--subdomain" which allow to chose on which tenant database to act.
     * Add an option "--tenant" which allow to chose on which tenant database to act.
     *
     * @param ConsoleCommandEvent $event
     */
    public function onCommandRunEarly(ConsoleCommandEvent $event)
    {
        // Adding a global option to be able to specify the subdomain.
        $definition = $event->getCommand()->getDefinition();

        $definition->addOption(new InputOption('subdomain', 'sub', InputOption::VALUE_OPTIONAL, 'The subdomain on which throwing the command.'));
        $definition->addOption(new InputOption('tenant', 't', InputOption::VALUE_OPTIONAL, 'The tenant id on which throwing the command.'));

        // Refresh definition of the command for later use.
        $event->getCommand()->setDefinition($definition);
        $event->getCommand()->mergeApplicationDefinition(false);
    }

    /**
     * On lately command run event.
     *
     * Analyze subdomain and tenant options and select the proper tenant database.
     *
     * @param ConsoleCommandEvent $event
     *
     * @throws \Exception
     */
    public function onCommandRunLately(ConsoleCommandEvent $event)
    {
        $command = $event->getCommand();
        $definition = $command->getDefinition();
        $input = $event->getInput();
        $input->bind($definition);

       // DO HERE YOUR PROCESSING
       if ($definition->hasOption('tenant') && $tenant = $input->getOption('tenant')) {
            // DO HERE YOUR PROCESSING.
        }
    }
}

Moreover, the "parseShortOptionSet" method seems buggy and does throw an error for a custom alias of mine "wi" (so I'm forced to defined two aliases, "w|wi"):

private function parseShortOptionSet($name)
{
        $len = strlen($name);
        for ($i = 0; $i < $len; ++$i) {
            if (!$this->definition->hasShortcut($name[$i])) { /* Why $name[$i]; ? */
                throw new RuntimeException(sprintf('The "-%s" option does not exist.', $name[$i]));
            }
            ...
        }
}

Uh oh!

Input values setted by console.command event are cleared #19441

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions