Abstract Class Horde_Argv_HelpFormatter

Description

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.

  • abstract:

Located in /Argv/lib/Horde/Argv/HelpFormatter.php (line 58)


	
			
Direct descendents
Class Description
 class Horde_Argv_IndentedHelpFormatter Format help with indented section bodies.
 class Horde_Argv_TitledHelpFormatter Format help with underlined section headers.
Class Constant Summary
 NO_DEFAULT_VALUE = 'none'
Variable Summary
 mixed $parser
Method Summary
 Horde_Argv_HelpFormatter __construct ( $indent_increment,  $max_help_position, [ $width = null], [ $short_first = false])
 void dedent ()
 void expandDefault ( $option)
 void formatDescription ( $description)
 void formatEpilog ( $epilog)
 void formatHeading ( $heading)
 void formatOption ( $option)
 void formatOptionStrings ( $option)
 void formatUsage ( $usage)
 void indent ()
 void setLongOptDelimiter ( $delim)
 void setParser ( $parser)
 void setShortOptDelimiter ( $delim)
 void storeOptionStrings ( $parser)
 void _formatText ( $text)
Variables
mixed $parser = null (line 62)
  • access: public
Methods
Constructor __construct (line 64)
  • access: public
Horde_Argv_HelpFormatter __construct ( $indent_increment,  $max_help_position, [ $width = null], [ $short_first = false])
  • $indent_increment
  • $max_help_position
  • $width
  • $short_first

Redefined in descendants as:
dedent (line 114)
  • access: public
void dedent ()
expandDefault (line 154)
  • access: public
void expandDefault ( $option)
  • $option
formatDescription (line 136)
  • access: public
void formatDescription ( $description)
  • $description
formatEpilog (line 145)
  • access: public
void formatEpilog ( $epilog)
  • $epilog
formatHeading (line 123)
  • abstract:
  • access: public
void formatHeading ( $heading)
  • $heading

Redefined in descendants as:
formatOption (line 184)

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")

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

  • access: public
void formatOption ( $option)
  • $option
formatOptionStrings (line 237)

Return a comma-separated list of option strings & metavariables.

  • access: public
void formatOptionStrings ( $option)
  • $option
formatUsage (line 121)
  • abstract:
  • access: public
void formatUsage ( $usage)
  • $usage

Redefined in descendants as:
indent (line 108)
  • access: public
void indent ()
setLongOptDelimiter (line 100)
  • access: public
void setLongOptDelimiter ( $delim)
  • $delim
setParser (line 87)
  • access: public
void setParser ( $parser)
  • $parser
setShortOptDelimiter (line 92)
  • access: public
void setShortOptDelimiter ( $delim)
  • $delim
storeOptionStrings (line 211)
  • access: public
void storeOptionStrings ( $parser)
  • $parser
_formatText (line 129)

Format a paragraph of free-form text for inclusion in the help output at the current indentation level.

  • access: protected
void _formatText ( $text)
  • $text
Class Constants
NO_DEFAULT_VALUE = 'none' (line 60)

Documentation generated on Sun, 30 Jan 2011 05:17:58 +0000 by phpDocumentor 1.4.3