ListCommand
扩展 AbstractCommand列出所有可用命令的命令。
| 自 |
2.0.0 |
|---|---|
| 包 |
Joomla 框架 |
方法
__construct
命令构造函数。
__construct(string|null name = null) :
| 自 |
2.0.0 |
|---|
参数
- 名称
string|null命令的名称；如果名称为空并且未设置默认值，则必须在 configure() 方法中设置名称
响应
混合
addArgument
向输入定义添加参数。
addArgument( name, int mode = null, description = '', default = null) :
| 自 |
2.0.0 |
|---|
参数
- 名称
string参数名称- 模式
int|null参数模式：InputArgument::REQUIRED 或 InputArgument::OPTIONAL- 描述
string描述文本- 默认
mixed默认值（仅适用于 InputArgument::OPTIONAL 模式）
响应
$this
addOption
向输入定义添加选项。
addOption( name, string|array shortcut = null, int mode = null, description = '', mixed default = null) :
| 自 |
2.0.0 |
|---|
参数
- 名称
string选项名称- 快捷方式
string|array<string|int, mixed>快捷方式，可以为空、由 | 分隔的快捷方式字符串或快捷方式数组- 模式
int|null选项模式：VALUE_* 常量之一- 描述
string描述文本- 默认
mixed|null默认值（对于 InputOption::VALUE_NONE 必须为空）
响应
$this
configure
配置命令。
configure() :
| 自 |
2.0.0 |
|---|
响应
void
doExecute
执行命令的内部函数。
doExecute(\Symfony\Component\Console\Input\InputInterface input, \Symfony\Component\Console\Output\OutputInterface output) :
| 自 |
2.0.0 |
|---|
参数
- 输入
InputInterface要注入到命令中的输入。- 输出
OutputInterface要注入到命令中的输出。
响应
int命令退出代码
execute
执行命令。
execute(\Symfony\Component\Console\Input\InputInterface input, \Symfony\Component\Console\Output\OutputInterface output) :
| 自 |
2.0.0 |
|---|
参数
- 输入
InputInterface要注入到命令中的输入。- 输出
OutputInterface要注入到命令中的输出。
响应
int命令退出代码
getAliases
获取命令的别名。
getAliases() : string||string|int
| 自 |
2.0.0 |
|---|
响应
array<string|int, string>
getApplication
获取应用程序对象。
getApplication() : \Joomla\Console\Application
getDefaultName
获取此类的默认命令名称。
getDefaultName() : string|null
这允许在不实例化完整命令类的情况下定义和引用命令名称。
| 自 |
2.0.0 |
|---|
响应
string|null
getDefinition
获取附加到此命令的 InputDefinition。
getDefinition() : \Symfony\Component\Console\Input\InputDefinition
| 自 |
2.0.0 |
|---|
响应
InputDefinition
getDescription
获取命令的描述。
getDescription() :
| 自 |
2.0.0 |
|---|
响应
string
getHelp
获取命令的帮助。
getHelp() :
| 自 |
2.0.0 |
|---|
响应
string
getHelperSet
获取命令的输入帮助集。
getHelperSet() : \Symfony\Component\Console\Helper\HelperSet|null
| 自 |
2.0.0 |
|---|
响应
HelperSet|null
getName
获取命令的名称。
getName() : string|null
| 自 |
2.0.0 |
|---|
响应
string|null
getProcessedHelp
返回命令的已处理帮助。
getProcessedHelp() :
此方法用于用实际值替换命令中的占位符。默认情况下，这支持 %command.name% 和 %command.full_name。
| 自 |
2.0.0 |
|---|
响应
string
getSynopsis
获取命令的概要。
getSynopsis( short = false) :
| 自 |
2.0.0 |
|---|
参数
- 简短
bool标志，指示应返回概要的简短版本还是长版本
响应
string
initialise
在绑定输入之后以及验证输入之前初始化命令的内部钩子。
initialise(\Symfony\Component\Console\Input\InputInterface input, \Symfony\Component\Console\Output\OutputInterface output) :
| 自 |
2.0.0 |
|---|
参数
- 输入
InputInterface要注入到命令中的输入。- 输出
OutputInterface要注入到命令中的输出。
响应
void
isEnabled
检查命令在此环境中是否启用。
isEnabled() :
| 自 |
2.0.0 |
|---|
响应
bool
isHidden
检查命令是否从命令列表中隐藏。
isHidden() :
| 自 |
2.0.0 |
|---|
响应
bool
setAliases
设置命令的别名。
setAliases(string||string|int aliases) :
| 自 |
2.0.0 |
|---|
参数
- 别名
array<string|int, string>命令别名
响应
void
setApplication
设置命令的应用程序。
setApplication(\Joomla\Console\Application application = null) :
setDefinition
设置命令的输入定义。
setDefinition(array|\Symfony\Component\Console\Input\InputDefinition definition) :
| 自 |
2.0.0 |
|---|
参数
- 定义
array<string|int, mixed>|InputDefinitionInputDefinition 对象或要写入定义的对象数组。
响应
void
setDescription
设置命令的描述。
setDescription( description) :
| 自 |
2.0.0 |
|---|
参数
- 描述
string命令的描述
响应
void
setHelp
设置命令的帮助。
setHelp( help) :
| 自 |
2.0.0 |
|---|
参数
- 帮助
string命令的帮助
响应
void
setHelperSet
设置命令的输入帮助集。
setHelperSet(\Symfony\Component\Console\Helper\HelperSet helperSet) :
| 自 |
2.0.0 |
|---|
参数
- helperSet
HelperSet帮助集。
响应
void
setHidden
设置此命令是否从命令列表中隐藏。
setHidden( hidden) :
| 自 |
2.0.0 |
|---|
参数
- 隐藏
bool标志，指示此命令是否隐藏。
响应
void
setName
设置命令的名称。
setName( name) :
| 自 |
2.0.0 |
|---|
参数
- 名称
string命令名称
响应
void
属性
defaultName
默认命令名称
| 自 |
2.0.0 |
|---|
类型
string
别名
命令的别名。
| 自 |
2.0.0 |
|---|
类型
array<string|int, string>
applicationDefinitionMerged
标志，跟踪应用程序定义是否已合并到此命令。
| 自 |
2.0.0 |
|---|
类型
bool
applicationDefinitionMergedWithArgs
标志，跟踪带有参数的应用程序定义是否已合并到此命令。
| 自 |
2.0.0 |
|---|
类型
bool
定义
命令的输入定义。
| 自 |
2.0.0 |
|---|
类型
InputDefinition
描述
命令的描述。
| 自 |
2.0.0 |
|---|
类型
string
帮助
命令的帮助。
| 自 |
2.0.0 |
|---|
类型
string
helperSet
命令的输入帮助集。
| 自 |
2.0.0 |
|---|
类型
HelperSet|null
名称
命令的名称。
| 自 |
2.0.0 |
|---|
类型
string
概要
命令的概要。
| 自 |
2.0.0 |
|---|
类型
array<string|int, string>