Symfony 控制台 - 显示不带参数的命令的帮助

Question

我正在开发一个非常简单的 Symfony 控制台应用程序。它只有一个命令和一个参数，以及几个选项。

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

这是该应用程序的正常用法，并且运行良好：
php application <argument>

这也可以正常工作（带选项的参数）：
php application.php <argument> --some-option

如果某人运行s php application.php 没有任何参数或选项，我希望它运行就好像用户有运行 php application.php --help。

我确实有一个可行的解决方案，但它不是最优的，而且可能有点脆弱。在我的扩展 Application class 中，我覆盖了 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);
}

默认情况下，Application::run() 是用空 InputInterface 调用的，所以在这里我想我可以只检查参数的原始值并强行添加一个帮助选项以传递给父方法.

有没有更好的方法来实现这个？

Answer 1

我想出了一个完全不涉及 Application class 的解决方案。从另一个命令中调用帮助命令：

/**
 * @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);
}

Answer 2

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

侦听器 class 应按如下方式工作：

<?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 }

Symfony 控制台 - 显示不带参数的命令的帮助

Symfony console - displaying help for command with no arguments

php

symfony

symfony-console