TextDescriptor Class Reference

Inheritance diagram for TextDescriptor:

Protected Member Functions
	describeInputArgument (InputArgument $argument, array $options=array())
	describeInputOption (InputOption $option, array $options=array())
	describeInputDefinition (InputDefinition $definition, array $options=array())
	describeCommand (Command $command, array $options=array())
	describeApplication (Application $application, array $options=array())
Protected Member Functions inherited from Descriptor
	write ($content, $decorated=false)
	describeInputArgument (InputArgument $argument, array $options=array())
	describeInputOption (InputOption $option, array $options=array())
	describeInputDefinition (InputDefinition $definition, array $options=array())
	describeCommand (Command $command, array $options=array())
	describeApplication (Application $application, array $options=array())

Private Member Functions
	writeText ($content, array $options=array())
	formatDefaultValue ($default)
	getColumnWidth (array $commands)
	calculateTotalWidthForOptions ($options)

Additional Inherited Members
Public Member Functions inherited from Descriptor
	describe (OutputInterface $output, $object, array $options=array())

Detailed Description

Text descriptor.

Author

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

Definition at line 27 of file TextDescriptor.php.

Member Function Documentation

calculateTotalWidthForOptions (   $options )

private

Parameters

InputOption[]

$options

Returns

int

Definition at line 269 of file TextDescriptor.php.

Referenced by TextDescriptor\describeInputDefinition(), and TextDescriptor\describeInputOption().

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

protected

{}

Definition at line 167 of file TextDescriptor.php.

References TextDescriptor\describeInputDefinition(), TextDescriptor\getColumnWidth(), Application\getDefinition(), Command\getDescription(), Application\getHelp(), Command\getName(), ApplicationDescription\GLOBAL_NAMESPACE, and TextDescriptor\writeText().

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

protected

{}

Definition at line 135 of file TextDescriptor.php.

References TextDescriptor\describeInputDefinition(), Command\getAliases(), InputDefinition\getArguments(), Command\getNativeDefinition(), InputDefinition\getOptions(), Command\getProcessedHelp(), Command\getSynopsis(), Command\getUsages(), Command\mergeApplicationDefinition(), and TextDescriptor\writeText().

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

protected

{}

Definition at line 32 of file TextDescriptor.php.

References TextDescriptor\formatDefaultValue(), InputArgument\getDefault(), InputArgument\getDescription(), InputArgument\getName(), and TextDescriptor\writeText().

Referenced by TextDescriptor\describeInputDefinition().

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

protected

{}

Definition at line 93 of file TextDescriptor.php.

References TextDescriptor\calculateTotalWidthForOptions(), TextDescriptor\describeInputArgument(), TextDescriptor\describeInputOption(), InputDefinition\getArguments(), InputArgument\getName(), InputDefinition\getOptions(), InputOption\getShortcut(), and TextDescriptor\writeText().

Referenced by TextDescriptor\describeApplication(), and TextDescriptor\describeCommand().

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

protected

{}

Definition at line 55 of file TextDescriptor.php.

References InputOption\acceptValue(), TextDescriptor\calculateTotalWidthForOptions(), TextDescriptor\formatDefaultValue(), InputOption\getDefault(), InputOption\getDescription(), InputOption\getName(), InputOption\getShortcut(), InputOption\isArray(), InputOption\isValueOptional(), and TextDescriptor\writeText().

Referenced by TextDescriptor\describeInputDefinition().

formatDefaultValue (   $default )

private

Formats input option/argument default value.

Parameters

mixed

$default

Returns

string

Definition at line 236 of file TextDescriptor.php.

Referenced by TextDescriptor\describeInputArgument(), and TextDescriptor\describeInputOption().

getColumnWidth ( array  $commands )

private

Parameters

Command[]

$commands

Returns

int

Definition at line 250 of file TextDescriptor.php.

Referenced by TextDescriptor\describeApplication().

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

private

{}

Definition at line 221 of file TextDescriptor.php.

References Descriptor\write().

Referenced by TextDescriptor\describeApplication(), TextDescriptor\describeCommand(), TextDescriptor\describeInputArgument(), TextDescriptor\describeInputDefinition(), and TextDescriptor\describeInputOption().