GetConfigurationCommand
Extends \Joomla\Console\Command\AbstractCommandConsole command for displaying configuration options
| since |
4.0.0 |
|---|---|
| package |
Application |
Methods
configure
Initialise the command.
configure() : void
| since |
4.0.0 |
|---|
configureIO
Configures the IO
configureIO(\Symfony\Component\Console\Input\InputInterface input, \Symfony\Component\Console\Output\OutputInterface output) : void
| since |
4.0.0 |
|---|
Arguments
- input
\Symfony\Component\Console\Input\InputInterfaceConsole Input- output
\Symfony\Component\Console\Output\OutputInterfaceConsole Output
doExecute
Internal function to execute the command.
doExecute(\Symfony\Component\Console\Input\InputInterface input, \Symfony\Component\Console\Output\OutputInterface output) : int
| since |
4.0.0 |
|---|
Arguments
- input
\Symfony\Component\Console\Input\InputInterfaceThe input to inject into the command.- output
\Symfony\Component\Console\Output\OutputInterfaceThe output to inject into the command.
Response
intThe command exit code
formatConfig
Formats the configuration array into desired format
formatConfig(array configs) : array
| since |
4.0.0 |
|---|
Arguments
- configs
arrayArray of the configurations
Response
array
formatConfigValue
Formats the Configuration value
formatConfigValue(mixed value) : string
| since |
|---|
Arguments
- value
mixedValue to be formatted
Response
string
getGroups
Gets the defined option groups
getGroups() : array
| since |
4.0.0 |
|---|
Response
array
processGroupOptions
Displays logically grouped options
processGroupOptions(string group) : int
| since |
4.0.0 |
|---|
Arguments
- group
stringThe group to be processed
Response
int
processSingleOption
Handles the command when a single option is requested
processSingleOption(string option) : int
| 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
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
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
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
cliInput
Stores the Input Object
| since |
4.0.0 |
|---|
Type(s)
\Symfony\Component\Console\Input\Input
ioStyle
SymfonyStyle Object
| since |
4.0.0 |
|---|
Type(s)
\Symfony\Component\Console\Style\SymfonyStyle