Installer
extends Base
in package
Components_Module_Installer:: installs a Horde element including its dependencies.
Copyright 2010-2020 Horde LLC (http://www.horde.org/)
See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
Tags
Table of Contents
- $_dependencies : Dependencies
- __construct() : mixed
- Constructor.
- getActions() : array<string|int, mixed>
- Return the action arguments supported by this module.
- getBaseOptions() : array<string|int, mixed>
- Get a set of base options that this module adds to the CLI argument parser.
- getContextOptionHelp() : array<string|int, mixed>
- Return the options that should be explained in the context help.
- getHelp() : string
- Return the help text for the specified action.
- getOptionGroupDescription() : string
- Return the description for the option group representing this module.
- getOptionGroupOptions() : array<string|int, mixed>
- Return the options for this module.
- getOptionGroupTitle() : string
- Return the title for the option group representing this module.
- getTitle() : string
- Get the usage title for this module.
- getUsage() : string
- Get the usage description for this module.
- handle() : bool
- Determine if this module should act. Run all required actions if it has been instructed to do so.
- hasOptionGroup() : bool
- Indicate if the module provides an option group.
Properties
$_dependencies
protected
Dependencies
$_dependencies
Methods
__construct()
Constructor.
public
__construct(Dependencies $_dependencies) : mixed
Parameters
- $_dependencies : Dependencies
-
The dependency provider.
Return values
mixed —getActions()
Return the action arguments supported by this module.
public
getActions() : array<string|int, mixed>
Return values
array<string|int, mixed> —A list of supported action arguments.
getBaseOptions()
Get a set of base options that this module adds to the CLI argument parser.
public
getBaseOptions() : array<string|int, mixed>
Return values
array<string|int, mixed> —The options.
getContextOptionHelp()
Return the options that should be explained in the context help.
public
getContextOptionHelp() : array<string|int, mixed>
Return values
array<string|int, mixed> —A list of option help texts.
getHelp()
Return the help text for the specified action.
public
getHelp(string $action) : string
Parameters
- $action : string
-
The action.
Return values
string —The help text.
getOptionGroupDescription()
Return the description for the option group representing this module.
public
getOptionGroupDescription() : string
Return values
string —The group description.
getOptionGroupOptions()
Return the options for this module.
public
getOptionGroupOptions() : array<string|int, mixed>
Return values
array<string|int, mixed> —The group options.
getOptionGroupTitle()
Return the title for the option group representing this module.
public
getOptionGroupTitle() : string
Return values
string —The group title.
getTitle()
Get the usage title for this module.
public
getTitle() : string
Return values
string —The title.
getUsage()
Get the usage description for this module.
public
getUsage() : string
Return values
string —The description.
handle()
Determine if this module should act. Run all required actions if it has been instructed to do so.
public
handle(Config $config) : bool
Parameters
- $config : Config
-
The configuration.
Return values
bool —True if the module performed some action.
hasOptionGroup()
Indicate if the module provides an option group.
public
hasOptionGroup() : bool
Return values
bool —True if an option group should be added.