PHP Class Components_Module_Update, horde

Author: Gunnar Wrobel ([email protected])

Inheritance: extends Components_Module_Base

Datei anzeigen Open project: horde/horde

Public Methods

Method	Description
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.

Return the action arguments supported by this module.

public getActions ( ) : array
return	array	A list of supported action arguments.

Return the options that should be explained in the context help.

public getContextOptionHelp ( ) : array
return	array	A list of option help texts.

Return the help text for the specified action.

public getHelp ( string $action ) : string
$action	string	The action.
return	string	The help text.

public getOptionGroupDescription ( )

public getOptionGroupOptions ( )

public getOptionGroupTitle ( )

Get the usage description for this module.

public getUsage ( ) : string
return	string	The description.

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.
return	boolean	True if the module performed some action.