PHP Class think\Console

Show file Open project: top-think/framework Class Usage Examples

Public Methods

Method Description
__construct ( $name = 'UNKNOWN', $version = 'UNKNOWN' )
add ( Command $command ) : Command 添加一个指令
addCommands ( array $commands ) 添加指令
addDefaultCommands ( array $classnames )
all ( string $namespace = null ) : Command[] 获取所有的指令
call ( $command, array $parameters = [] ) : Output | Buffer
doRun ( Input $input, Output $output ) : integer 执行指令
extractNamespace ( string $name, string $limit = null ) : string 返回命名空间部分
find ( string $name ) : Command 查找指令
findNamespace ( string $namespace ) : string 查找注册命名空间中的名称或缩写。
get ( string $name ) : Command 获取指令
getAbbreviations ( array $names ) : array 获取可能的指令名
getDefinition ( ) : Definition 获取输入参数定义
getHelp ( ) : string Gets the help message.
getLongVersion ( ) : string 获取完整的版本号
getName ( ) : string 获取名称
getNamespaces ( ) : array 获取所有的命名空间
getVersion ( ) : string 获取版本
has ( string $name ) : boolean 某个指令是否存在
init ( $run = true )
register ( string $name ) : Command 注册一个指令
run ( ) : integer 执行当前的指令
setAutoExit ( boolean $boolean ) 是否自动退出
setCatchExceptions ( boolean $boolean ) 是否捕获异常
setDefaultCommand ( string $commandName ) 设置默认的指令
setDefinition ( Definition $definition ) 设置输入参数定义
setName ( string $name ) 设置名称
setVersion ( string $version ) 设置版本

Protected Methods

Method Description
configureIO ( Input $input, Output $output ) 配置基于用户的参数和选项的输入和输出实例。
doRunCommand ( Command $command, Input $input, Output $output ) : integer 执行指令
getCommandName ( Input $input ) : string 获取指令的基础名称
getDefaultCommands ( ) : Command[] 设置默认命令
getDefaultInputDefinition ( ) : Definition 获取默认输入定义

Private Methods

Method Description
extractAllNamespaces ( string $name ) : array 返回所有的命名空间
findAlternatives ( string $name, array | Traversable $collection ) : array 查找可替代的建议
getAbbreviationSuggestions ( array $abbrevs ) : string 获取可能的建议

Method Details

__construct() public method

public __construct ( $name = 'UNKNOWN', $version = 'UNKNOWN' )

add() public method

添加一个指令
public add ( Command $command ) : Command
$command think\console\Command
return think\console\Command

addCommands() public method

添加指令
public addCommands ( array $commands )
$commands array

addDefaultCommands() public static method

public static addDefaultCommands ( array $classnames )
$classnames array

all() public method

获取所有的指令
public all ( string $namespace = null ) : Command[]
$namespace string 命名空间
return think\console\Command[]

call() public static method

public static call ( $command, array $parameters = [] ) : Output | Buffer
$command
$parameters array
return think\console\Output | think\console\output\driver\Buffer

configureIO() protected method

配置基于用户的参数和选项的输入和输出实例。
protected configureIO ( Input $input, Output $output )
$input think\console\Input 输入实例
$output think\console\Output 输出实例

doRun() public method

执行指令
public doRun ( Input $input, Output $output ) : integer
$input think\console\Input
$output think\console\Output
return integer

doRunCommand() protected method

执行指令
protected doRunCommand ( Command $command, Input $input, Output $output ) : integer
$command think\console\Command 指令实例
$input think\console\Input 输入实例
$output think\console\Output 输出实例
return integer

extractNamespace() public method

返回命名空间部分
public extractNamespace ( string $name, string $limit = null ) : string
$name string 指令
$limit string 部分的命名空间的最大数量
return string

find() public method

查找指令
public find ( string $name ) : Command
$name string 名称或者别名
return think\console\Command

findNamespace() public method

查找注册命名空间中的名称或缩写。
public findNamespace ( string $namespace ) : string
$namespace string
return string

get() public method

获取指令
public get ( string $name ) : Command
$name string 指令名称
return think\console\Command

getAbbreviations() public static method

获取可能的指令名
public static getAbbreviations ( array $names ) : array
$names array
return array

getCommandName() protected method

获取指令的基础名称
protected getCommandName ( Input $input ) : string
$input think\console\Input
return string

getDefaultCommands() protected method

设置默认命令
protected getDefaultCommands ( ) : Command[]
return think\console\Command[] An array of default Command instances

getDefaultInputDefinition() protected method

获取默认输入定义
protected getDefaultInputDefinition ( ) : Definition
return think\console\input\Definition

getDefinition() public method

获取输入参数定义
public getDefinition ( ) : Definition
return think\console\input\Definition The InputDefinition instance

getHelp() public method

Gets the help message.
public getHelp ( ) : string
return string A help message.

getLongVersion() public method

获取完整的版本号
public getLongVersion ( ) : string
return string

getName() public method

获取名称
public getName ( ) : string
return string

getNamespaces() public method

获取所有的命名空间
public getNamespaces ( ) : array
return array

getVersion() public method

获取版本
public getVersion ( ) : string
return string

has() public method

某个指令是否存在
public has ( string $name ) : boolean
$name string 指令名称
return boolean

init() public static method

public static init ( $run = true )

register() public method

注册一个指令
public register ( string $name ) : Command
$name string
return think\console\Command

run() public method

执行当前的指令
public run ( ) : integer
return integer

setAutoExit() public method

是否自动退出
public setAutoExit ( boolean $boolean )
$boolean boolean

setCatchExceptions() public method

是否捕获异常
public setCatchExceptions ( boolean $boolean )
$boolean boolean

setDefaultCommand() public method

设置默认的指令
public setDefaultCommand ( string $commandName )
$commandName string The Command name

setDefinition() public method

设置输入参数定义
public setDefinition ( Definition $definition )
$definition think\console\input\Definition

setName() public method

设置名称
public setName ( string $name )
$name string

setVersion() public method

设置版本
public setVersion ( string $version )
$version string