Class ApplicationHelp

Renders the help of a console application.

Webmozart\Console\UI\Help\AbstractHelp implements Webmozart\Console\UI\Component

Extended by

Webmozart\Console\UI\Help\ApplicationHelp

Namespace: Webmozart\Console\UI\Help
Author: Bernhard Schussek bschussek@gmail.com
Since: 1.0
Located at UI/Help/ApplicationHelp.php

Methods summary
`public`	# `__construct( Webmozart\Console\Api\Application\Application $application )` Creates the help. Creates the help. Parameters `$application` The application to render.
`protected`	# `renderHelp( Webmozart\Console\UI\Layout\BlockLayout $layout )` Renders the usage. Renders the usage. Parameters `$layout` The layout.
`protected`	# `renderName( Webmozart\Console\UI\Layout\BlockLayout $layout, Webmozart\Console\Api\Application\Application $application )` Renders the application name. Renders the application name. Parameters `$layout` The layout. `$application` The application.
`protected`	# `renderUsage( Webmozart\Console\UI\Layout\BlockLayout $layout, Webmozart\Console\Api\Application\Application $application, Webmozart\Console\Api\Args\Format\ArgsFormat $argsFormat )` Renders the "Usage" section. Renders the "Usage" section. Parameters `$layout` The layout. `$application` The application to describe. `$argsFormat` The format of the console arguments.
`protected`	# `renderCommands( Webmozart\Console\UI\Layout\BlockLayout $layout, Webmozart\Console\Api\Command\CommandCollection $commands )` Renders the "Commands" section. Renders the "Commands" section. Parameters `$layout` The layout. `$commands` The commands to describe.
`protected`	# `renderCommand( Webmozart\Console\UI\Layout\BlockLayout $layout, Webmozart\Console\Api\Command\Command $command )` Renders a command in the "Commands" section. Renders a command in the "Commands" section. Parameters `$layout` The layout. `$command` The command to describe.
`protected`	# `renderDescription( Webmozart\Console\UI\Layout\BlockLayout $layout, string $help )` Renders the "Description" section. Renders the "Description" section. Parameters `$layout` The layout. `$help` The help text.

Methods inherited from Webmozart\Console\UI\Help\AbstractHelp
`formatValue(), render(), renderArgument(), renderArguments(), renderGlobalOptions(), renderOption(), renderOptions(), renderSynopsis()`