1: <?php
 2: /**
 3:  * The Horde_Cli_Modular_Module:: interface characterizes a single CLI module.
 4:  *
 5:  * PHP version 5
 6:  *
 7:  * @category Horde
 8:  * @package  Cli_Modular
 9:  * @author   Gunnar Wrobel <wrobel@pardus.de>
10:  * @license  http://www.horde.org/licenses/lgpl21 LGPL
11:  * @link     http://www.horde.org/libraries/Horde_Cli_Modular
12:  */
13: 
14: /**
15:  * The Horde_Cli_Modular_Module:: interface characterizes a single CLI module.
16:  *
17:  * Copyright 2010-2012 Horde LLC (http://www.horde.org/)
18:  *
19:  * See the enclosed file COPYING for license information (LGPL). If you
20:  * did not receive this file, see http://www.horde.org/licenses/lgpl21.
21:  *
22:  * @category Horde
23:  * @package  Cli_Modular
24:  * @author   Gunnar Wrobel <wrobel@pardus.de>
25:  * @license  http://www.horde.org/licenses/lgpl21 LGPL 2.1
26:  * @link     http://www.horde.org/libraries/Horde_Cli_Modular
27:  */
28: interface Horde_Cli_Modular_Module
29: {
30:     /**
31:      * Get the usage description for this module.
32:      *
33:      * @return string The description.
34:      */
35:     public function getUsage();
36: 
37:     /**
38:      * Get a set of base options that this module adds to the CLI argument
39:      * parser.
40:      *
41:      * @return array The options.
42:      */
43:     public function getBaseOptions();
44: 
45:     /**
46:      * Indicate if the module provides an option group.
47:      *
48:      * @return boolean True if an option group should be added.
49:      */
50:     public function hasOptionGroup();
51: 
52:     /**
53:      * Return the title for the option group representing this module.
54:      *
55:      * @return string The group title.
56:      */
57:     public function getOptionGroupTitle();
58: 
59:     /**
60:      * Return the description for the option group representing this module.
61:      *
62:      * @return string The group description.
63:      */
64:     public function getOptionGroupDescription();
65: 
66:     /**
67:      * Return the options for this module.
68:      *
69:      * @return array The group options.
70:      */
71:     public function getOptionGroupOptions();
72: }