Overview

Namespaces

  • Webmozart
    • Console
      • Adapter
      • Api
        • Application
        • Args
          • Format
        • Command
        • Config
        • Event
        • Formatter
        • IO
        • Resolver
      • Args
      • Config
      • Formatter
      • Handler
        • Help
      • IO
        • InputStream
        • OutputStream
      • Process
      • Resolver
      • UI
        • Alignment
        • Component
        • Help
        • Layout
        • Style
      • Util

Classes

  • AbstractHelp
  • ApplicationHelp
  • CommandHelp
  • Overview
  • Namespace
  • Class

Class CommandHelp

Renders the help of a console command.

Webmozart\Console\UI\Help\AbstractHelp implements Webmozart\Console\UI\Component
Extended by Webmozart\Console\UI\Help\CommandHelp
Namespace: Webmozart\Console\UI\Help
Author: Bernhard Schussek bschussek@gmail.com
Since: 1.0
Located at UI/Help/CommandHelp.php
Methods summary
public
# __construct( Webmozart\Console\Api\Command\Command $command )

Creates the help.

Creates the help.

Parameters

$command
The command to render.
protected
# renderHelp( Webmozart\Console\UI\Layout\BlockLayout $layout )

Renders the usage.

Renders the usage.

Parameters

$layout
The layout.
protected
# renderUsage( Webmozart\Console\UI\Layout\BlockLayout $layout, Webmozart\Console\Api\Command\Command $command )

Renders the "Usage" section.

Renders the "Usage" section.

Parameters

$layout
The layout.
$command
The command to render.
protected
# renderAliases( Webmozart\Console\UI\Layout\BlockLayout $layout, string[] $aliases )

Renders the aliases of a command.

Renders the aliases of a command.

Parameters

$layout
The layout.
$aliases
The aliases to render.
protected
# renderSubCommands( Webmozart\Console\UI\Layout\BlockLayout $layout, Webmozart\Console\Api\Command\CommandCollection $subCommands )

Renders the "Commands" section.

Renders the "Commands" section.

Parameters

$layout
The layout.
$subCommands
The sub-commands to render.
protected
# renderSubCommand( Webmozart\Console\UI\Layout\BlockLayout $layout, Webmozart\Console\Api\Command\Command $command )

Renders a sub-command in the "Commands" section.

Renders a sub-command in the "Commands" section.

Parameters

$layout
The layout.
$command
The command to render.
protected
# renderSubCommandDescription( Webmozart\Console\UI\Layout\BlockLayout $layout, string $description )

Renders the description of a sub-command.

Renders the description of a sub-command.

Parameters

$layout
The layout.
$description
The description.
protected
# renderSubCommandHelp( Webmozart\Console\UI\Layout\BlockLayout $layout, string $help )

Renders the help text of a sub-command.

Renders the help text of a sub-command.

Parameters

$layout
The layout.
$help
The help text.
protected
# renderSubCommandArguments( Webmozart\Console\UI\Layout\BlockLayout $layout, array $arguments )

Renders the argument descriptions of a sub-command.

Renders the argument descriptions of a sub-command.

Parameters

$layout
The layout.
$arguments
The arguments.
protected
# renderSubCommandOptions( Webmozart\Console\UI\Layout\BlockLayout $layout, array $options )

Renders the option descriptions of a sub-command.

Renders the option descriptions of a sub-command.

Parameters

$layout
The layout.
$options
The options.
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()
Webmozart Console API API documentation generated by ApiGen