• Accueil
  • Components_Module_Dependencies

PHP Class Components_Module_Dependencies, 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
Afficher le fichier Open project: horde/horde

Méthodes publiques

Méthode 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 méthode

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

getContextOptionHelp() public méthode

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

getHelp() public méthode

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

getOptionGroupDescription() public méthode

Return the description for the option group representing this module.
public getOptionGroupDescription ( ) : string
Résultat string The group description.

getOptionGroupOptions() public méthode

Return the options for this module.
public getOptionGroupOptions ( ) : array
Résultat array The group options.

getOptionGroupTitle() public méthode

Return the title for the option group representing this module.
public getOptionGroupTitle ( ) : string
Résultat string The group title.

getUsage() public méthode

Get the usage description for this module.
public getUsage ( ) : string
Résultat string The description.

handle() public méthode

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