TextDescriptor
Extends TextDescriptorText object descriptor.
| since |
2.0.0 |
|---|---|
| package |
Joomla Framework |
Methods
describe
Describes an object.
describe(\Symfony\Component\Console\Output\OutputInterface output, object object, array options = []) : void
| since |
2.0.0 |
|---|
Arguments
- output
\Symfony\Component\Console\Output\OutputInterfaceThe output object to use.- object
objectThe object to describe.- options
arrayDescriptor options.
describeConsoleCommand
Describes a command.
describeConsoleCommand(\Joomla\Console\Command\AbstractCommand command, array options) : void
| since |
2.0.0 |
|---|
Arguments
- command
\Joomla\Console\Command\AbstractCommandThe command being described.- options
arrayDescriptor options.
describeJoomlaApplication
Describes an application.
describeJoomlaApplication(\Joomla\Console\Application app, array options) : void
| since |
2.0.0 |
|---|
Arguments
- app
\Joomla\Console\ApplicationThe application being described.- options
arrayDescriptor options.
getColumnWidth
Calculate the column width for a group of commands.
getColumnWidth(\Joomla\Console\Command\AbstractCommand[]|string[] commands) : int
| since |
2.0.0 |
|---|
Arguments
- commands
\Joomla\Console\Command\AbstractCommand[]|string[]The commands to use for processing a width.
Response
int
getCommandAliasesText
Formats command aliases to show them in the command description.
getCommandAliasesText(\Joomla\Console\Command\AbstractCommand command) : string
| since |
2.0.0 |
|---|
Arguments
- command
\Joomla\Console\Command\AbstractCommandThe command to process
Response
string
writeText
Writes text to the output.
writeText(string content, array options = []) : void
| since |
2.0.0 |
|---|
Arguments
- content
stringThe message.- options
arrayThe options to use for formatting the output.