PHP Class Webmozart\Console\UI\Help\ApplicationHelp

Since: 1.0
Author: Bernhard Schussek ([email protected])
Inheritance: extends AbstractHelp
Mostra file Open project: webmozart/console Class Usage Examples

Public Methods

Method Description
__construct ( Webmozart\Console\Api\Application\Application $application ) Creates the help.

Protected Methods

Method Description
renderCommand ( BlockLayout $layout, Command $command ) Renders a command in the "Commands" section.
renderCommands ( BlockLayout $layout, CommandCollection $commands ) Renders the "Commands" section.
renderDescription ( BlockLayout $layout, string $help ) Renders the "Description" section.
renderHelp ( BlockLayout $layout )
renderName ( BlockLayout $layout, Webmozart\Console\Api\Application\Application $application ) Renders the application name.
renderUsage ( BlockLayout $layout, Webmozart\Console\Api\Application\Application $application, ArgsFormat $argsFormat ) Renders the "Usage" section.

Method Details

__construct() public method

Creates the help.
public __construct ( Webmozart\Console\Api\Application\Application $application )
$application Webmozart\Console\Api\Application\Application The application to render.

renderCommand() protected method

Renders a command in the "Commands" section.
protected renderCommand ( BlockLayout $layout, Command $command )
$layout Webmozart\Console\UI\Layout\BlockLayout The layout.
$command Webmozart\Console\Api\Command\Command The command to describe.

renderCommands() protected method

Renders the "Commands" section.
protected renderCommands ( BlockLayout $layout, CommandCollection $commands )
$layout Webmozart\Console\UI\Layout\BlockLayout The layout.
$commands Webmozart\Console\Api\Command\CommandCollection The commands to describe.

renderDescription() protected method

Renders the "Description" section.
protected renderDescription ( BlockLayout $layout, string $help )
$layout Webmozart\Console\UI\Layout\BlockLayout The layout.
$help string The help text.

renderHelp() protected method

protected renderHelp ( BlockLayout $layout )
$layout Webmozart\Console\UI\Layout\BlockLayout

renderName() protected method

Renders the application name.
protected renderName ( BlockLayout $layout, Webmozart\Console\Api\Application\Application $application )
$layout Webmozart\Console\UI\Layout\BlockLayout The layout.
$application Webmozart\Console\Api\Application\Application The application.

renderUsage() protected method

Renders the "Usage" section.
protected renderUsage ( BlockLayout $layout, Webmozart\Console\Api\Application\Application $application, ArgsFormat $argsFormat )
$layout Webmozart\Console\UI\Layout\BlockLayout The layout.
$application Webmozart\Console\Api\Application\Application The application to describe.
$argsFormat Webmozart\Console\Api\Args\Format\ArgsFormat The format of the console arguments.