SetConfigurationCommand
扩展自 AbstractCommand控制台命令 设置配置选项
| 自 |
4.0.0 |
|---|---|
| 包 |
Joomla CMS |
方法
checkDb
验证数据库连接
checkDb(mixed||string|int options) : bool|\Joomla\Database\DatabaseInterface
| 自 |
4.0.0 |
|---|---|
| 抛出 |
|
参数
- 选项
array<string|int, mixed>选项数组
响应
bool|DatabaseInterface
configure
初始化命令。
configure() :
| 自 |
4.0.0 |
|---|
响应
void
configureIO
配置 IO
configureIO(\Symfony\Component\Console\Input\InputInterface input, \Symfony\Component\Console\Output\OutputInterface output) :
| 自 |
4.0.0 |
|---|
参数
- 输入
InputInterface控制台输入- 输出
OutputInterface控制台输出
响应
void
doExecute
执行命令的内部函数。
doExecute(\Symfony\Component\Console\Input\InputInterface input, \Symfony\Component\Console\Output\OutputInterface output) :
| 自 |
4.0.0 |
|---|---|
| 抛出 |
|
参数
- 输入
InputInterface注入到命令中的输入。- 输出
OutputInterface注入到命令中的输出。
响应
int命令退出代码
getInitialConfigurationOptions
返回默认配置对象
getInitialConfigurationOptions() : \Joomla\Registry\Registry
| 自 |
4.0.0 |
|---|
响应
注册表
getOptions
收集选项数组
getOptions() : array|mixed
| 自 |
4.0.0 |
|---|
响应
array<string|int, mixed>|mixed
retrieveOptionsFromInput
从用户输入中收集选项
retrieveOptionsFromInput(mixed||string|int options) :
| 自 |
4.0.0 |
|---|
参数
- 选项
array<string|int, mixed>用户输入的选项
响应
bool
sanitizeOptions
为布尔值清理选项数组
sanitizeOptions(mixed||string|int options) : mixed||string|int
| 自 |
4.0.0 |
|---|
参数
- 选项
array<string|int, mixed>选项数组
响应
array<string|int, mixed>
saveConfiguration
保存配置文件
saveConfiguration(mixed||string|int options) :
| 自 |
4.0.0 |
|---|
参数
- 选项
array<string|int, mixed>选项数组
响应
bool
setOptions
设置选项数组
setOptions( options) :
| 自 |
4.0.0 |
|---|
参数
- 选项
string选项字符串
响应
void
validateOptions
验证提供的选项
validateOptions() :
| 自 |
4.0.0 |
|---|
响应
bool
常量
CONFIG_SET_SUCCESSFUL
如果配置设置成功，则返回代码
| 值 | 0 |
|---|---|
| 自 |
4.0.0 |
CONFIG_SET_FAILED
如果配置设置失败，则返回代码
| 值 | 1 |
|---|---|
| 自 |
4.0.0 |
CONFIG_VALIDATION_FAILED
如果配置验证失败，则返回代码
| 值 | 2 |
|---|---|
| 自 |
4.0.0 |
CONFIG_OPTIONS_WRONG
如果选项错误，则返回代码
| 值 | 3 |
|---|---|
| 自 |
4.0.0 |
DB_VALIDATION_FAILED
如果数据库验证失败，则返回代码
| 值 | 4 |
|---|---|
| 自 |
4.0.0 |
属性
defaultName
默认命令名称
静态
| 自 |
4.0.0 |
|---|
类型
string
cliInput
存储输入对象
| 自 |
4.0.0 |
|---|
类型
输入
ioStyle
SymfonyStyle 对象
| 自 |
4.0.0 |
|---|
类型
SymfonyStyle
选项
选项数组
| 自 |
4.0.0 |
|---|
类型
array<string|int, mixed>