API Documentation
\

\Horde_Kolab_Cli_Module_Base

The Horde_Kolab_Cli_Module_Base:: module provides the base options of the Kolab CLI.

Copyright 2010-2017 Horde LLC (http://www.horde.org/)

See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Summary

Methods
Properties
Constants
getUsage()
getBaseOptions()
hasOptionGroup()
getOptionGroupTitle()
getOptionGroupDescription()
getOptionGroupOptions()
handleArguments()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
_getStorage()
_getFormat()
No private properties found
N/A

Methods

getUsage()

getUsage() : string

Get the usage description for this module.

Returns

string —

The description.

getBaseOptions()

getBaseOptions() : array

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

Returns

array —

The options.

hasOptionGroup()

hasOptionGroup() : boolean

Indicate if the module provides an option group.

Returns

boolean —

True if an option group should be added.

getOptionGroupTitle()

getOptionGroupTitle() : string

Return the title for the option group representing this module.

Returns

string —

The group title.

getOptionGroupDescription()

getOptionGroupDescription() : string

Return the description for the option group representing this module.

Returns

string —

The group description.

getOptionGroupOptions()

getOptionGroupOptions() : array

Return the options for this module.

Returns

array —

The group options.

handleArguments()

handleArguments(  $options,   $arguments,   $world) : NULL

Handle the options and arguments.

Parameters

$options
$arguments
$world

Returns

NULL

_getStorage()

_getStorage(mixed  $options) : \Horde_Kolab_Storage

Return the driver for the Kolab storage backend.

Parameters

mixed $options

An array of options.

Returns

\Horde_Kolab_Storage —

The storage handler.

_getFormat()

_getFormat(mixed  $options) : \Horde_Kolab_Format_Factory

Return the factory for the Kolab format parsers.

Parameters

mixed $options

An array of options.

Returns

\Horde_Kolab_Format_Factory —

The format parser factory.