ReStructuredTextDescriptor
extends Descriptor
in package
Table of Contents
Properties
- $chapterChar : string
- $paragraphsChar : string
- $partChar : string
- $sectionChar : string
- $subsectionChar : string
- $subsubsectionChar : string
- $visibleNamespaces : array<string|int, mixed>
Methods
- describe() : void
- describeApplication() : void
- describeCommand() : void
- describeInputArgument() : void
- describeInputDefinition() : void
- describeInputOption() : void
- write() : void
- Override parent method to set $decorated = true.
- createTableOfContents() : void
- describeCommands() : void
- getApplicationTitle() : string
- getNonDefaultOptions() : array<string|int, mixed>
- removeAliasesAndHiddenCommands() : array<string|int, mixed>
- setVisibleNamespaces() : void
Properties
$chapterChar
private
string
$chapterChar
= '-'
$paragraphsChar
private
string
$paragraphsChar
= '"'
$partChar
private
string
$partChar
= '='
$sectionChar
private
string
$sectionChar
= '~'
$subsectionChar
private
string
$subsectionChar
= '.'
$subsubsectionChar
private
string
$subsubsectionChar
= '^'
$visibleNamespaces
private
array<string|int, mixed>
$visibleNamespaces
= []
Methods
describe()
public
describe(OutputInterface $output, object $object[, array<string|int, mixed> $options = [] ]) : void
Parameters
- $output : OutputInterface
- $object : object
- $options : array<string|int, mixed> = []
describeApplication()
protected
describeApplication(Application $application[, array<string|int, mixed> $options = [] ]) : void
Parameters
- $application : Application
- $options : array<string|int, mixed> = []
describeCommand()
protected
describeCommand(Command $command[, array<string|int, mixed> $options = [] ]) : void
Parameters
- $command : Command
- $options : array<string|int, mixed> = []
describeInputArgument()
protected
describeInputArgument(InputArgument $argument[, array<string|int, mixed> $options = [] ]) : void
Parameters
- $argument : InputArgument
- $options : array<string|int, mixed> = []
describeInputDefinition()
protected
describeInputDefinition(InputDefinition $definition[, array<string|int, mixed> $options = [] ]) : void
Parameters
- $definition : InputDefinition
- $options : array<string|int, mixed> = []
describeInputOption()
protected
describeInputOption(InputOption $option[, array<string|int, mixed> $options = [] ]) : void
Parameters
- $option : InputOption
- $options : array<string|int, mixed> = []
write()
Override parent method to set $decorated = true.
protected
write(string $content[, bool $decorated = true ]) : void
Parameters
- $content : string
- $decorated : bool = true
createTableOfContents()
private
createTableOfContents(ApplicationDescription $description, Application $application) : void
Parameters
- $description : ApplicationDescription
- $application : Application
describeCommands()
private
describeCommands(mixed $application, array<string|int, mixed> $options) : void
Parameters
- $application : mixed
- $options : array<string|int, mixed>
getApplicationTitle()
private
getApplicationTitle(Application $application) : string
Parameters
- $application : Application
Return values
stringgetNonDefaultOptions()
private
getNonDefaultOptions(InputDefinition $definition) : array<string|int, mixed>
Parameters
- $definition : InputDefinition
Return values
array<string|int, mixed>removeAliasesAndHiddenCommands()
private
removeAliasesAndHiddenCommands(array<string|int, mixed> $commands) : array<string|int, mixed>
Parameters
- $commands : array<string|int, mixed>
Return values
array<string|int, mixed>setVisibleNamespaces()
private
setVisibleNamespaces(ApplicationDescription $description) : void
Parameters
- $description : ApplicationDescription