Class HelpFormatter

HelpFormatter formats help for console shells. Can format to either text or XML formats. Uses ConsoleOptionParser methods to generate help.

Generally not directly used. Using $parser->help($command, 'xml'); is usually how you would access help. Or via the --help=xml option on the command line.

Xml output is useful for integration with other tools like IDE's or other build tools.

Properties summary

• $_alias protected
  string
  Alias to display in the output.
• $_maxArgs protected
  integer
  The maximum number of arguments shown when generating usage.
• $_maxOptions protected
  integer
  The maximum number of options shown when generating usage.
• $_parser protected
  Cake\Console\ConsoleOptionParser
  Option parser.

Method Summary

• __construct() public
  Build the help formatter for an OptionParser
• _generateUsage() protected

  Generate the usage for a shell based on its arguments and options. Usage strings favor short options over the long ones. and optional args will be indicated with []

• _getMaxLength() protected
  Iterate over a collection and find the longest named thing.
• setAlias() public
  Set the alias
• text() public
  Get the help as formatted text suitable for output on the command line.
• xml() public
  Get the help as an xml string.

Method Detail

__construct( Cake\Console\ConsoleOptionParser $parser )

_generateUsage( )

_getMaxLength( array $collection )

setAlias( string $alias )

text( integer $width = 72 )

xml( boolean $string = true )

Properties detail

'cake'

6

6