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, 2008 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          * Resolver instance
  32          */
  33         private $resolverInstance = null;
  34
  35         /**
  36          * Protected constructor
  37          *
  38          * @return      void
  39          */
  40         protected function __construct ($class) {
  41                 // Call parent constructor
  42                 parent::__construct($class);
  43         }
  44
  45         /**
  46          * Setter for controller name
  47          *
  48          * @param       $controllerName         Name of the controller assigned with this command
  49          * @return      void
  50          */
  51         public final function setControllerName ($controllerName) {
  52                 $this->controllerName = (string) $controllerName;
  53         }
  54
  55         /**
  56          * Getter for controller name
  57          *
  58          * @return      $controllerName         Name of the controller assigned with this command
  59          */
  60         public final function getControllerName () {
  61                 return $this->controllerName;
  62         }
  63
  64         /**
  65          * Setter for resolver instance
  66          *
  67          * @param       $resolverInstance               Instance of a command resolver class
  68          * @return      void
  69          */
  70         public final function setResolverInstance (CommandResolver $resolverInstance) {
  71                 $this->resolverInstance = $resolverInstance;
  72         }
  73
  74         /**
  75          * Getter for resolver instance
  76          *
  77          * @return      $resolverInstance               Instance of a command resolver class
  78          */
  79         public final function getResolverInstance () {
  80                 return $this->resolverInstance;
  81         }
  82 }
  83
  84 // [EOF]
  85 ?>