Référence de la classe GetConfigurationCommand

Graphe d'héritage de GetConfigurationCommand:

Fonctions membres publiques
	processGroupOptions ($group)
	getGroups ()
	formatConfig (array $configs)
	processSingleOption ($option)
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	DB_GROUP
const	SESSION_GROUP
const	MAIL_GROUP
const const	CONFIG_GET_SUCCESSFUL = 0
const	CONFIG_GET_GROUP_NOT_FOUND = 1
const	CONFIG_GET_OPTION_NOT_FOUND = 2
const	CONFIG_GET_OPTION_FAILED = 3

Fonctions membres protégées
	formatConfigValue ($value)
	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:get'
Attributs protégés statiques hérités de AbstractCommand
static	$defaultName

Fonctions membres privées
	configureIO (InputInterface $input, OutputInterface $output)

Attributs privés
	$cliInput
	$ioStyle

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

Description détaillée

Console command for displaying configuration options

Depuis

4.0.0

Documentation des fonctions membres

configure()

configure ( )

protected

Initialise the command.

Renvoie

void

Depuis

4.0.0

Références $groups, $key, null, et InputOption\VALUE_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, et $output.

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

Références $input, $key, $option, $options, $output, et $value.

formatConfig()

formatConfig

(

array

$configs

)

Formats the configuration array into desired format

Paramètres

array

$configs

Array of the configurations

Renvoie

array

Depuis

4.0.0

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

formatConfigValue()

formatConfigValue (   $value )

protected

Formats the Configuration value

Paramètres

mixed

$value

Value to be formatted

Renvoie

string

Depuis

4.0.0

Références $value, elseif, et null.

getGroups()

getGroups

(

)

Gets the defined option groups

Renvoie

array

Depuis

4.0.0

processGroupOptions()

processGroupOptions

(

$group

)

Displays logically grouped options

Paramètres

string

$group

The group to be processed

Renvoie

integer

Depuis

4.0.0

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

processSingleOption()

processSingleOption

(

$option

)

Handles the command when a single option is requested

Paramètres

string

$option

The option we want to get its value

Renvoie

integer

Depuis

4.0.0

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

Documentation des champs

$cliInput

$cliInput

private

$defaultName

$defaultName = 'config:get'

staticprotected

$ioStyle

$ioStyle

private

CONFIG_GET_GROUP_NOT_FOUND

const CONFIG_GET_GROUP_NOT_FOUND = 1

Return code if configuration group option is not found

Depuis

4.0.0

CONFIG_GET_OPTION_FAILED

const CONFIG_GET_OPTION_FAILED = 3

Return code if the command has been invoked with wrong options

Depuis

4.0.0

CONFIG_GET_OPTION_NOT_FOUND

const CONFIG_GET_OPTION_NOT_FOUND = 2

Return code if configuration option is not found

Depuis

4.0.0

CONFIG_GET_SUCCESSFUL

const const CONFIG_GET_SUCCESSFUL = 0

Return code if configuration is get successfully

Depuis

4.0.0

DB_GROUP

const DB_GROUP

Valeur initiale :

= [
        'name' => 'db'

MAIL_GROUP

const MAIL_GROUP

Valeur initiale :

= [
        'name' => 'mail'

SESSION_GROUP

const SESSION_GROUP

Valeur initiale :

= [
        'name' => 'session'

---

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

• GetConfigurationCommand.php