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, mixed||string|int options = []) :
| since |
2.0.0 |
|---|
Arguments
- output
OutputInterfaceThe output object to use.- object
objectThe object to describe.- options
array<string|int, mixed>Descriptor options.
Response
void
describeConsoleCommand
Describes a command.
describeConsoleCommand(\Joomla\Console\Command\AbstractCommand command, mixed||string|int options) :
| since |
2.0.0 |
|---|
Arguments
- command
AbstractCommandThe command being described.- options
array<string|int, mixed>Descriptor options.
Response
void
describeJoomlaApplication
Describes an application.
describeJoomlaApplication(\Joomla\Console\Application app, mixed||string|int options) :
| since |
2.0.0 |
|---|
Arguments
- app
ApplicationThe application being described.- options
array<string|int, mixed>Descriptor options.
Response
void
getColumnWidth
Calculate the column width for a group of commands.
getColumnWidth(\Joomla\Console\Command\AbstractCommand[]|string[] commands) :
| since |
2.0.0 |
|---|
Arguments
- commands
array<string|int, AbstractCommand>|array<string|int, 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) :
writeText
Writes text to the output.
writeText( content, mixed||string|int options = []) :
| since |
2.0.0 |
|---|
Arguments
- content
stringThe message.- options
array<string|int, mixed>The options to use for formatting the output.
Response
void