Class Horde_Kolab_Filter_Argv_Parser

Description

Class attributes: standardOptionList : [Option] list of standard options that will be accepted by all instances of this parser class (intended to be overridden by subclasses).

Instance attributes: usage : string a usage string for your program. Before it is displayed to the user, "%prog" will be expanded to the name of your program ($this->prog or os.path.basename(sys.argv[0])). prog : string the name of the current program (to override os.path.basename(sys.argv[0])). epilog : string paragraph of help text to print after option help

optionGroups : [OptionGroup] list of option groups in this parser (option groups are irrelevant for parsing the command-line, but very useful for generating help)

allow_interspersed_args : bool = true if true, positional arguments may be interspersed with options. Assuming -a and -b each take a single argument, the command-line -ablah foo bar -bboo baz will be interpreted the same as -ablah -bboo -- foo bar baz If this flag were false, that command line would be interpreted as -ablah -- foo bar -bboo baz -- ie. we stop processing options as soon as we see the first non-option argument. (This is the tradition followed by Python's getopt module, Perl's Getopt::Std, and other argument- parsing libraries, but it is generally annoying to users.)

rargs : [string] the argument list currently being parsed. Only set when parseArgs() is active, and continually trimmed down as we consume arguments. Mainly there for the benefit of callback options. largs : [string] the list of leftover arguments that we have skipped while parsing options. If allow_interspersed_args is false, this list is always empty. values : Values the set of option values currently being accumulated. Only set when parseArgs() is active. Also mainly for callbacks.

Located in /Kolab_Filter/lib/Horde/Kolab/Filter/Base.php (line 299)

Horde_Argv_OptionContainer
   |
   --Horde_Argv_Parser
      |
      --Horde_Kolab_Filter_Argv_Parser
Method Summary
 void parserError ( $msg)
 void parserExit ([ $status = 0], [ $msg = null])
Variables
Methods
parserError (line 301)
  • access: public
void parserError ( $msg)
  • $msg

Redefinition of:
Horde_Argv_Parser::parserError()
Print a usage message incorporating $msg to stderr and exit.
parserExit (line 306)
  • access: public
void parserExit ([ $status = 0], [ $msg = null])
  • $status
  • $msg

Redefinition of:
Horde_Argv_Parser::parserExit()

Inherited Methods

Inherited From Horde_Argv_Parser

 Horde_Argv_Parser::__construct()
 Horde_Argv_Parser::addOptionGroup()
 Horde_Argv_Parser::checkValues()
 Horde_Argv_Parser::disableInterspersedArgs()
 Horde_Argv_Parser::enableInterspersedArgs()
 Horde_Argv_Parser::expandProgName()
 Horde_Argv_Parser::formatEpilog()
 Horde_Argv_Parser::formatHelp()
 Horde_Argv_Parser::formatOptionHelp()
 Horde_Argv_Parser::getDefaultValues()
 Horde_Argv_Parser::getDescription()
 Horde_Argv_Parser::getOptionGroup()
 Horde_Argv_Parser::getProgName()
 Horde_Argv_Parser::getUsage()
 Horde_Argv_Parser::getVersion()
 Horde_Argv_Parser::matchAbbrev()
 Horde_Argv_Parser::parseArgs()
 Horde_Argv_Parser::parserError()
 Horde_Argv_Parser::parserExit()
 Horde_Argv_Parser::printHelp()
 Horde_Argv_Parser::printUsage()
 Horde_Argv_Parser::printVersion()
 Horde_Argv_Parser::setDefault()
 Horde_Argv_Parser::setDefaults()
 Horde_Argv_Parser::setUsage()
 Horde_Argv_Parser::_addHelpOption()
 Horde_Argv_Parser::_addVersionOption()
 Horde_Argv_Parser::_createOptionList()
 Horde_Argv_Parser::_getAllOptions()
 Horde_Argv_Parser::_getArgs()
 Horde_Argv_Parser::_initParsingState()
 Horde_Argv_Parser::_matchLongOpt()
 Horde_Argv_Parser::_populateOptionList()
 Horde_Argv_Parser::_processArgs()
 Horde_Argv_Parser::_processLongOpt()
 Horde_Argv_Parser::_processShortOpts()
 Horde_Argv_Parser::__destruct()

Inherited From Horde_Argv_OptionContainer

 Horde_Argv_OptionContainer::__construct()
 Horde_Argv_OptionContainer::addOption()
 Horde_Argv_OptionContainer::addOptions()
 Horde_Argv_OptionContainer::formatDescription()
 Horde_Argv_OptionContainer::formatHelp()
 Horde_Argv_OptionContainer::formatOptionHelp()
 Horde_Argv_OptionContainer::getDescription()
 Horde_Argv_OptionContainer::getOption()
 Horde_Argv_OptionContainer::hasOption()
 Horde_Argv_OptionContainer::removeOption()
 Horde_Argv_OptionContainer::setConflictHandler()
 Horde_Argv_OptionContainer::setDescription()
 Horde_Argv_OptionContainer::_checkConflict()
 Horde_Argv_OptionContainer::_createOptionMappings()
 Horde_Argv_OptionContainer::_shareOptionMappings()

Documentation generated on Sun, 30 Jan 2011 05:15:27 +0000 by phpDocumentor 1.4.3