Docs4dev
Docs
cakephp / 2.10 / class-helpformatter.html

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.

Package: Cake\Console
Since: CakePHP(tm) v 2.0
Copyright: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
License: MIT License
Location: Cake/Console/HelpFormatter.php

Properties summary

  • $_maxArgs protected
    integer
    The maximum number of arguments shown when generating usage.
  • $_maxOptions protected
    integer
    The maximum number of options shown when generating usage.

Method Summary

  • 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.
  • 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()source public

__construct( ConsoleOptionParser $parser )

Build the help formatter for an OptionParser

Parameters

ConsoleOptionParser $parser
The option parser help is being generated for.

_generateUsage()source 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

string

_getMaxLength()source 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

integer

text()source public

text( integer $width 72 )

Get the help as formatted text suitable for output on the command line.

Parameters

integer $width optional 72
The width of the help output.

Returns

string

xml()source public

xml( boolean $string true )

Get the help as an xml string.

Parameters

boolean $string optional true
Return the SimpleXml object or a string. Defaults to true.

Returns

string|SimpleXmlElement
See $string

Properties detail

$_maxArgssource

protected integer

The maximum number of arguments shown when generating usage.

6

$_maxOptionssource

protected integer

The maximum number of options shown when generating usage.

6

© 2005–2017 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.
https://api.cakephp.org/2.10/class-HelpFormatter.html