PHP Class Horde_Cli_Modular, horde

Author: Gunnar Wrobel ([email protected])

Protected Properties

Property	Type	Description
$_modules	Horde_Cli_Modular_Modules	Handler for the list of modules.
$_parameters	array	Parameters.
$_provider	Horde_Cli_Modular_ModuleProvider	Module provider.

Method	Description
__construct ( array $parameters = null )	Constructor.
createParser ( ) : Horde_Argv_Parser	Create the parser for command line arguments.
getModules ( ) : Horde_Cli_Modular_Modules	Return the module handler.
getParserClass ( ) : string	Return the class name for the parser that should be used.
getProvider ( ) : Horde_Cli_Modular_ModuleProvider	Return the module provider.
getUsage ( ) : string	Return the usage description for the help output of the parser.

Method	Description
_createModules ( ) : Horde_Cli_Modular_Modules	Create the module handler.
_createProvider ( ) : Horde_Cli_Modular_ModuleProvider	Create the module provider.

Constructor.

public __construct ( array $parameters = null )
$parameters	array	Options for this instance. - parser - class: Class name of the parser that should be used to parse command line arguments. Defaults to 'Horde_Argv_Parser'. - usage: The usage decription shown in the help output of the CLI - modules: Determines the handler for modules. Can be one of: (array) A parameter array. See Horde_Cli_Modular_Modules::__construct() (string) A class name. (object) An instance of Horde_Cli_Modular_Modules - provider: Determines the module provider. Can be one of: (array) A parameter array. See Horde_Cli_Modular_ModuleProvider::__construct() (string) A class name. (object) An instance of Horde_Cli_Modular_ModuleProvider

Create the module handler.

protected _createModules ( ) : Horde_Cli_Modular_Modules
return	Horde_Cli_Modular_Modules	The module handler.

Create the module provider.

protected _createProvider ( ) : Horde_Cli_Modular_ModuleProvider
return	Horde_Cli_Modular_ModuleProvider	The module provider.

Create the parser for command line arguments.

public createParser ( ) : Horde_Argv_Parser
return	Horde_Argv_Parser	The parser.

Return the module handler.

public getModules ( ) : Horde_Cli_Modular_Modules
return	Horde_Cli_Modular_Modules	The module handler.

Return the class name for the parser that should be used.

public getParserClass ( ) : string
return	string	The class name.

Return the module provider.

public getProvider ( ) : Horde_Cli_Modular_ModuleProvider
return	Horde_Cli_Modular_ModuleProvider	The module provider.

Return the usage description for the help output of the parser.

public getUsage ( ) : string
return	string	The usage description.

Handler for the list of modules.

protected Horde_Cli_Modular_Modules $_modules
return	Horde_Cli_Modular_Modules

Parameters.

protected array $_parameters
return	array

Module provider.

protected Horde_Cli_Modular_ModuleProvider $_provider
return	Horde_Cli_Modular_ModuleProvider