Properties

$name

$name : 

Type

$version

$version : 

Type

$wantHelps

$wantHelps : 

Type

$catchExceptions

$catchExceptions : 

Type

$autoExit

$autoExit : 

Type

$definition

$definition : 

Type

$defaultCommand

$defaultCommand : 

Type

$defaultCommands

$defaultCommands : 

Type

Methods

__construct()

__construct(string  $name = 'UNKNOWN', string  $version = 'UNKNOWN', null|string  $user = null) 

Console constructor.

Parameters

string $name

名称

string $version

版本

null|string $user

执行用户

setUser()

setUser(  $user) 

设置执行用户

Parameters

$user

init()

init(boolean  $run = true) : integer|\think\Console

初始化 Console

Parameters

boolean $run

是否运行 Console

Returns

integer|\think\Console

getDefinedCommands()

getDefinedCommands(array  $config = array()) : array

Parameters

array $config

Returns

array

run()

run() : integer

执行当前的指令

Throws

\Exception

Returns

integer

setDefinition()

setDefinition(\think\console\input\Definition  $definition) 

设置输入参数定义

Parameters

\think\console\input\Definition $definition

getDefinition()

getDefinition() : \think\console\input\Definition

获取输入参数定义

Returns

\think\console\input\Definition

The InputDefinition instance

getHelp()

getHelp() : string

Gets the help message.

Returns

string —

A help message.

setCatchExceptions()

setCatchExceptions(boolean  $boolean) 

是否捕获异常

Parameters

boolean $boolean

setAutoExit()

setAutoExit(boolean  $boolean) 

是否自动退出

Parameters

boolean $boolean

getName()

getName() : string

获取名称

Returns

string

setName()

setName(string  $name) 

设置名称

Parameters

string $name

getVersion()

getVersion() : string

获取版本

Returns

string

setVersion()

setVersion(string  $version) 

设置版本

Parameters

string $version

getLongVersion()

getLongVersion() : string

获取完整的版本号

Returns

string

register()

register(string  $name) : \think\console\Command

注册一个指令 (便于动态创建指令)

Parameters

string $name

指令名

Returns

\think\console\Command

addCommands()

addCommands(array  $commands) 

添加指令集

Parameters

array $commands

add()

add(mixed  $command, string  $name) : mixed

注册一个指令(对象)

Parameters

mixed $command

指令对象或者指令类名

string $name

指令名 留空则自动获取

Returns

mixed

get()

get(string  $name) : \think\console\Command

获取指令

Parameters

string $name

指令名称

Throws

\InvalidArgumentException

Returns

\think\console\Command

has()

has(string  $name) : boolean

某个指令是否存在

Parameters

string $name

指令名称

Returns

boolean

getNamespaces()

getNamespaces() : array

获取所有的命名空间

Returns

array

findNamespace()

findNamespace(string  $namespace) : string

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

Parameters

string $namespace

Throws

\InvalidArgumentException

Returns

string

find()

find(string  $name) : \think\console\Command

查找指令

Parameters

string $name

名称或者别名

Throws

\InvalidArgumentException

Returns

\think\console\Command

all()

all(string  $namespace = null) : array<mixed,\think\console\Command>

获取所有的指令

Parameters

string $namespace

命名空间

Returns

array<mixed,\think\console\Command>

getAbbreviations()

getAbbreviations(array  $names) : array

获取可能的指令名

Parameters

array $names

Returns

array

addDefaultCommands()

addDefaultCommands(array  $classnames) 

Parameters

array $classnames

extractNamespace()

extractNamespace(string  $name, string  $limit = null) : string

返回命名空间部分

Parameters

string $name

指令

string $limit

部分的命名空间的最大数量

Returns

string

setDefaultCommand()

setDefaultCommand(string  $commandName) 

设置默认的指令

Parameters

string $commandName

The Command name

__debugInfo()

__debugInfo() 

configureIO()

configureIO(\think\console\Input  $input, \think\console\Output  $output) 

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

Parameters

\think\console\Input $input

输入实例

\think\console\Output $output

输出实例

doRunCommand()

doRunCommand(\think\console\Command  $command, \think\console\Input  $input, \think\console\Output  $output) : integer

执行指令

Parameters

\think\console\Command $command

指令实例

\think\console\Input $input

输入实例

\think\console\Output $output

输出实例

Throws

\Exception

Returns

integer

getCommandName()

getCommandName(\think\console\Input  $input) : string

获取指令的基础名称

Parameters

\think\console\Input $input

Returns

string

getDefaultInputDefinition()

getDefaultInputDefinition() : \think\console\input\Definition

获取默认输入定义

Returns

\think\console\input\Definition

getAbbreviationSuggestions()

getAbbreviationSuggestions(array  $abbrevs) : string

获取可能的建议

Parameters

array $abbrevs

Returns

string

findAlternatives()

findAlternatives(string  $name, array|\Traversable  $collection) : array

查找可替代的建议

Parameters

string $name
array|\Traversable $collection

Returns

array

extractAllNamespaces()

extractAllNamespaces(string  $name) : array

返回所有的命名空间

Parameters

string $name

Returns

array