3 namespace CoreFramework\State;
5 // Import framework stuff
6 use CoreFramework\Object\BaseFrameworkSystem;
9 * A general state class
11 * @author Roland Haeder <webmaster@shipsimu.org>
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
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.
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.
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/>.
30 class BaseState extends BaseFrameworkSystem implements Stateable {
31 // Exception code constants
32 const EXCEPTION_INVALID_STATE = 0xc00;
35 * State name for printing out (except debug output where you want to use
36 * $stateInstance->__toString() instead of this).
38 private $stateName = '';
41 * Protected constructor
43 * @param $className Name of the class
46 protected function __construct ($className) {
47 // Call parent constructor
48 parent::__construct($className);
52 * Getter for state name
54 * @return $stateName Name of this state in a printable maner
56 public final function getStateName () {
57 return $this->stateName;
61 * Setter for state name
63 * @param $stateName Name of this state in a printable maner
66 protected final function setStateName ($stateName) {
67 $this->stateName = $stateName;
71 * Executes the state with given Executor instance
73 * @param $executorInstance An instance of a Executor class
75 * @throws UnsupportedOperationException This method should be overwritten
77 public function executeState (Executor $executorInstance) {
78 throw new UnsupportedOperationException(array($this, __FUNCTION__, $executorInstance), self::EXCEPTION_UNSPPORTED_OPERATION);