| 包 | system.console |
|---|---|
| 继承 | class CHelpCommand » CConsoleCommand » CComponent |
| 源自 | 1.0 |
| 版本 | $Id: CHelpCommand.php 3426 2011-10-25 00:01:09Z alexander.makarow $ |
| 源码 |
CHelpCommand代表控制台帮助命令。
CHelpCommand显示可用的命令列表或者 关于指定命令的帮助指示。
如果要使用这个命令，输入下面的命令行：
CHelpCommand显示可用的命令列表或者 关于指定命令的帮助指示。
如果要使用这个命令，输入下面的命令行：
php path/to/entry_script.php help [command name]在上面，如果没有提供命令名字，它会显示所有 可用的命令。
公共属性
| 属性 | 类型 | 描述 | 定义在 |
|---|---|---|---|
| commandRunner | CConsoleCommandRunner | 命令执行对象的实例 | CConsoleCommand |
| defaultAction | string | 默认动作的名字。 | CConsoleCommand |
| help | string | 提供命令描述。 | CHelpCommand |
| name | string | 命令名字。 | CConsoleCommand |
| optionHelp | array | 提供命令帮助信息选项。 | CConsoleCommand |
公共方法
受保护方法
| 方法 | 描述 | 定义在 |
|---|---|---|
| afterAction() | 这个方法会在一个动作执行完成后发起。 | CConsoleCommand |
| beforeAction() | 这个方法会在一个动作执行前发起。 | CConsoleCommand |
| resolveRequest() | 解析命令行参数然后决定要运行哪个动作。 | CConsoleCommand |
属性详细
help
属性
只读
public string getHelp()
提供命令描述。
方法详细
getHelp()
方法
|
public string getHelp()
| ||
| {return} | string | 命令描述。 |
public function getHelp()
{
return parent::getHelp().' [command-name]';
}
提供命令描述。
run()
方法
|
public void run(array $args)
| ||
| $args | array | 指定给这个命令的命令行参数。 |
public function run($args)
{
$runner=$this->getCommandRunner();
$commands=$runner->commands;
if(isset($args[0]))
$name=strtolower($args[0]);
if(!isset($args[0]) || !isset($commands[$name]))
{
if(!empty($commands))
{
echo "Yii command runner (based on Yii v".Yii::getVersion().")\n";
echo "Usage: ".$runner->getScriptName()." <command-name> [parameters...]\n";
echo "\nThe following commands are available:\n";
$commandNames=array_keys($commands);
sort($commandNames);
echo ' - '.implode("\n - ",$commandNames);
echo "\n\nTo see individual command help, use the following:\n";
echo " ".$runner->getScriptName()." help <command-name>\n";
}
else
{
echo "No available commands.\n";
echo "Please define them under the following directory:\n";
echo "\t".Yii::app()->getCommandPath()."\n";
}
}
else
echo $runner->createCommand($name)->getHelp();
}
执行动作。