Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class SetConfigurationCommand - list of methods

Console command Setting 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/SetConfigurationCommand.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

private bool
(array $options)

Collects options from user input
Parameters
  • array $options Options input by users
Returns
  • bool
Since
  • 4.0.0
Show source code of this method: retrieveOptionsFromInput Source Code

private bool
()

Validates the options provided
Returns
  • bool
Since
  • 4.0.0
Show source code of this method: validateOptions Source Code

public void
(mixed $options)

Sets the options array
Parameters
  • string $options Options string
Returns
  • void
Since
  • 4.0.0
Show source code of this method: setOptions Source Code

public array|mixed
()

Collects the options array
Returns
  • array|mixed
Since
  • 4.0.0
Show source code of this method: getOptions Source Code

public \Joomla\Registry\Registry
()

Returns Default configuration Object
Returns
  • \Joomla\Registry\Registry
Since
  • 4.0.0
Show source code of this method: getInitialConfigurationOptions Source Code

public bool
(mixed $options)

Save the configuration file
Parameters
  • array $options Options array
Returns
  • bool
Since
  • 4.0.0
Show source code of this method: saveConfiguration Source Code

protected void
()

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

public bool|\Joomla\Database\DatabaseInterface
(mixed $options)

Verifies database connection
Parameters
  • array $options Options array
Returns
  • bool|\Joomla\Database\DatabaseInterface
Since
  • 4.0.0
-
  • \Exception
Show source code of this method: checkDb 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
-
  • \Exception
Show source code of this method: doExecute Source Code

public array
(array $options)

Sanitize the options array for boolean
Parameters
  • array $options Options array
Returns
  • array
Since
  • 4.0.0
Show source code of this method: sanitizeOptions 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
private array
$options
Options Array
Since
  • 4.0.0

Constants Summary

public
$CONFIG_SET_SUCCESSFUL
Return code if configuration is set successfully
Since
  • 4.0.0
public
$CONFIG_SET_FAILED
Return code if configuration set failed
Since
  • 4.0.0
public
$CONFIG_VALIDATION_FAILED
Return code if config validation failed
Since
  • 4.0.0
public
$CONFIG_OPTIONS_WRONG
Return code if options are wrong
Since
  • 4.0.0
public
$DB_VALIDATION_FAILED
Return code if database validation failed
Since
  • 4.0.0

Tags Summary

Since
4.0.0