Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class GetConfigurationCommand - list of methods

Console command for displaying configuration options
Package: Joomla\CMS\Console
Copyright: (C) 2020 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
Located at: Joomla/Console/GetConfigurationCommand.php
Project: Joomla

Method Summary

private void
(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)

Configures the IO
Parameters
  • \Symfony\Component\Console\Input\InputInterface $input Console Input
  • \Symfony\Component\Console\Output\OutputInterface $output Console Output
Returns
  • void
Since
  • 4.0.0
Show source code of this method: configureIO Source Code

public int
(mixed $group)

Displays logically grouped options
Parameters
  • string $group The group to be processed
Returns
  • int
Since
  • 4.0.0
Show source code of this method: processGroupOptions Source Code

public array
()

Gets the defined option groups
Returns
  • array
Since
  • 4.0.0
Show source code of this method: getGroups Source Code

public array
(array $configs)

Formats the configuration array into desired format
Parameters
  • array $configs Array of the configurations
Returns
  • array
Since
  • 4.0.0
Show source code of this method: formatConfig Source Code

public int
(mixed $option)

Handles the command when a single option is requested
Parameters
  • string $option The option we want to get its value
Returns
  • int
Since
  • 4.0.0
Show source code of this method: processSingleOption Source Code

protected string
(mixed $value)

Formats the Configuration value
Parameters
  • mixed $value Value to be formatted
Returns
  • string
Since
  • -
Show source code of this method: formatConfigValue Source Code

protected void
()

Initialise the command.
Returns
  • void
Since
  • 4.0.0
Show source code of this method: configure Source Code

protected int
(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)

Internal function to execute the command.
Parameters
  • \Symfony\Component\Console\Input\InputInterface $input The input to inject into the command.
  • \Symfony\Component\Console\Output\OutputInterface $output The output to inject into the command.
Returns
  • int The command exit code
Since
  • 4.0.0
Show source code of this method: doExecute Source Code

Properties Summary

protected static string
$defaultName
The default command name
Since
  • 4.0.0
private \Symfony\Component\Console\Input\Input
$cliInput
Stores the Input Object
Since
  • 4.0.0
private \Symfony\Component\Console\Style\SymfonyStyle
$ioStyle
SymfonyStyle Object
Since
  • 4.0.0

Constants Summary

public array
$DB_GROUP
Constant defining the Database option group
Since
  • 4.0.0
public array
$SESSION_GROUP
Constant defining the Session option group
Since
  • 4.0.0
public array
$MAIL_GROUP
Constant defining the Mail option group
Since
  • 4.0.0
public
$CONFIG_GET_SUCCESSFUL
Return code if configuration is get successfully
Since
  • 4.0.0
public
$CONFIG_GET_GROUP_NOT_FOUND
Return code if configuration group option is not found
Since
  • 4.0.0
public
$CONFIG_GET_OPTION_NOT_FOUND
Return code if configuration option is not found
Since
  • 4.0.0
public
$CONFIG_GET_OPTION_FAILED
Return code if the command has been invoked with wrong options
Since
  • 4.0.0

Tags Summary

Since
4.0.0