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

Méthodes publiques

Méthode Description
getActions ( ) : array Return the action arguments supported by this module.
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.

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.

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

public getOptionGroupDescription ( )

getOptionGroupOptions() public méthode

public getOptionGroupOptions ( )

getOptionGroupTitle() public méthode

public getOptionGroupTitle ( )

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.