PHP Class Horde_Kolab_Cli_Module_List, horde

Author: Gunnar Wrobel ([email protected])

Inheritance: implements Horde_Kolab_Cli_Module

Public Methods

Method	Description
getBaseOptions ( ) : array	Get a set of base options that this module adds to the CLI argument parser.
getOptionGroupDescription ( ) : string	Return the description for the option group representing this module.
getOptionGroupOptions ( ) : array	Return the options for this module.
getOptionGroupTitle ( ) : string	Return the title for the option group representing this module.
getUsage ( ) : string	Get the usage description for this module.
handleArguments ( &$options, &$arguments, &$world ) : null	Handle the options and arguments.
hasOptionGroup ( ) : boolean	Indicate if the module provides an option group.
run ( Horde_Cli $cli, mixed $options, mixed $arguments, &$world ) : null	Run the module.

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

public getBaseOptions ( ) : array
return	array	The options.

Return the description for the option group representing this module.

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

Return the options for this module.

public getOptionGroupOptions ( ) : array
return	array	The group options.

Return the title for the option group representing this module.

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

Get the usage description for this module.

public getUsage ( ) : string
return	string	The description.

Handle the options and arguments.

public handleArguments ( &$options, &$arguments, &$world ) : null
return	null

Indicate if the module provides an option group.

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

Run the module.

public run ( Horde_Cli $cli, mixed $options, mixed $arguments, &$world ) : null
$cli	Horde_Cli	The CLI handler.
$options	mixed	An array of options.
$arguments	mixed	An array of arguments.
return	null