framework/main/classes/states/class_BaseState.php

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\State;
   4
   5 // Import framework stuff
   6 use CoreFramework\Object\BaseFrameworkSystem;
   7
   8 /**
   9  * A general state class
  10  *
  11  * @author              Roland Haeder <webmaster@shipsimu.org>
  12  * @version             0.0.0
  13  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  14  * @license             GNU GPL 3.0 or any newer version
  15  * @link                http://www.shipsimu.org
  16  *
  17  * This program is free software: you can redistribute it and/or modify
  18  * it under the terms of the GNU General Public License as published by
  19  * the Free Software Foundation, either version 3 of the License, or
  20  * (at your option) any later version.
  21  *
  22  * This program is distributed in the hope that it will be useful,
  23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  * GNU General Public License for more details.
  26  *
  27  * You should have received a copy of the GNU General Public License
  28  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  29  */
  30 class BaseState extends BaseFrameworkSystem implements Stateable {
  31         // Exception code constants
  32         const EXCEPTION_INVALID_STATE = 0xc00;
  33
  34         /**
  35          * State name for printing out (except debug output where you want to use
  36          * $stateInstance->__toString() instead of this).
  37          */
  38         private $stateName = '';
  39
  40         /**
  41          * Protected constructor
  42          *
  43          * @param       $className      Name of the class
  44          * @return      void
  45          */
  46         protected function __construct ($className) {
  47                 // Call parent constructor
  48                 parent::__construct($className);
  49         }
  50
  51         /**
  52          * Getter for state name
  53          *
  54          * @return      $stateName      Name of this state in a printable maner
  55          */
  56         public final function getStateName () {
  57                 return $this->stateName;
  58         }
  59
  60         /**
  61          * Setter for state name
  62          *
  63          * @param       $stateName      Name of this state in a printable maner
  64          * @return      void
  65          */
  66         protected final function setStateName ($stateName) {
  67                 $this->stateName = $stateName;
  68         }
  69
  70         /**
  71          * Executes the state with given Executor instance
  72          *
  73          * @param       $executorInstance       An instance of a Executor class
  74          * @return      void
  75          * @throws      UnsupportedOperationException   This method should be overwritten
  76          */
  77         public function executeState (Executor $executorInstance) {
  78                 throw new UnsupportedOperationException(array($this, __FUNCTION__, $executorInstance), self::EXCEPTION_UNSPPORTED_OPERATION);
  79         }
  80
  81 }