GetConfigurationCommand
Extends AbstractCommandConsole command for displaying configuration options
| since |
4.0.0 |
|---|---|
| package |
Joomla CMS |
Methods
configure
Initialise the command.
configure() :
| since |
4.0.0 |
|---|
Response
void
configureIO
Configures the IO
configureIO(\Symfony\Component\Console\Input\InputInterface input, \Symfony\Component\Console\Output\OutputInterface output) :
| since |
4.0.0 |
|---|
Arguments
- input
InputInterfaceConsole Input- output
OutputInterfaceConsole Output
Response
void
doExecute
Internal function to execute the command.
doExecute(\Symfony\Component\Console\Input\InputInterface input, \Symfony\Component\Console\Output\OutputInterface output) :
| since |
4.0.0 |
|---|
Arguments
- input
InputInterfaceThe input to inject into the command.- output
OutputInterfaceThe output to inject into the command.
Response
intThe command exit code
formatConfig
Formats the configuration array into desired format
formatConfig(mixed||string|int configs) : mixed||string|int
| since |
4.0.0 |
|---|
Arguments
- configs
array<string|int, mixed>Array of the configurations
Response
array<string|int, mixed>
formatConfigValue
Formats the Configuration value
formatConfigValue( value) :
| since |
4.0.0 |
|---|
Arguments
- value
mixedValue to be formatted
Response
string
getGroups
Gets the defined option groups
getGroups() : mixed||string|int
| since |
4.0.0 |
|---|
Response
array<string|int, mixed>
processGroupOptions
Displays logically grouped options
processGroupOptions( group) :
| since |
4.0.0 |
|---|
Arguments
- group
stringThe group to be processed
Response
int
processSingleOption
Handles the command when a single option is requested
processSingleOption( option) :
| since |
4.0.0 |
|---|
Arguments
- option
stringThe option we want to get its value
Response
int
Constants
DB_GROUP
Constant defining the Database option group
| Value | ['name' => 'db', 'options' => ['dbtype', 'host', 'user', 'password', 'dbprefix', 'db', 'dbencryption', 'dbsslverifyservercert', 'dbsslkey', 'dbsslcert', 'dbsslca', 'dbsslcipher']] |
|---|---|
| since |
4.0.0 |
Type(s)
array<string|int, mixed>
SESSION_GROUP
Constant defining the Session option group
| Value | ['name' => 'session', 'options' => ['session_handler', 'shared_session', 'session_metadata']] |
|---|---|
| since |
4.0.0 |
Type(s)
array<string|int, mixed>
MAIL_GROUP
Constant defining the Mail option group
| Value | ['name' => 'mail', 'options' => ['mailonline', 'mailer', 'mailfrom', 'fromname', 'sendmail', 'smtpauth', 'smtpuser', 'smtppass', 'smtphost', 'smtpsecure', 'smtpport']] |
|---|---|
| since |
4.0.0 |
Type(s)
array<string|int, mixed>
CONFIG_GET_SUCCESSFUL
Return code if configuration is get successfully
| Value | 0 |
|---|---|
| since |
4.0.0 |
CONFIG_GET_GROUP_NOT_FOUND
Return code if configuration group option is not found
| Value | 1 |
|---|---|
| since |
4.0.0 |
CONFIG_GET_OPTION_NOT_FOUND
Return code if configuration option is not found
| Value | 2 |
|---|---|
| since |
4.0.0 |
CONFIG_GET_OPTION_FAILED
Return code if the command has been invoked with wrong options
| Value | 3 |
|---|---|
| since |
4.0.0 |
Properties
defaultName
The default command name
| since |
4.0.0 |
|---|
Type(s)
string
cliInput
Stores the Input Object
| since |
4.0.0 |
|---|
Type(s)
Input
ioStyle
SymfonyStyle Object
| since |
4.0.0 |
|---|
Type(s)
SymfonyStyle