Symfony控制台 - 显示没有参数的命令的帮助

时间:2016-02-04 13:51:16

标签: php symfony symfony-console

我正在开发一个非常简单的Symfony控制台应用程序。它只有一个带有一个参数的命令,还有一些选项。

我按照this guide创建了Application类的扩展名。

这是应用程序的正常用法,它运行正常:
php application <argument>

这也很好(带选项的参数):
php application.php <argument> --some-option

如果有人在没有任何参数或选项的情况下运行php application.php,我希望它像用户运行php application.php --help一样运行。

我确实有一个可行的解决方案,但它不是最佳的,可能会略微脆弱。在我的扩展Application课程中,我按如下方式覆盖了run()方法:

/**
 * Override parent method so that --help options is used when app is called with no arguments or options
 *
 * @param InputInterface|null $input
 * @param OutputInterface|null $output
 * @return int
 * @throws \Exception
 */
public function run(InputInterface $input = null, OutputInterface $output = null)
{
    if ($input === null) {
        if (count($_SERVER["argv"]) <= 1) {
            $args = array_merge($_SERVER["argv"], ["--help"]);
            $input = new ArgvInput($args);
        }
    }
    return parent::run($input, $output);
}

默认情况下,使用null Application::run()调用InputInterface,所以在这里我想我可以检查参数的原始值并强制添加一个帮助选项以传递给父方法。 / p>

有没有更好的方法来实现这一目标?

2 个答案:

答案 0 :(得分:5)

我设法制定了一个根本不涉及Application课程的解决方案。要从另一个命令中调用help命令:

/**
 * @param InputInterface $input
 * @param OutputInterface $output
 * @return int
 * @throws \Symfony\Component\Console\Exception\ExceptionInterface
 */
protected function outputHelp(InputInterface $input, OutputInterface $output)
{
    $help = new HelpCommand();
    $help->setCommand($this);
    return $help->run($input, $output);
}

答案 1 :(得分:1)

要根据命令执行特定操作,您可以使用在EventListener被触发时调用的onConsoleCommand

监听器类的工作方式如下:

<?php

namespace AppBundle\EventListener;

use Symfony\Component\Console\Event\ConsoleCommandEvent;
use Symfony\Component\Console\Command\HelpCommand;

class ConsoleEventListener
{
    public function onConsoleCommand(ConsoleCommandEvent $event)
    {
        $application = $event->getCommand()->getApplication();
        $inputDefinition = $application->getDefinition();

        if ($inputDefinition->getArgumentCount() < 2) {
            $help = new HelpCommand();
            $help->setCommand($event->getCommand());

            return $help->run($event->getInput(), $event->getOutput());
        }
    }
}

服务声明:

services:
     # ...
     app.console_event_listener:
         class: AppBundle\EventListener\ConsoleEventListener
         tags:
             - { name: kernel.event_listener, event: console.command, method: onConsoleCommand }