PHP Interface Horde_Cli_Modular_Module, horde

See link: http://www.horde.org/libraries/Horde_Cli_Modular
Author: Gunnar Wrobel ([email protected])
Afficher le fichier Open project: horde/horde

Méthodes publiques

Méthode Description
getBaseOptions ( ) : array Returns a set of base options that this module adds to the CLI argument parser.
getOptionGroupDescription ( ) : string Returns the description for the option group representing this module.
getOptionGroupOptions ( ) : array Returns the options for this module.
getOptionGroupTitle ( ) : string Returns the title for the option group representing this module.
getUsage ( ) : string Returns additional usage description for this module.
hasOptionGroup ( ) : boolean Returns whether the module provides an option group.

Method Details

getBaseOptions() public méthode

Returns a set of base options that this module adds to the CLI argument parser.
public getBaseOptions ( ) : array
Résultat array Global options. A list of Horde_Argv_Option objects.

getOptionGroupDescription() public méthode

Returns the description for the option group representing this module.
public getOptionGroupDescription ( ) : string
Résultat string The group description.

getOptionGroupOptions() public méthode

Returns the options for this module.
public getOptionGroupOptions ( ) : array
Résultat array The group options. A list of Horde_Argv_Option objects.

getOptionGroupTitle() public méthode

Returns the title for the option group representing this module.
public getOptionGroupTitle ( ) : string
Résultat string The group title.

getUsage() public méthode

This description will be added after the automatically generated usage line, so make sure to add any necessary line breaks or other separators.
public getUsage ( ) : string
Résultat string The description.

hasOptionGroup() public méthode

Returns whether the module provides an option group.
public hasOptionGroup ( ) : boolean
Résultat boolean True if an option group should be added.