PHP Class Horde_Kolab_Cli_Module_Base, horde

Copyright 2010-2016 Horde LLC (http://www.horde.org/) See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
See link: http://pear.horde.org/index.php?package=Kolab_Cli
Author: Gunnar Wrobel ([email protected])
Inheritance: implements Horde_Kolab_Cli_Module
Exibir arquivo Open project: horde/horde Class Usage Examples

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.

Private Methods

Method Description
_getFormat ( mixed $options ) : Horde_Kolab_Format_Factory Return the factory for the Kolab format parsers.
_getStorage ( mixed $options ) : Horde_Kolab_Storage Return the driver for the Kolab storage backend.

Method Details

getBaseOptions() public method

Get a set of base options that this module adds to the CLI argument parser.
public getBaseOptions ( ) : array
return array The options.

getOptionGroupDescription() public method

Return the description for the option group representing this module.
public getOptionGroupDescription ( ) : string
return string The group description.

getOptionGroupOptions() public method

Return the options for this module.
public getOptionGroupOptions ( ) : array
return array The group options.

getOptionGroupTitle() public method

Return the title for the option group representing this module.
public getOptionGroupTitle ( ) : string
return string The group title.

getUsage() public method

Get the usage description for this module.
public getUsage ( ) : string
return string The description.

handleArguments() public method

Handle the options and arguments.
public handleArguments ( &$options, &$arguments, &$world ) : null
return null

hasOptionGroup() public method

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