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
-
$_aliasprotectedstringAlias to display in the output. -
$_maxArgsprotectedintegerThe maximum number of arguments shown when generating usage. -
$_maxOptionsprotectedintegerThe maximum number of options shown when generating usage. -
$_parserprotectedOption 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() public ¶
__construct( Cake\Console\ConsoleOptionParser $parser )
Build the help formatter for an OptionParser
Parameters
-
Cake\Console\ConsoleOptionParser$parser - The option parser help is being generated for.
_generateUsage() protected ¶
_generateUsage( )
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 []
Returns
_getMaxLength() protected ¶
_getMaxLength( array $collection )
Iterate over a collection and find the longest named thing.
Parameters
- array $collection
- The collection to find a max length of.
Returns
setAlias() public ¶
setAlias( string $alias )
Set the alias
Parameters
- string $alias
- The alias