Class Horde_Cli_Modular
Glue class for a modular CLI.
Copyright 2010-2012 Horde LLC (http://www.horde.org/)
See the enclosed file COPYING for license information (LGPL). If you
did not receive this file, see http://www.horde.org/licenses/lgpl21.
Methods summary
public
|
#
__construct( array $parameters = null )
Constructor.
Parameters
- $parameters
- Options for this instance.
<pre>- parser
- <span class="php-keyword1">class</span>: <span class="php-keyword1">Class</span> name of the parser that should be used to parse
command line arguments.
- usage: The usage decription shown in the help output of the CLI
- modules: Determines the handler <span class="php-keyword1">for</span> modules. Can be one of:
(<span class="php-keyword1">array</span>) A parameter <span class="php-keyword1">array</span>.
See Horde_Cli_Modular_Modules::__construct()
(string) A <span class="php-keyword1">class</span> name.
(object) An instance of Horde_Cli_Modular_Modules
- provider: Determines the module provider. Can be one of:
(<span class="php-keyword1">array</span>) A parameter <span class="php-keyword1">array</span>.
See Horde_Cli_Modular_ModuleProvider::__construct()
(string) A <span class="php-keyword1">class</span> name.
(object) An instance of Horde_Cli_Modular_ModuleProvider</pre>
|
public
string
|
#
getParserClass( )
Return the class name for the parser that should be used.
Return the class name for the parser that should be used.
Returns
string
The class name.
|
public
string
|
#
getUsage( )
Return the usage description for the help output of the parser.
Return the usage description for the help output of the parser.
Returns
string
The usage description.
|
public
Horde_Argv_Parser
|
#
createParser( )
Create the parser for command line arguments.
Create the parser for command line arguments.
Returns
Horde_Argv_Parser
The parser.
|
public
Horde_Cli_Modular_Modules
|
#
getModules( )
Return the module handler.
Return the module handler.
Returns
|
public
Horde_Cli_Modular_ModuleProvider
|
#
getProvider( )
Return the module provider.
Return the module provider.
Returns
|