Property | Type | Description | |
---|---|---|---|
$input | |||
$output |
Method | Description | |
---|---|---|
__construct ( string | null $name = null ) | 构造方法 | |
addArgument ( string $name, integer $mode = null, string $description = '', mixed $default = null ) : |
添加参数 | |
addOption ( string $name, string $shortcut = null, integer $mode = null, string $description = '', mixed $default = null ) : |
添加选项 | |
addUsage ( string $usage ) | 添加用法介绍 | |
getAliases ( ) : array | 获取别名 | |
getConsole ( ) : |
获取控制台 | |
getDefinition ( ) : |
获取参数定义 | |
getDescription ( ) : string | 获取描述 | |
getHelp ( ) : string | 获取帮助信息 | |
getName ( ) : string | 获取指令名称 | |
getNativeDefinition ( ) : |
获取当前指令的参数定义 | |
getProcessedHelp ( ) : string | 描述信息 | |
getSynopsis ( boolean $short = false ) : string | 获取简介 | |
getUsages ( ) : array | 获取用法介绍 | |
ignoreValidationErrors ( ) | 忽略验证错误 | |
isEnabled ( ) : boolean | 是否有效 | |
mergeConsoleDefinition ( boolean $mergeArgs = true ) | 合并参数定义 | |
run ( |
执行 | |
setAliases ( string[] $aliases ) : |
设置别名 | |
setCode ( callable $code ) : |
设置执行代码 | |
setConsole ( |
设置控制台 | |
setDefinition ( array | |
设置参数定义 | |
setDescription ( string $description ) : |
设置描述 | |
setHelp ( string $help ) : |
设置帮助信息 | |
setName ( string $name ) : |
设置指令名称 |
Method | Description | |
---|---|---|
configure ( ) | 配置指令 | |
execute ( |
执行指令 | |
initialize ( |
初始化 | |
interact ( |
用户验证 |
Method | Description | |
---|---|---|
validateName ( string $name ) | 验证指令名称 |
public __construct ( string | null $name = null ) | ||
$name | string | null | 命令名称,如果没有设置则比如在 configure() 里设置 |
public getDefinition ( ) : |
||
return |
public getNativeDefinition ( ) : |
||
return |
public getSynopsis ( boolean $short = false ) : string | ||
$short | boolean | 是否简单的 |
return | string |
protected initialize ( |
||
$input | An InputInterface instance | |
$output | An OutputInterface instance |
protected interact ( |
||
$input | ||
$output |
public mergeConsoleDefinition ( boolean $mergeArgs = true ) | ||
$mergeArgs | boolean |
public setAliases ( string[] $aliases ) : |
||
$aliases | string[] | |
return |
public setConsole ( |
||
$console |
public setDefinition ( array | |
||
$definition | array | |
|
return |
public setDescription ( string $description ) : |
||
$description | string | |
return |