Référence de la classe SetConfigurationCommand

Graphe d'héritage de SetConfigurationCommand:

Fonctions membres publiques
	setOptions ($options)
	getOptions ()
	getInitialConfigurationOptions ()
	saveConfiguration ($options)
	checkDb ($options)
	sanitizeOptions (array $options)
Fonctions membres publiques hérités de AbstractCommand
	__construct (?string $name=null)
	addArgument (string $name, ?int $mode=null, string $description='', $default=null)
	addOption (string $name, $shortcut=null, ?int $mode=null, $description='', $default=null)
	execute (InputInterface $input, OutputInterface $output)
	getAliases ()
	getApplication ()
	getDefinition ()
	getDescription ()
	getHelp ()
	getHelperSet ()
	getName ()
	getProcessedHelp ()
	getSynopsis (bool $short=false)
	isEnabled ()
	isHidden ()
	mergeApplicationDefinition (bool $mergeArgs=true)
	setAliases (array $aliases)
	setApplication (?Application $application=null)
	setDefinition ($definition)
	setDescription (string $description)
	setHelp (string $help)
	setHelperSet (HelperSet $helperSet)
	setHidden (bool $hidden)
	setName (string $name)

Champs de données
const	CONFIG_SET_SUCCESSFUL = 0
const	CONFIG_SET_FAILED = 1
const	CONFIG_VALIDATION_FAILED = 2
const	CONFIG_OPTIONS_WRONG = 3
const	DB_VALIDATION_FAILED = 4

Fonctions membres protégées
	configure ()
	doExecute (InputInterface $input, OutputInterface $output)
Fonctions membres protégées hérités de AbstractCommand
	configure ()
	doExecute (InputInterface $input, OutputInterface $output)
	initialise (InputInterface $input, OutputInterface $output)

Attributs protégés statiques
static	$defaultName = 'config:set'
Attributs protégés statiques hérités de AbstractCommand
static	$defaultName

Fonctions membres privées
	configureIO (InputInterface $input, OutputInterface $output)
	retrieveOptionsFromInput (array $options)
	validateOptions ()

Attributs privés
	$cliInput
	$ioStyle
	$options

Membres hérités additionnels
Fonctions membres publiques statiques hérités de AbstractCommand
static	getDefaultName ()

Description détaillée

Console command Setting Configuration options

Depuis

4.0.0

Documentation des fonctions membres

checkDb()

checkDb

(

$options

)

Verifies database connection

Paramètres

array

$options

Options array

Renvoie

boolean|

Depuis

4.0.0

Exceptions

Références $app, $db, $model, $options, $settings, $value, Text\_(), DatabaseDriver\getInstance(), et Text\sprintf().

configure()

configure ( )

protected

Initialise the command.

Renvoie

void

Depuis

4.0.0

Références InputArgument\IS_ARRAY, et InputArgument\REQUIRED.

configureIO()

configureIO ( InputInterface  $input, OutputInterface  $output  )

private

Configures the IO

Paramètres

InputInterface	$input	Console Input
OutputInterface	$output	Console Output

Renvoie

void

Depuis

4.0.0

Références $input, $language, $output, Factory\getLanguage(), JPATH_ADMINISTRATOR, JPATH_INSTALLATION, et null.

doExecute()

doExecute ( InputInterface  $input, OutputInterface  $output  )

protected

Internal function to execute the command.

Paramètres

InputInterface	$input	The input to inject into the command.
OutputInterface	$output	The output to inject into the command.

Renvoie

integer The command exit code

Depuis

4.0.0

Exceptions

Références $input, $options, et $output.

getInitialConfigurationOptions()

getInitialConfigurationOptions

(

)

Returns Default configuration Object

Renvoie

Registry

Depuis

4.0.0

getOptions()

getOptions

(

)

Collects the options array

Renvoie

array|mixed

Depuis

4.0.0

retrieveOptionsFromInput()

retrieveOptionsFromInput ( array  $options )

private

Collects options from user input

Paramètres

array

$options

Options input by users

Renvoie

boolean

Depuis

4.0.0

Références $option, $options, et $value.

sanitizeOptions()

sanitizeOptions

(

array

$options

)

Sanitize the options array for boolean

Paramètres

array

$options

Options array

Renvoie

array

Depuis

4.0.0

Références $key, $options, $value, false, et true.

saveConfiguration()

saveConfiguration

(

$options

)

Save the configuration file

Paramètres

array

$options

Options array

Renvoie

boolean

Depuis

4.0.0

Références $app, $model, $options, et Text\_().

setOptions()

setOptions

(

$options

)

Sets the options array

Paramètres

string

$options

Options string

Depuis

4.0.0

Renvoie

void

Références $options.

validateOptions()

validateOptions ( )

private

Validates the options provided

Renvoie

boolean

Depuis

4.0.0

Références $config, $key, et $value.

Documentation des champs

$cliInput

$cliInput

private

$defaultName

$defaultName = 'config:set'

staticprotected

$ioStyle

$ioStyle

private

$options

$options

private

CONFIG_OPTIONS_WRONG

const CONFIG_OPTIONS_WRONG = 3

Return code if options are wrong

Depuis

4.0.0

CONFIG_SET_FAILED

const CONFIG_SET_FAILED = 1

Return code if configuration set failed

Depuis

4.0.0

CONFIG_SET_SUCCESSFUL

const CONFIG_SET_SUCCESSFUL = 0

Return code if configuration is set successfully

Depuis

4.0.0

CONFIG_VALIDATION_FAILED

const CONFIG_VALIDATION_FAILED = 2

Return code if config validation failed

Depuis

4.0.0

DB_VALIDATION_FAILED

const DB_VALIDATION_FAILED = 4

Return code if database validation failed

Depuis

4.0.0

---

La documentation de cette classe a été générée à partir du fichier suivant :

• SetConfigurationCommand.php