Class Horde_Argv_OptionContainer

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.

Direct known subclasses

Horde_Argv_OptionGroup, Horde_Argv_Parser

Package: Argv
Category: Horde
Located at Horde/Argv/OptionContainer.php

Methods summary
`public`	# `__construct( mixed $optionClass, mixed $conflictHandler, mixed $description )` 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. 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.
`public`	# `setConflictHandler( mixed $handler )`
`public`	# `setDescription( mixed $description )`
`public`	# `getDescription( )`
`public`	# `addOption( )`
`public`	# `addOptions( mixed $optionList )`
`public`	# `getOption( mixed $opt_str )`
`public`	# `hasOption( mixed $opt_str )`
`public`	# `removeOption( mixed $opt_str )`
`public`	# `formatOptionHelp( mixed $formatter = null )`
`public`	# `formatDescription( mixed $formatter = null )`
`public`	# `formatHelp( mixed $formatter = null )`

Properties summary
`public string`	`$description`	# `''`
`public array`	`$optionList`	# `array()`
`public string`	`$optionClass`	# `'Horde_Argv_Option'`
`public array`	`$defaults`	# `array()`
`public array`	`$shortOpt`	# `array()`
`public array`	`$longOpt`	# `array()`
`public mixed`	`$conflictHandler`	#

Packages

Classes

Class Horde_Argv_OptionContainer

Direct known subclasses