902caacb606d25365a941482bb832cb3fb7f0b88
[core.git] / inc / classes / main / commands / class_BaseCommand.php
1 <?php
2 /**
3  * A general (base) command
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007 - 2009 Roland Haeder, this is free software
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.ship-simu.org
10  *
11  * This program is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation, either version 3 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
23  */
24 class BaseCommand extends BaseFrameworkSystem {
25         /**
26          * The controller we need for this command
27          */
28         private $controllerName = "";
29
30         /**
31          * Protected constructor
32          *
33          * @param       $className      Name of the class
34          * @return      void
35          */
36         protected function __construct ($className) {
37                 // Call parent constructor
38                 parent::__construct($className);
39         }
40
41         /**
42          * Setter for controller name
43          *
44          * @param       $controllerName         Name of the controller assigned with this command
45          * @return      void
46          */
47         public final function setControllerName ($controllerName) {
48                 $this->controllerName = (string) $controllerName;
49         }
50
51         /**
52          * Getter for controller name
53          *
54          * @return      $controllerName         Name of the controller assigned with this command
55          */
56         public final function getControllerName () {
57                 return $this->controllerName;
58         }
59 }
60
61 // [EOF]
62 ?>