PHP Class Horde_Cli_Modular, horde

See link: http://www.horde.org/libraries/Horde_Cli_Modular
Author: Gunnar Wrobel ([email protected])
Mostrar archivo Open project: horde/horde Class Usage Examples

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.

Public Methods

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.

Protected Methods

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

Method Details

__construct() public method

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

_createModules() protected method

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

_createProvider() protected method

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

createParser() public method

Create the parser for command line arguments.
public createParser ( ) : Horde_Argv_Parser
return Horde_Argv_Parser The parser.

getModules() public method

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

getParserClass() public method

Return the class name for the parser that should be used.
public getParserClass ( ) : string
return string The class name.

getProvider() public method

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

getUsage() public method

Return the usage description for the help output of the parser.
public getUsage ( ) : string
return string The usage description.

Property Details

$_modules protected_oe property

Handler for the list of modules.
protected Horde_Cli_Modular_Modules $_modules
return Horde_Cli_Modular_Modules

$_parameters protected_oe property

Parameters.
protected array $_parameters
return array

$_provider protected_oe property

Module provider.
protected Horde_Cli_Modular_ModuleProvider $_provider
return Horde_Cli_Modular_ModuleProvider