Horde_Cli_Modular_Module
in
The Horde_Cli_Modular_Module interface characterizes a single CLI module.
Tags
Table of Contents
- getBaseOptions() : array<string|int, mixed>
- 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<string|int, mixed>
- 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() : bool
- Returns whether the module provides an option group.
Methods
getBaseOptions()
Returns a set of base options that this module adds to the CLI argument parser.
public
getBaseOptions() : array<string|int, mixed>
Return values
array<string|int, mixed> —Global options. A list of Horde_Argv_Option objects.
getOptionGroupDescription()
Returns the description for the option group representing this module.
public
getOptionGroupDescription() : string
Return values
string —The group description.
getOptionGroupOptions()
Returns the options for this module.
public
getOptionGroupOptions() : array<string|int, mixed>
Return values
array<string|int, mixed> —The group options. A list of Horde_Argv_Option objects.
getOptionGroupTitle()
Returns the title for the option group representing this module.
public
getOptionGroupTitle() : string
Return values
string —The group title.
getUsage()
Returns additional usage description for this module.
public
getUsage() : string
This description will be added after the automatically generated usage line, so make sure to add any necessary line breaks or other separators.
Tags
Return values
string —The description.
hasOptionGroup()
Returns whether the module provides an option group.
public
hasOptionGroup() : bool
Return values
bool —True if an option group should be added.