Module
extends
Horde_Cli_Modular_Module
in
Components_Module:: represents a task for a Horde component.
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
- getActions() : array<string|int, mixed>
- Return the action arguments supported by this module.
- getHelp() : string
- Return the help text for the specified action.
- handle() : bool
- Determine if this module should act. Run all required actions if it has been instructed to do so.
Methods
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.
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.
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.