application/hub/main/states/class_BaseState.php

   1 <?php
   2 /**
   3  * A general state class
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Hub Developer Team
   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 BaseState extends BaseHubSystem implements Stateable {
  25         /**
  26          * State name for printing out (except debug output where you want to use
  27          * $stateInstance->__toString() instead of this).
  28          */
  29         private $stateName = '';
  30
  31         /**
  32          * Protected constructor
  33          *
  34          * @param       $className      Name of the class
  35          * @return      void
  36          */
  37         protected function __construct ($className) {
  38                 // Call parent constructor
  39                 parent::__construct($className);
  40         }
  41
  42         /**
  43          * Getter for state name
  44          *
  45          * @return      $stateName      Name of this state in a printable maner
  46          */
  47         public final function getStateName () {
  48                 return $this->stateName;
  49         }
  50
  51         /**
  52          * Setter for state name
  53          *
  54          * @param       $stateName      Name of this state in a printable maner
  55          * @return      void
  56          */
  57         protected final function setStateName ($stateName) {
  58                 $this->stateName = $stateName;
  59         }
  60 }
  61
  62 // [EOF]
  63 ?>