php - yii 控制台命令自定义帮助信息

Question

我在我的 yii 支持的项目中创建了文件 commands/TestCommand.php:

class TestCommand extends CConsoleCommand
{
    public function actionIndex()
    {
        echo "Hello World!\n";
    }
}

它通过 yiic 变得可见:

Yii command runner (based on Yii v1.1.14)
Usage: yiic.php <command-name> [parameters...]

The following commands are available:
 - message
 - migrate
 - shell
 - test     <<<
 - webapp

To see individual command help, use the following:
   yiic.php help <command-name>

如果我试图获取有关此控制台命令的一些帮助信息:

php yiic.php help test

我看到默认文本:

Usage: yiic.php test index

如何编写将显示我的帮助信息的 TestCommand 类？它是返回帮助文本的某些公共(public)字段还是特殊方法？我需要这样的东西:

php yiic.php help webapp

我需要的结果:

USAGE
  yiic webapp <app-path> [<vcs>]

DESCRIPTION
  This command generates an Yii Web Application at the specified location.

PARAMETERS
 * app-path: required, the directory where the new application will be created.
   If the directory does not exist, it will be created. After the application
   is created, please make sure the directory can be accessed by Web users.
 * vcs: optional, version control system you're going to use in the new project.
   Application generator will create all needed files to the specified VCS
   (such as .gitignore, .gitkeep, etc.). Possible values: git, hg. Do not
   use this argument if you're going to create VCS files yourself.

Answer 1

您可以覆盖默认的 getHelp 方法来实现您的帮助!

它必须返回一个字符串，即帮助文本。

Provides the command description. This method may be overridden to return the actual command description.

这是默认方法:

public function getHelp()
{
    $help='Usage: '.$this->getCommandRunner()->getScriptName().' '.$this->getName();
    $options=$this->getOptionHelp();
    if(empty($options))
        return $help."\n";
    if(count($options)===1)
        return $help.' '.$options[0]."\n";
    $help.=" <action>\nActions:\n";
    foreach($options as $option)
        $help.='    '.$option."\n";
    return $help;
}

您还可以覆盖 getHelp 中调用的默认 getOptionHelp 方法

Provides the command option help information. The default implementation will return all available actions together with their corresponding option information.

Source