application/city/classes/states/city/active/class_CityActiveState.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\City\State\Active;
   4
   5 // Import application-specific stuff
   6 use Org\Mxchange\City\Daemon\Factory\CityDaemonFactory;
   7 use Org\Mxchange\City\State\BaseCityState;
   8
   9 // Import framework stuff
  10 use Org\Mxchange\CoreFramework\State\Stateable;
  11
  12 /**
  13  * A active city state class
  14  *
  15  * @author              Roland Haeder <webmaster@shipsimu.org>
  16  * @version             0.0.0
  17  * @copyright   Copyright (c) 2015, 2016 City Developer Team
  18  * @license             GNU GPL 3.0 or any newer version
  19  * @link                http://www.shipsimu.org
  20  *
  21  * This program is free software: you can redistribute it and/or modify
  22  * it under the terms of the GNU General Public License as published by
  23  * the Free Software Foundation, either version 3 of the License, or
  24  * (at your option) any later version.
  25  *
  26  * This program is distributed in the hope that it will be useful,
  27  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  28  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  29  * GNU General Public License for more details.
  30  *
  31  * You should have received a copy of the GNU General Public License
  32  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  33  */
  34 class CityActiveState extends BaseCityState implements Stateable {
  35         /**
  36          * Protected constructor
  37          *
  38          * @return      void
  39          */
  40         protected function __construct () {
  41                 // Call parent constructo
  42                 parent::__construct(__CLASS__);
  43
  44                 // Set state name
  45                 $this->setStateName('active');
  46         }
  47
  48         /**
  49          * Creates an instance of this class
  50          *
  51          * @return      $stateInstance  An instance of a Stateable class
  52          */
  53         public static final function createCityActiveState () {
  54                 // Get new instance
  55                 $stateInstance = new CityActiveState();
  56
  57                 // Get city instance and set 'active' flag
  58                 CityDaemonFactory::createCityDaemonInstance()->enableIsActive();
  59
  60                 // Return the prepared instance
  61                 return $stateInstance;
  62         }
  63 }