PHP Класс Components_Module_Change, horde

Copyright 2011-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])
Наследование: extends Components_Module_Base
Показать файл Открыть проект

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

Метод Описание
getActions ( ) : array Return the action arguments supported by this module.
getContextOptionHelp ( ) : array Return the options that should be explained in the context help.
getHelp ( string $action ) : string Return the help text for the specified action.
getOptionGroupDescription ( )
getOptionGroupOptions ( )
getOptionGroupTitle ( )
getUsage ( ) : string Get the usage description for this module.
handle ( Components_Config $config ) : boolean Determine if this module should act. Run all required actions if it has been instructed to do so.

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

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

Return the action arguments supported by this module.
public getActions ( ) : array
Результат array A list of supported action arguments.

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

Return the options that should be explained in the context help.
public getContextOptionHelp ( ) : array
Результат array A list of option help texts.

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

Return the help text for the specified action.
public getHelp ( string $action ) : string
$action string The action.
Результат string The help text.

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

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

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

public getOptionGroupTitle ( )

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

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

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

Determine if this module should act. Run all required actions if it has been instructed to do so.
public handle ( Components_Config $config ) : boolean
$config Components_Config The configuration.
Результат boolean True if the module performed some action.