API Documentation
\

\Horde_Cli_Modular_ModuleProvider

The Horde_Cli_Modular_ModuleProvider:: class provides access to a single module.

Summary

Methods
Properties
Constants
__construct()
getModule()
No public properties found
No constants found
createModule()
No protected properties found
N/A
No private methods found
$_prefix
$_dependencies
$_instances
N/A

Properties

$_prefix

$_prefix : string

Class prefix.

Type

string

$_dependencies

$_dependencies : mixed

Constructor argument for CLI modules. Likely to be a Horde_Injector instance.

Type

mixed

$_instances

$_instances : array

A cache for initialized module instances.

Type

array

Methods

__construct()

__construct(array  $parameters = null)

Constructor.

Parameters

array $parameters

Options for this instance.

 - prefix: The module class name prefix.
 - dependencies: Constructor argument for CLI modules.

getModule()

getModule(string  $module) : \Horde_Cli_Modular_Module

Return the specified module.

Parameters

string $module

The desired module.

Throws

\Horde_Cli_Modular_Exception

In case the specified module does not exist.

Returns

\Horde_Cli_Modular_Module —

The module instance.

createModule()

createModule(string  $module) : \Horde_Cli_Modular_Module

Create the specified module.

Parameters

string $module

The desired module.

Throws

\Horde_Cli_Modular_Exception

In case the specified module does not exist.

Returns

\Horde_Cli_Modular_Module —

The module instance.