• Home
  • Components_Module_Help

PHP Class Components_Module_Help, 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.
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.
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.
hasOptionGroup ( ) : boolean Indicate if the module provides an option group.

Method Details

getActions() public method

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

getOptionGroupDescription() public method

public getOptionGroupDescription ( )

getOptionGroupOptions() public method

public getOptionGroupOptions ( )

getOptionGroupTitle() public method

public getOptionGroupTitle ( )

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.

hasOptionGroup() public method

Indicate if the module provides an option group.
public hasOptionGroup ( ) : boolean
return boolean True if an option group should be added.