Yii Framework v1.1.10 类参考
CConsoleCommandRunner
| 包 | system.console |
|---|---|
| 继承 | class CConsoleCommandRunner » CComponent |
| 源自 | 1.0 |
| 版本 | $Id: CConsoleCommandRunner.php 3426 2011-10-25 00:01:09Z alexander.makarow $ |
| 源码 | framework/console/CConsoleCommandRunner.php |
CConsoleCommandRunner管理命令和执行请求的命令。
公共属性
| 属性 | 类型 | 描述 | 定义在 |
|---|---|---|---|
| commands | array | 所有可用的命令列表（命令名字=>命令配置）。
每一个命令配置可以是字符串或者是数组。
如果是前者，字符串应该是类名字或者是这个命令的
class path alias。
如果是后者，数组必须包含着‘class’元素，
这元素指定了命令的类名或者是YiiBase::getPathOfAlias类的路径。
其它的在数组的数组对用来初始化相关的
命令属性。例如，
array(
'email'=>array(
'class'=>'path. |
CConsoleCommandRunner |
| scriptName | string | 入口文件名字 | CConsoleCommandRunner |
公共方法
属性详细
commands
属性
public array $commands;
所有可用的命令列表（命令名字=>命令配置）。 每一个命令配置可以是字符串或者是数组。 如果是前者，字符串应该是类名字或者是这个命令的 class path alias。 如果是后者，数组必须包含着‘class’元素， 这元素指定了命令的类名或者是YiiBase::getPathOfAlias类的路径。 其它的在数组的数组对用来初始化相关的 命令属性。例如，
array(
'email'=>array(
'class'=>'path.to.Mailer',
'interval'=>3600,
),
'log'=>'path.to.LoggerCommand',
)
scriptName
属性
只读
public string getScriptName()
入口文件名字
方法详细
addCommands()
方法
|
public void addCommands(string $path)
| ||
| $path | string | 包含命令类文件的目录别名。 |
源码： framework/console/CConsoleCommandRunner.php#101 (显示)
public function addCommands($path)
{
if(($commands=$this->findCommands($path))!==array())
{
foreach($commands as $name=>$file)
{
if(!isset($this->commands[$name]))
$this->commands[$name]=$file;
}
}
}
从命令路径添加命令。 如果命令已经存在，会忽略新的命令。
createCommand()
方法
|
public CConsoleCommand createCommand(string $name)
| ||
| $name | string | 命令名字（大小写不敏感） |
| {return} | CConsoleCommand | 返回命令对象。如果名字不可用则返回 null。 |
源码： framework/console/CConsoleCommandRunner.php#117 (显示)
public function createCommand($name)
{
$name=strtolower($name);
if(isset($this->commands[$name]))
{
if(is_string($this->commands[$name])) // class file path or alias
{
if(strpos($this->commands[$name],'/')!==false || strpos($this->commands[$name],'\\')!==false)
{
$className=substr(basename($this->commands[$name]),0,-4);
if(!class_exists($className,false))
require_once($this->commands[$name]);
}
else // an alias
$className=Yii::import($this->commands[$name]);
return new $className($name,$this);
}
else // an array configuration
return Yii::createComponent($this->commands[$name],$name,$this);
}
else if($name==='help')
return new CHelpCommand('help',$this);
else
return null;
}
findCommands()
方法
|
public array findCommands(string $path)
| ||
| $path | string | 包含命令类文件的目录。 |
| {return} | array | 命令列表（命令名字＝》命令类文件） |
源码： framework/console/CConsoleCommandRunner.php#81 (显示)
public function findCommands($path)
{
if(($dir=@opendir($path))===false)
return array();
$commands=array();
while(($name=readdir($dir))!==false)
{
$file=$path.DIRECTORY_SEPARATOR.$name;
if(!strcasecmp(substr($name,-11),'Command.php') && is_file($file))
$commands[strtolower(substr($name,0,-11))]=$file;
}
closedir($dir);
return $commands;
}
在指定的目录下面搜索命令。
getScriptName()
方法
|
public string getScriptName()
| ||
| {return} | string | 入口文件名字 |
源码： framework/console/CConsoleCommandRunner.php#71 (显示)
public function getScriptName()
{
return $this->_scriptName;
}
run()
方法
|
public void run(array $args)
| ||
| $args | array | 用户提供参数列表（包含入口文件名字和命令名字）。 |
源码： framework/console/CConsoleCommandRunner.php#50 (显示)
public function run($args)
{
$this->_scriptName=$args[0];
array_shift($args);
if(isset($args[0]))
{
$name=$args[0];
array_shift($args);
}
else
$name='help';
if(($command=$this->createCommand($name))===null)
$command=$this->createCommand('help');
$command->init();
$command->run($args);
}
执行请求命令。