inc/classes/main/states/class_BaseState.php

   1 <?php
   2 /**
   3  * A general state class
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.shipsimu.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 BaseFrameworkSystem implements Stateable {
  25         // Exception code constants
  26         const EXCEPTION_INVALID_STATE = 0xc00;
  27
  28         /**
  29          * State name for printing out (except debug output where you want to use
  30          * $stateInstance->__toString() instead of this).
  31          */
  32         private $stateName = '';
  33
  34         /**
  35          * Protected constructor
  36          *
  37          * @param       $className      Name of the class
  38          * @return      void
  39          */
  40         protected function __construct ($className) {
  41                 // Call parent constructor
  42                 parent::__construct($className);
  43         }
  44
  45         /**
  46          * Getter for state name
  47          *
  48          * @return      $stateName      Name of this state in a printable maner
  49          */
  50         public final function getStateName () {
  51                 return $this->stateName;
  52         }
  53
  54         /**
  55          * Setter for state name
  56          *
  57          * @param       $stateName      Name of this state in a printable maner
  58          * @return      void
  59          */
  60         protected final function setStateName ($stateName) {
  61                 $this->stateName = $stateName;
  62         }
  63
  64         /**
  65          * Executes the state with given Executor instance
  66          *
  67          * @param       $executorInstance       An instance of a Executor class
  68          * @return      void
  69          * @throws      UnsupportedOperationException   This method should be overwritten
  70          */
  71         public function executeState (Executor $executorInstance) {
  72                 throw new UnsupportedOperationException(array($this, __FUNCTION__, $executorInstance), self::EXCEPTION_UNSPPORTED_OPERATION);
  73         }
  74 }
  75
  76 // [EOF]
  77 ?>