API Documentation
\

\Horde_Cli_Modular_Module

The Horde_Cli_Modular_Module interface characterizes a single CLI module.

Summary

Methods
Constants
getUsage()
getBaseOptions()
hasOptionGroup()
getOptionGroupTitle()
getOptionGroupDescription()
getOptionGroupOptions()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

getUsage()

getUsage() : string

Returns additional usage description for this module.

This description will be added after the automatically generated usage line, so make sure to add any necessary line breaks or other separators.

Returns

string —

The description.

getBaseOptions()

getBaseOptions() : array

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

Returns

array —

Global options. A list of Horde_Argv_Option objects.

hasOptionGroup()

hasOptionGroup() : boolean

Returns whether the module provides an option group.

Returns

boolean —

True if an option group should be added.

getOptionGroupTitle()

getOptionGroupTitle() : string

Returns the title for the option group representing this module.

Returns

string —

The group title.

getOptionGroupDescription()

getOptionGroupDescription() : string

Returns the description for the option group representing this module.

Returns

string —

The group description.

getOptionGroupOptions()

getOptionGroupOptions() : array

Returns the options for this module.

Returns

array —

The group options. A list of Horde_Argv_Option objects.