\thinkConsole

控制台应用管理类

Summary

Methods

Properties

Constants

__construct()
starting()
flushStartCallbacks()
setUser()
call()
run()
doRun()
setDefinition()
getDefinition()
getHelp()
setCatchExceptions()
setAutoExit()
getLongVersion()
addCommands()
addCommand()
getCommand()
hasCommand()
getNamespaces()
findNamespace()
find()
all()
extractNamespace()

No public properties found

No constants found

start()
loadCommands()
configureIO()
doRunCommand()
getCommandName()
getDefaultInputDefinition()

$app
$commands
$wantHelps
$catchExceptions
$autoExit
$definition
$defaultCommand
$defaultCommands
$startCallbacks

N/A

getAbbreviationSuggestions()
findAlternatives()
extractAllNamespaces()

No private properties found

N/A

File: vendor/topthink/framework/src/think/Console.php
Package: Application
Class hierarchy: \think\Console
Uses

Tags

None found

Properties

$app

$app

$commands

$commands : \think\console\Command[]

Type

Command[] —

$wantHelps

$wantHelps

$catchExceptions

$catchExceptions

$autoExit

$autoExit

$definition

$definition

$defaultCommand

$defaultCommand

$defaultCommands

$defaultCommands

$startCallbacks

$startCallbacks : array

启动器

Type

array —

Methods

__construct()

__construct(\think\App  $app) : mixed

Parameters

\think\App

$app

Returns

mixed —

starting()

starting(\Closure  $callback) : void

添加初始化器

Parameters

\Closure

$callback

flushStartCallbacks()

flushStartCallbacks() : void

清空启动器

setUser()

setUser( $user) : void

设置执行用户

Parameters

$user

call()

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

Parameters

string	$command
array	$parameters
string	$driver

Returns

\think\console\Output|\think\console\output\driver\Buffer —

run()

run() : int

执行当前的指令

Throws

\Exception

Returns

int —

Inherited from: \think\Console
Uses

Tags

api

doRun()

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

执行指令

Parameters

\think\console\Input	$input
\think\console\Output	$output

Returns

int —

setDefinition()

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

设置输入参数定义

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(bool  $boolean) : void

是否捕获异常

Parameters

bool

$boolean

Inherited from: \think\Console
Uses

Tags

api

setAutoExit()

setAutoExit(bool  $boolean) : void

是否自动退出

Parameters

bool

$boolean

Inherited from: \think\Console
Uses

Tags

api

getLongVersion()

getLongVersion() : string

获取完整的版本号

Returns

string —

addCommands()

addCommands(array  $commands) : void

添加指令集

Parameters

array

$commands

addCommand()

addCommand(string|\think\console\Command  $command, string  $name = '') : \think\console\Command|void

添加一个指令

Parameters

string\|\think\console\Command	$command	指令对象或者指令类名
string	$name	指令名留空则自动获取

Returns

\think\console\Command|void —

getCommand()

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

获取指令

Parameters

string

$name

指令名称

Throws

\InvalidArgumentException

Returns

\think\console\Command —

hasCommand()

hasCommand(string  $name) : bool

某个指令是否存在

Parameters

string

$name

指令名称

Returns

bool —

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) : \think\console\Command[]

获取所有的指令

Parameters

string

$namespace

命名空间

Returns

\think\console\Command[] —

Inherited from: \think\Console
Uses

Tags

api

extractNamespace()

extractNamespace(string  $name, int  $limit) : string

返回命名空间部分

Parameters

string	$name	指令
int	$limit	部分的命名空间的最大数量

Returns

string —

start()

start() : void

启动

loadCommands()

loadCommands() : void

加载指令

configureIO()

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

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

Parameters

\think\console\Input	$input	输入实例
\think\console\Output	$output	输出实例

doRunCommand()

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

执行指令

Parameters

\think\console\Command	$command	指令实例
\think\console\Input	$input	输入实例
\think\console\Output	$output	输出实例

Throws

\Exception

Returns

int —

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 —