• Home
  • Components_Module_Base

PHP Class Components_Module_Base, 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: implements Components_Module
Show file Open project: horde/horde

Protected Properties

Property Type Description
$_dependencies Components_Dependencies The dependency provider.

Public Methods

Method Description
__construct ( Components_Dependencies $dependencies ) Constructor.
getActions ( ) : array Return the action arguments supported by this module.
getBaseOptions ( ) : array Get a set of base options that this module adds to the CLI argument parser.
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.
getUsage ( ) : string Get the usage description for this module.
hasOptionGroup ( ) : boolean Indicate if the module provides an option group.

Method Details

__construct() public method

Constructor.
public __construct ( Components_Dependencies $dependencies )
$dependencies Components_Dependencies The dependency provider.

getActions() public method

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

getBaseOptions() public method

Get a set of base options that this module adds to the CLI argument parser.
public getBaseOptions ( ) : array
return array The options.

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.

getUsage() public method

Get the usage description for this module.
public getUsage ( ) : string
return string The description.

hasOptionGroup() public method

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

Property Details

$_dependencies protected property

The dependency provider.
protected Components_Dependencies $_dependencies
return Components_Dependencies