TitledHelpFormatter
extends HelpFormatter
in package
Format help with underlined section headers.
Tags
Table of Contents
- NO_DEFAULT_VALUE = 'none'
- $parser : mixed
- __construct() : mixed
- dedent() : mixed
- expandDefault() : mixed
- formatDescription() : mixed
- formatEpilog() : mixed
- formatHeading() : mixed
- formatOption() : mixed
- The help for each option consists of two parts: * the opt strings and metavars eg. ("-x", or "-fFILENAME, --file=FILENAME") * the user-supplied help string eg. ("turn on expert mode", "read data from FILENAME")
- formatOptionStrings() : mixed
- Return a comma-separated list of option strings & metavariables.
- formatUsage() : mixed
- highlightHeading() : mixed
- Highlights with the heading color.
- highlightOption() : mixed
- Highlights with the option color.
- indent() : mixed
- setLongOptDelimiter() : mixed
- setParser() : mixed
- setShortOptDelimiter() : mixed
- storeOptionStrings() : mixed
- _formatText() : mixed
- Format a paragraph of free-form text for inclusion in the help output at the current indentation level.
Constants
NO_DEFAULT_VALUE
public
mixed
NO_DEFAULT_VALUE
= 'none'
Properties
$parser
public
mixed
$parser
= null
Methods
__construct()
public
__construct(mixed $indent_increment[, mixed $max_help_position = 24 ][, mixed $width = null ][, mixed $short_first = false ][, mixed $color = null ]) : mixed
Parameters
- $indent_increment : mixed
- $max_help_position : mixed = 24
- $width : mixed = null
- $short_first : mixed = false
- $color : mixed = null
Return values
mixed —dedent()
public
dedent() : mixed
Return values
mixed —expandDefault()
public
expandDefault(mixed $option) : mixed
Parameters
- $option : mixed
Return values
mixed —formatDescription()
public
formatDescription(mixed $description) : mixed
Parameters
- $description : mixed
Return values
mixed —formatEpilog()
public
formatEpilog(mixed $epilog) : mixed
Parameters
- $epilog : mixed
Return values
mixed —formatHeading()
public
formatHeading(mixed $heading) : mixed
Parameters
- $heading : mixed
Return values
mixed —formatOption()
The help for each option consists of two parts: * the opt strings and metavars eg. ("-x", or "-fFILENAME, --file=FILENAME") * the user-supplied help string eg. ("turn on expert mode", "read data from FILENAME")
public
formatOption(mixed $option) : mixed
If possible, we write both of these on the same line: -x turn on expert mode
But if the opt string list is too long, we put the help string on a second line, indented to the same column it would start in if it fit on the first line. -fFILENAME, --file=FILENAME read data from FILENAME
Parameters
- $option : mixed
Return values
mixed —formatOptionStrings()
Return a comma-separated list of option strings & metavariables.
public
formatOptionStrings(mixed $option) : mixed
Parameters
- $option : mixed
Return values
mixed —formatUsage()
public
formatUsage(mixed $usage) : mixed
Parameters
- $usage : mixed
Return values
mixed —highlightHeading()
Highlights with the heading color.
public
highlightHeading(string $heading) : mixed
Parameters
- $heading : string
-
A heading text.
Tags
Return values
mixed —highlightOption()
Highlights with the option color.
public
highlightOption(string $option) : mixed
Parameters
- $option : string
-
An option text.
Tags
Return values
mixed —indent()
public
indent() : mixed
Return values
mixed —setLongOptDelimiter()
public
setLongOptDelimiter(mixed $delim) : mixed
Parameters
- $delim : mixed
Return values
mixed —setParser()
public
setParser(mixed $parser) : mixed
Parameters
- $parser : mixed
Return values
mixed —setShortOptDelimiter()
public
setShortOptDelimiter(mixed $delim) : mixed
Parameters
- $delim : mixed
Return values
mixed —storeOptionStrings()
public
storeOptionStrings(mixed $parser) : mixed
Parameters
- $parser : mixed
Return values
mixed —_formatText()
Format a paragraph of free-form text for inclusion in the help output at the current indentation level.
protected
_formatText(mixed $text) : mixed
Parameters
- $text : mixed