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.

Namespace: Cake\Console

Properties summary

  • $_alias protected
    string

    Alias to display in the output.

  • $_maxArgs protected
    int

    The maximum number of arguments shown when generating usage.

  • $_maxOptions protected
    int

    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.

  • _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

string

_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

int

setAlias() public 

setAlias(string $alias)

Set the alias

Parameters

string $alias

The alias

text() public 

text(int $width)

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

Parameters

int $width optional

The width of the help output.

Returns

string

xml() public 

xml(bool $string)

Get the help as an XML string.

Parameters

bool $string optional

Return the SimpleXml object or a string. Defaults to true.

Returns

string|\SimpleXMLElement

See $string

Property Detail

$_alias protected

Alias to display in the output.

Type

string

$_maxArgs protected

The maximum number of arguments shown when generating usage.

Type

int

$_maxOptions protected

The maximum number of options shown when generating usage.

Type

int

$_parser protected

Option parser.

Type

\Cake\Console\ConsoleOptionParser

© 2005–present 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/4.1/class-Cake.Console.HelpFormatter.html