Référence de la classe TextDescriptor

Graphe d'héritage de TextDescriptor:

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

Fonctions membres privées
	getCommandAliasesText (AbstractCommand $command)
	describeConsoleCommand (AbstractCommand $command, array $options)
	describeJoomlaApplication (Application $app, array $options)
	getColumnWidth (array $commands)
	writeText ($content, array $options=[])

Membres hérités additionnels
Fonctions membres protégées hérités de TextDescriptor
	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=[])
Attributs protégés hérités de Descriptor
	$output

Description détaillée

Text object descriptor.

Depuis

2.0.0

Documentation des fonctions membres

describe()

describe	(	OutputInterface	$output,
			$object,
		array	$options = []
	)

Describes an object.

Paramètres

OutputInterface	$output	The output object to use.
object	$object	The object to describe.
array	$options	Descriptor options.

Renvoie

void

Depuis

2.0.0

Références $options, Descriptor\$output, TextDescriptor\describeConsoleCommand(), et TextDescriptor\describeJoomlaApplication().

describeConsoleCommand()

describeConsoleCommand ( AbstractCommand  $command, array  $options  )

private

Describes a command.

Paramètres

AbstractCommand	$command	The command being described.
array	$options	Descriptor options.

Renvoie

void

Depuis

2.0.0

Références $options, TextDescriptor\describeInputDefinition(), AbstractCommand\getAliases(), AbstractCommand\getDefinition(), AbstractCommand\getProcessedHelp(), AbstractCommand\getSynopsis(), AbstractCommand\mergeApplicationDefinition(), et TextDescriptor\writeText().

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

describeJoomlaApplication()

describeJoomlaApplication ( Application  $app, array  $options  )

private

Describes an application.

Paramètres

Application	$app	The application being described.
array	$options	Descriptor options.

Renvoie

void

Depuis

2.0.0

Références $app, $description, $name, $namespace, $options, $version, $width, TextDescriptor\describeInputDefinition(), TextDescriptor\getColumnWidth(), TextDescriptor\getCommandAliasesText(), ApplicationDescription\GLOBAL_NAMESPACE, StringHelper\strlen(), et TextDescriptor\writeText().

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

getColumnWidth()

getColumnWidth ( array  $commands )

private

Calculate the column width for a group of commands.

Paramètres

AbstractCommand[]|string[]

$commands The commands to use for processing a width.

Renvoie

integer

Depuis

2.0.0

Références StringHelper\strlen().

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

getCommandAliasesText()

getCommandAliasesText ( AbstractCommand  $command )

private

Formats command aliases to show them in the command description.

Paramètres

AbstractCommand

$command

The command to process

Renvoie

string

Depuis

2.0.0

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

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

writeText()

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

private

Writes text to the output.

Paramètres

string	$content	The message.
array	$options	The options to use for formatting the output.

Renvoie

void

Depuis

2.0.0

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

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

---

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

• joomla/console/src/Descriptor/TextDescriptor.php