application/city/classes/states/city/class_BaseCityState.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\City\State;
   4
   5 // Import application-specific stuff
   6 use Org\Mxchange\City\State\Init\CityInitState;
   7
   8 // Import framework stuff
   9 use Org\Mxchange\CoreFramework\State\BaseState;
  10
  11 /**
  12  * A general city state class
  13  *
  14  * @author              Roland Haeder <webmaster@shipsimu.org>
  15  * @version             0.0.0
  16  * @copyright   Copyright (c) 2015, 2016 City Developer Team
  17  * @license             GNU GPL 3.0 or any newer version
  18  * @link                http://www.shipsimu.org
  19  *
  20  * This program is free software: you can redistribute it and/or modify
  21  * it under the terms of the GNU General Public License as published by
  22  * the Free Software Foundation, either version 3 of the License, or
  23  * (at your option) any later version.
  24  *
  25  * This program is distributed in the hope that it will be useful,
  26  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  27  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  28  * GNU General Public License for more details.
  29  *
  30  * You should have received a copy of the GNU General Public License
  31  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  32  */
  33 abstract class BaseCityState extends BaseState {
  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          * Validates whether the state is 'active' or throws an exception if
  47          * it is every other state.
  48          *
  49          * @return      void
  50          * @throws      UnexpectedStateException        If the state is not 'active'
  51          */
  52         public function validateCityStateIsActive () {
  53                 // Just compare it...
  54                 if (!$this instanceof CityActiveState) {
  55                         // Throw the exception
  56                         throw new UnexpectedStateException($this, self::EXCEPTION_INVALID_STATE);
  57                 } // END - if
  58         }
  59
  60         /**
  61          * Validates whether the state is 'init' or throws an exception if
  62          * it is every other state.
  63          *
  64          * @return      void
  65          * @throws      UnexpectedStateException        If the state is not 'virgin'
  66          */
  67         public function validateCityStateIsInit () {
  68                 // Just compare it...
  69                 if (!$this instanceof CityInitState) {
  70                         // Throw the exception
  71                         throw new UnexpectedStateException($this, self::EXCEPTION_INVALID_STATE);
  72                 } // END - if
  73         }
  74 }