Abstract base class.
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: optionList : [Option] the list of Option objects contained by this OptionContainer shortOpt : { string : Option } dictionary mapping short option strings, eg. "-f" or "-X", to the Option instances that implement them. If an Option has multiple short option strings, it will appears in this dictionary multiple times. [1] longOpt : { string : Option } dictionary mapping long option strings, eg. "--file" or "--exclude", to the Option instances that implement them. Again, a given Option can occur multiple times in this dictionary. [1] defaults : { string : any } dictionary mapping option destination names to default values for each destination [1]
[1] These mappings are common to (shared by) all components of the controlling Horde_Argv_Parser, where they are initially created.
Located in /Argv/lib/Horde/Argv/OptionContainer.php (line 41)
Class | 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). |
Initialize the option list and related data structures.
This method must be provided by subclasses, and it must initialize at least the following instance attributes: optionList, shortOpt, longOpt, defaults.
For use by Horde_Argv_Parser constructor -- create the master option mappings used by this Horde_Argv_Parser and all OptionGroups that it owns.
For use by OptionGroup constructor -- use shared option mappings from the Horde_Argv_Parser that owns this OptionGroup.
Documentation generated on Sun, 30 Jan 2011 05:20:11 +0000 by phpDocumentor 1.4.3