16fc6338d45736cf40a093d3b2d8a6c6faae326f
[tine20] / tine20 / Tool / Application / templates / Frontend / Cli.php
1 <?php
2 /**
3  * Tine 2.0
4  * @package     ExampleApplication
5  * @subpackage  Frontend
6  * @license     http://www.gnu.org/licenses/agpl.html AGPL Version 3
7  * @author      Cornelius Weiss <c.weiss@metaways.de>
8  * @copyright   Copyright (c) 2009 Metaways Infosystems GmbH (http://www.metaways.de)
9  */
10
11 /**
12  * cli server for timetracker
13  *
14  * This class handles cli requests for the timetracker
15  *
16  * @package     ExampleApplication
17  * @subpackage  Frontend
18  */
19 class ExampleApplication_Frontend_Cli
20 {
21     /**
22      * the internal name of the application
23      *
24      * @var string
25      */
26     protected $_applicationName = 'ExampleApplication';
27     
28     /**
29      * help array with function names and param descriptions
30      */
31     protected $_help = array(
32         /*
33         'functionName' => array(
34             'description'   => 'function description',
35             'params'        => array()
36             )
37         ),
38         */
39     );
40     
41     /**
42      * echos usage information
43      *
44      */
45     public function getHelp()
46     {
47         foreach ($this->_help as $functionHelp) {
48             echo $functionHelp['description']."\n";
49             echo "parameters:\n";
50             foreach ($functionHelp['params'] as $param => $description) {
51                 echo "$param \t $description \n";
52             }
53         }
54     }
55 }