PHP Interface Horde_Cli_Modular_Module, horde

Author: Gunnar Wrobel ([email protected])

Datei anzeigen Open project: horde/horde

Public Methods

Method	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.

Returns a set of base options that this module adds to the CLI argument parser.

public getBaseOptions ( ) : array
return	array	Global options. A list of Horde_Argv_Option objects.

Returns the description for the option group representing this module.

public getOptionGroupDescription ( ) : string
return	string	The group description.

Returns the options for this module.

public getOptionGroupOptions ( ) : array
return	array	The group options. A list of Horde_Argv_Option objects.

Returns the title for the option group representing this module.

public getOptionGroupTitle ( ) : string
return	string	The group title.

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
return	string	The description.

Returns whether the module provides an option group.

public hasOptionGroup ( ) : boolean
return	boolean	True if an option group should be added.