ExportCommand
扩展 AbstractCommand用于导出数据库的控制台命令
| 自 |
2.0.0 |
|---|---|
| 包 |
Joomla 框架 |
方法
__construct
实例化命令。
__construct(\Joomla\Database\DatabaseDriver db) :
addArgument
将参数添加到输入定义中。
addArgument( name, int mode = null, description = '', default = null) :
| 自 |
2.0.0 |
|---|
参数
- name
string参数名称- mode
int|null参数模式：InputArgument::REQUIRED 或 InputArgument::OPTIONAL- description
string描述文本- default
mixed默认值（仅适用于 InputArgument::OPTIONAL 模式）
响应
$this
addOption
将选项添加到输入定义中。
addOption( name, string|array shortcut = null, int mode = null, description = '', mixed default = null) :
| 自 |
2.0.0 |
|---|
参数
- name
string选项名称- shortcut
string|array<string|int, mixed>快捷方式，可以为 null、由 | 分隔的快捷方式字符串或快捷方式数组- mode
int|null选项模式：VALUE_* 常量之一- description
string描述文本- default
mixed|null默认值（对于 InputOption::VALUE_NONE 必须为 null）
响应
$this
configure
配置命令。
configure() :
| 自 |
2.0.0 |
|---|
响应
void
doExecute
内部函数，用于执行命令。
doExecute(\Symfony\Component\Console\Input\InputInterface input, \Symfony\Component\Console\Output\OutputInterface output) :
| 自 |
2.0.0 |
|---|
参数
- input
InputInterface要注入命令的输入。- output
OutputInterface要注入命令的输出。
响应
int命令退出代码
execute
执行命令。
execute(\Symfony\Component\Console\Input\InputInterface input, \Symfony\Component\Console\Output\OutputInterface output) :
| 自 |
2.0.0 |
|---|
参数
- input
InputInterface要注入命令的输入。- output
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 |
|---|
参数
- short
bool标志，指示应返回概要的简短版本还是长版本
响应
string
initialise
内部钩子，用于在绑定输入后且验证输入之前初始化命令。
initialise(\Symfony\Component\Console\Input\InputInterface input, \Symfony\Component\Console\Output\OutputInterface output) :
| 自 |
2.0.0 |
|---|
参数
- input
InputInterface要注入命令的输入。- output
OutputInterface要注入命令的输出。
响应
void
isEnabled
检查命令在此环境中是否已启用。
isEnabled() :
| 自 |
2.0.0 |
|---|
响应
bool
isHidden
检查命令是否从命令列表中隐藏。
isHidden() :
| 自 |
2.0.0 |
|---|
响应
bool
setAliases
设置命令的别名。
setAliases(string||string|int aliases) :
| 自 |
2.0.0 |
|---|
参数
- aliases
array<string|int, string>命令别名
响应
void
setApplication
设置命令的应用程序。
setApplication(\Joomla\Console\Application application = null) :
setDefinition
设置命令的输入定义。
setDefinition(array|\Symfony\Component\Console\Input\InputDefinition definition) :
| 自 |
2.0.0 |
|---|
参数
- definition
array<string|int, mixed>|InputDefinitionInputDefinition 对象或要写入定义的对象数组。
响应
void
setDescription
设置命令的描述。
setDescription( description) :
| 自 |
2.0.0 |
|---|
参数
- description
string命令的描述
响应
void
setHelp
设置命令的帮助。
setHelp( help) :
| 自 |
2.0.0 |
|---|
参数
- help
string命令的帮助
响应
void
setHelperSet
设置命令的输入帮助集。
setHelperSet(\Symfony\Component\Console\Helper\HelperSet helperSet) :
| 自 |
2.0.0 |
|---|
参数
- helperSet
HelperSet帮助集。
响应
void
setHidden
设置是否从命令列表中隐藏此命令。
setHidden( hidden) :
| 自 |
2.0.0 |
|---|
参数
- hidden
bool标志，指示此命令是否隐藏。
响应
void
setName
设置命令的名称。
setName( name) :
| 自 |
2.0.0 |
|---|
参数
- name
string命令名称
响应
void
属性
defaultName
默认命令名称
| 自 |
2.0.0 |
|---|
类型
string
aliases
命令的别名。
| 自 |
2.0.0 |
|---|
类型
array<string|int, string>
applicationDefinitionMerged
标志，跟踪应用程序定义是否已合并到此命令中。
| 自 |
2.0.0 |
|---|
类型
bool
applicationDefinitionMergedWithArgs
标志，跟踪带有参数的应用程序定义是否已合并到此命令中。
| 自 |
2.0.0 |
|---|
类型
bool
definition
命令的输入定义。
| 自 |
2.0.0 |
|---|
类型
InputDefinition
description
命令的描述。
| 自 |
2.0.0 |
|---|
类型
string
help
命令的帮助。
| 自 |
2.0.0 |
|---|
类型
string
helperSet
命令的输入帮助集。
| 自 |
2.0.0 |
|---|
类型
HelperSet|null
name
命令的名称。
| 自 |
2.0.0 |
|---|
类型
string
synopsis
命令的概要。
| 自 |
2.0.0 |
|---|
类型
array<string|int, string>