• Home
  • Components_Module_Snapshot

PHP Class Components_Module_Snapshot, 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=Components
Author: Gunnar Wrobel ([email protected])
Inheritance: extends Components_Module_Base
Show file 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 ( ) : 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.
handle ( Components_Config $config ) : boolean Determine if this module should act. Run all required actions if it has been instructed to do so.

Method Details

getActions() public method

Return the action arguments supported by this module.
public getActions ( ) : array
return array A list of supported action arguments.

getContextOptionHelp() public method

Return the options that should be explained in the context help.
public getContextOptionHelp ( ) : array
return array A list of option help texts.

getHelp() public method

Return the help text for the specified action.
public getHelp ( string $action ) : string
$action string The action.
return string The help text.

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.

handle() public method

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.