PHP Класс 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.
Автор: Gunnar Wrobel ([email protected])
Наследование: implements Horde_Kolab_Cli_Module
Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод Описание
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.

Приватные методы

Метод Описание
_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.

Описание методов

getBaseOptions() публичный Метод

Get a set of base options that this module adds to the CLI argument parser.
public getBaseOptions ( ) : array
Результат array The options.

getOptionGroupDescription() публичный Метод

Return the description for the option group representing this module.
public getOptionGroupDescription ( ) : string
Результат string The group description.

getOptionGroupOptions() публичный Метод

Return the options for this module.
public getOptionGroupOptions ( ) : array
Результат array The group options.

getOptionGroupTitle() публичный Метод

Return the title for the option group representing this module.
public getOptionGroupTitle ( ) : string
Результат string The group title.

getUsage() публичный Метод

Get the usage description for this module.
public getUsage ( ) : string
Результат string The description.

handleArguments() публичный Метод

Handle the options and arguments.
public handleArguments ( &$options, &$arguments, &$world ) : null
Результат null

hasOptionGroup() публичный Метод

Indicate if the module provides an option group.
public hasOptionGroup ( ) : boolean
Результат boolean True if an option group should be added.