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.
__construct( ConsoleOptionParser $parser )
Build the help formatter for an OptionParser
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( array $collection )
Iterate over a collection and find the longest named thing.
text( integer $width 72 )
Get the help as formatted text suitable for output on the command line.
xml( boolean $string true )
Get the help as an xml string.
© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.