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.
Method Detail
__constructsource 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.
_generateUsagesource 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
stringstring
_getMaxLengthsource 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
integerint
textsource public
text( integer $width 72 )
Get the help as formatted text suitable for output on the command line.
Parameters
- integer
$widthoptional 72 - The width of the help output.
Returns
stringstring
xmlsource public
xml( boolean $string true )
Get the help as an xml string.
Parameters
- boolean
$stringoptional true - Return the SimpleXml object or a string. Defaults to true.
Returns
string|SimpleXmlElementSee $string
Properties summary
© 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.
http://api.cakephp.org/3.1/class-Cake.Console.HelpFormatter.html