\thinkConsole

__construct()

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

Console constructor.

Parameters

Returns

setUser()

setUser( $user) : mixed

设置执行用户

Parameters

Returns

init()

init(bool  $run = true) : int|\think\Console

初始化 Console

Parameters

Returns

getDefinedCommands()

getDefinedCommands(array  $config = []) : array

Parameters

Returns

call()

call(string  $command, array  $parameters = [], string  $driver = 'buffer') : \think\console\Output|\think\console\output\driver\Buffer

Parameters

Returns

run()

run() : int

执行当前的指令

Throws

\Exception

Returns

doRun()

doRun(\think\console\Input  $input, \think\console\Output  $output) : int

执行指令

Parameters

Returns

setDefinition()

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

设置输入参数定义

Parameters

Returns

getDefinition()

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

获取输入参数定义

Returns

The InputDefinition instance

getHelp()

getHelp() : string

Gets the help message.

Returns

A help message.

setCatchExceptions()

setCatchExceptions(bool  $boolean) : mixed

是否捕获异常

Parameters

Returns

setAutoExit()

setAutoExit(bool  $boolean) : mixed

是否自动退出

Parameters

Returns

getName()

getName() : string

获取名称

Returns

setName()

setName(string  $name) : mixed

设置名称

Parameters

Returns

getVersion()

getVersion() : string

获取版本

Returns

setVersion()

setVersion(string  $version) : mixed

设置版本

Parameters

Returns

getLongVersion()

getLongVersion() : string

获取完整的版本号

Returns

register()

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

注册一个指令 （便于动态创建指令）

Parameters

Returns

addCommands()

addCommands(array  $commands) : mixed

添加指令集

Parameters

Returns

add()

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

注册一个指令（对象）

Parameters

Returns

get()

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

获取指令

Parameters

Throws

\InvalidArgumentException

Returns

has()

has(string  $name) : bool

某个指令是否存在

Parameters

Returns

getNamespaces()

getNamespaces() : array

获取所有的命名空间

Returns

findNamespace()

findNamespace(string  $namespace) : string

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

Parameters

Throws

\InvalidArgumentException

Returns

find()

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

查找指令

Parameters

Throws

\InvalidArgumentException

Returns

all()

all(string  $namespace = null) : \think\console\Command[]

获取所有的指令

Parameters

Returns

getAbbreviations()

getAbbreviations(array  $names) : array

获取可能的指令名

Parameters

Returns

addDefaultCommands()

addDefaultCommands(array  $classnames) : mixed

Parameters

Returns

extractNamespace()

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

返回命名空间部分

Parameters

Returns

setDefaultCommand()

setDefaultCommand(string  $commandName) : mixed

设置默认的指令

Parameters

Returns

__debugInfo()

__debugInfo() : mixed

Returns

configureIO()

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

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

Parameters

Returns

doRunCommand()

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

执行指令

Parameters

Throws

\Exception

Returns

getCommandName()

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

获取指令的基础名称

Parameters

Returns

getDefaultInputDefinition()

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

获取默认输入定义

Returns

getAbbreviationSuggestions()

getAbbreviationSuggestions(array  $abbrevs) : string

获取可能的建议

Parameters

Returns

findAlternatives()

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

查找可替代的建议

Parameters

Returns

extractAllNamespaces()

extractAllNamespaces(string  $name) : array

返回所有的命名空间

Parameters

Returns