Documentation

HelpFormatter
in package

Provides HelpFormatter, used by Horde_Argv_Parser to generate formatted help text.

Abstract base class for formatting option help. Horde_Argv_Parser instances should use one of the HelpFormatter subclasses for formatting help; by default IndentedHelpFormatter is used.

Instance attributes: parser : Horde_Argv_Parser the controlling Horde_Argv_Parser instance _color : Horde_Cli_Color @since Horde_Argv 2.1.0 a color formatter indent_increment : int the number of columns to indent per nesting level max_help_position : int the maximum starting column for option help text help_position : int the calculated starting column for option help text; initially the same as the maximum width : int total number of columns for output (automatically detected by default) level : int current indentation level current_indent : int current indentation level (in columns) help_width : int number of columns available for option help text (calculated) default_tag : str text to replace with each option's default value, "%default" by default. Set to false value to disable default value expansion. option_strings : { Option : str } maps Option instances to the snippet of help text explaining the syntax of that option, e.g. "-h, --help" or "-fFILE, --file=FILE" _short_opt_fmt : str format string controlling how short options with values are printed in help text. Must be either "%s%s" ("-fFILE") or "%s %s" ("-f FILE"), because those are the two syntaxes that Horde_Argv supports. _long_opt_fmt : str similar but for long options; must be either "%s %s" ("--file FILE") or "%s=%s" ("--file=FILE").

Tags
category

Horde

author

Chuck Hagenbuch chuck@horde.org

author

Mike Naberezny mike@maintainable.com

copyright

2010-2017 Horde LLC

license

http://www.horde.org/licenses/bsd BSD

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

Properties

Methods

__construct()

public __construct(mixed $indent_increment, mixed $max_help_position[, mixed $width = null ][, mixed $short_first = false ][, mixed $color = null ]) : mixed
Parameters
$indent_increment : mixed
$max_help_position : mixed
$width : mixed = null
$short_first : mixed = false
$color : mixed = null
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 abstract 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 abstract 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
since

Horde_Argv 2.1.0

retun

string The colored text.

Return values
mixed —

highlightOption()

Highlights with the option color.

public highlightOption(string $option) : mixed
Parameters
$option : string

An option text.

Tags
since

Horde_Argv 2.1.0

retun

string The colored text.

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
Return values
mixed —

Search results