ThinkPHP5


think\Console
library\think\Console.php at line 21

Class Console

Console

public class Console


Constructor Summary
void

__construct(str name, str version)

Method Summary
static void

init(bool run)

static Output|Buffer

call(array parameters, mixed command)

int

run()

执行当前的指令

int

doRun(Input input, Output output)

执行指令

void

setDefinition(InputDefinition definition)

设置输入参数定义

InputDefinition

getDefinition()

获取输入参数定义

string

getHelp()

Gets the help message.

void

setCatchExceptions(bool boolean)

是否捕获异常

void

setAutoExit(bool boolean)

是否自动退出

string

getName()

获取名称

void

setName(string name)

设置名称

string

getVersion()

获取版本

void

setVersion(string version)

设置版本

string

getLongVersion()

获取完整的版本号

Command

register(string name)

注册一个指令

void

addCommands(Command commands)

添加指令

Command

add(Command command)

添加一个指令

Command

get(string name)

获取指令

bool

has(string name)

某个指令是否存在

array

getNamespaces()

获取所有的命名空间

string

findNamespace(string namespace)

查找注册命名空间中的名称或缩写。

Command

find(string name)

查找指令

Command[]

all(string namespace)

获取所有的指令

static array

getAbbreviations(array names)

获取可能的指令名

protected void

configureIO(Input input, Output output)

配置基于用户的参数和选项的输入和输出实例。

protected int

doRunCommand(Command command, Input input, Output output)

执行指令

protected string

getCommandName(Input input)

获取指令的基础名称

protected InputDefinition

getDefaultInputDefinition()

获取默认输入定义

protected Command[]

getDefaultCommands()

设置默认命令

static void

addDefaultCommands(mixed classnames)

string

extractNamespace(string name, string limit)

返回命名空间部分

void

setDefaultCommand(string commandName)

设置默认的指令

Constructor Detail

library\think\Console.php at line 39

__construct

public void __construct(str name, str version)

Method Detail

library\think\Console.php at line 52

init

public static void init(bool run)

library\think\Console.php at line 84

call

public static Output|Buffer call(array parameters, mixed command)


library\think\Console.php at line 105

run

public int run()

执行当前的指令

Throws:
\Exception
Api.

library\think\Console.php at line 149

doRun

public int doRun(Input input, Output output)

执行指令


library\think\Console.php at line 184

setDefinition

public void setDefinition(InputDefinition definition)

设置输入参数定义


library\think\Console.php at line 193

getDefinition

public InputDefinition getDefinition()

获取输入参数定义

Returns:
The InputDefinition instance

library\think\Console.php at line 202

getHelp

public string getHelp()

Gets the help message.

Returns:
A help message.

library\think\Console.php at line 212

setCatchExceptions

public void setCatchExceptions(bool boolean)

是否捕获异常

Api.

library\think\Console.php at line 222

setAutoExit

public void setAutoExit(bool boolean)

是否自动退出

Api.

library\think\Console.php at line 231

getName

public string getName()

获取名称


library\think\Console.php at line 240

setName

public void setName(string name)

设置名称


library\think\Console.php at line 250

getVersion

public string getVersion()

获取版本

Api.

library\think\Console.php at line 259

setVersion

public void setVersion(string version)

设置版本


library\think\Console.php at line 268

getLongVersion

public string getLongVersion()

获取完整的版本号


library\think\Console.php at line 282

register

public Command register(string name)

注册一个指令


library\think\Console.php at line 291

addCommands

public void addCommands(Command commands)

添加指令


library\think\Console.php at line 303

add

public Command add(Command command)

添加一个指令


library\think\Console.php at line 331

get

public Command get(string name)

获取指令

Parameters:
name - 指令名称
Throws:
\InvalidArgumentException

library\think\Console.php at line 357

has

public bool has(string name)

某个指令是否存在

Parameters:
name - 指令名称

library\think\Console.php at line 366

getNamespaces

public array getNamespaces()

获取所有的命名空间


library\think\Console.php at line 386

findNamespace

public string findNamespace(string namespace)

查找注册命名空间中的名称或缩写。

Throws:
\InvalidArgumentException

library\think\Console.php at line 424

find

public Command find(string name)

查找指令

Parameters:
name - 名称或者别名
Throws:
\InvalidArgumentException

library\think\Console.php at line 476

all

public Command[] all(string namespace)

获取所有的指令

Parameters:
namespace - 命名空间
Api.

library\think\Console.php at line 497

getAbbreviations

public static array getAbbreviations(array names)

获取可能的指令名


library\think\Console.php at line 515

configureIO

protected void configureIO(Input input, Output output)

配置基于用户的参数和选项的输入和输出实例。

Parameters:
input - 输入实例
output - 输出实例

library\think\Console.php at line 548

doRunCommand

protected int doRunCommand(Command command, Input input, Output output)

执行指令

Parameters:
command - 指令实例
input - 输入实例
output - 输出实例
Throws:
\Exception

library\think\Console.php at line 558

getCommandName

protected string getCommandName(Input input)

获取指令的基础名称


library\think\Console.php at line 567

getDefaultInputDefinition

protected InputDefinition getDefaultInputDefinition()

获取默认输入定义


library\think\Console.php at line 585

getDefaultCommands

protected Command[] getDefaultCommands()

设置默认命令

Returns:
An array of default Command instances

library\think\Console.php at line 598

addDefaultCommands

public static void addDefaultCommands(mixed classnames)

library\think\Console.php at line 619

extractNamespace

public string extractNamespace(string name, string limit)

返回命名空间部分

Parameters:
name - 指令
limit - 部分的命名空间的最大数量

library\think\Console.php at line 681

setDefaultCommand

public void setDefaultCommand(string commandName)

设置默认的指令

Parameters:
commandName - The Command name

ThinkPHP5