Référence de la classe TextDescriptor

Graphe d'héritage de TextDescriptor:

Fonctions membres protégées
	describeInputArgument (InputArgument $argument, array $options=[])
	describeInputOption (InputOption $option, array $options=[])
	describeInputDefinition (InputDefinition $definition, array $options=[])
	describeCommand (Command $command, array $options=[])
	describeApplication (Application $application, array $options=[])
Fonctions membres protégées hérités de Descriptor
	write (string $content, bool $decorated=false)
	describeInputArgument (InputArgument $argument, array $options=[])
	describeInputOption (InputOption $option, array $options=[])
	describeInputDefinition (InputDefinition $definition, array $options=[])
	describeCommand (Command $command, array $options=[])
	describeApplication (Application $application, array $options=[])

Fonctions membres privées
	writeText (string $content, array $options=[])
	getCommandAliasesText (Command $command)
	formatDefaultValue ($default)
	getColumnWidth (array $commands)
	calculateTotalWidthForOptions (array $options)

Membres hérités additionnels
Fonctions membres publiques hérités de Descriptor
	describe (OutputInterface $output, object $object, array $options=[])
Attributs protégés hérités de Descriptor
	$output

Description détaillée

Text descriptor.

Auteur

Jean-François Simon conta.nosp@m.ct@j.nosp@m.fsimo.nosp@m.n.fr

Documentation des fonctions membres

calculateTotalWidthForOptions()

calculateTotalWidthForOptions ( array  $options )

private

Paramètres

InputOption[]

$options

Références $option, $options, elseif, et Helper\width().

Référencé par TextDescriptor\describeInputDefinition(), et TextDescriptor\describeInputOption().

describeApplication()

describeApplication ( Application  $application, array  $options = []  )

protected

{}

Références $description, $name, $namespace, $options, $width, TextDescriptor\describeInputDefinition(), TextDescriptor\getColumnWidth(), TextDescriptor\getCommandAliasesText(), Application\getDefinition(), Application\getHelp(), ApplicationDescription\GLOBAL_NAMESPACE, null, Helper\width(), et TextDescriptor\writeText().

describeCommand()

describeCommand ( Command  $command, array  $options = []  )

protected

{}

Références $description, $options, TextDescriptor\describeInputDefinition(), OutputFormatter\escape(), Command\getAliases(), Command\getDefinition(), Command\getDescription(), Command\getProcessedHelp(), Command\getSynopsis(), Command\getUsages(), Command\mergeApplicationDefinition(), et TextDescriptor\writeText().

describeInputArgument()

describeInputArgument ( InputArgument  $argument, array  $options = []  )

protected

{}

Références $default, $options, TextDescriptor\formatDefaultValue(), InputArgument\getDefault(), InputArgument\getDescription(), InputArgument\getName(), null, Helper\width(), et TextDescriptor\writeText().

Référencé par TextDescriptor\describeInputDefinition().

describeInputDefinition()

describeInputDefinition ( InputDefinition  $definition, array  $options = []  )

protected

{}

Références $option, $options, TextDescriptor\calculateTotalWidthForOptions(), TextDescriptor\describeInputArgument(), TextDescriptor\describeInputOption(), InputDefinition\getArguments(), InputDefinition\getOptions(), Helper\width(), et TextDescriptor\writeText().

Référencé par TextDescriptor\describeApplication(), TextDescriptor\describeCommand(), TextDescriptor\describeConsoleCommand(), et TextDescriptor\describeJoomlaApplication().

describeInputOption()

describeInputOption ( InputOption  $option, array  $options = []  )

protected

{}

Références $default, $option, $options, $value, TextDescriptor\calculateTotalWidthForOptions(), TextDescriptor\formatDefaultValue(), InputOption\getDefault(), null, Helper\width(), et TextDescriptor\writeText().

Référencé par TextDescriptor\describeInputDefinition().

formatDefaultValue()

formatDefaultValue (   $default )

private

Formats input option/argument default value.

Paramètres

mixed

$default

Références $default, $key, $value, elseif, et OutputFormatter\escape().

Référencé par TextDescriptor\describeInputArgument(), et TextDescriptor\describeInputOption().

getColumnWidth()

getColumnWidth ( array  $commands )

private

Paramètres

array<Command|string>

$commands

Références Helper\width().

Référencé par TextDescriptor\describeApplication().

getCommandAliasesText()

getCommandAliasesText ( Command  $command )

private

Formats command aliases to show them in the command description.

Références $text, et Command\getAliases().

Référencé par TextDescriptor\describeApplication().

writeText()

writeText ( string  $content, array  $options = []  )

private

{}

Références $content, $options, et Descriptor\write().

Référencé par TextDescriptor\describeApplication(), TextDescriptor\describeCommand(), TextDescriptor\describeInputArgument(), TextDescriptor\describeInputDefinition(), et TextDescriptor\describeInputOption().

---

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

• symfony/console/Descriptor/TextDescriptor.php