application/city/classes/factories/states/city/class_CityStateFactory.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\City\Factory\State;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Factory\ObjectFactory;
   7
   8 /**
   9  * A factory class for city states
  10  *
  11  * @author              Roland Haeder <webmaster@shipsimu.org>
  12  * @version             0.0.0
  13  * @copyright   Copyright (c) 2015, 2016 City 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 CityStateFactory extends ObjectFactory {
  31         /**
  32          * Protected constructor
  33          *
  34          * @return      void
  35          */
  36         protected function __construct () {
  37                 // Call parent constructor
  38                 parent::__construct(__CLASS__);
  39         }
  40
  41         /**
  42          * Creates an instance of a configurable city state and sets it in the
  43          * given city instance.
  44          *
  45          * @param       $stateName              Name of the state
  46          * @return      $stateInstance  A Stateable class instance
  47          */
  48         public static final function createCityStateInstanceByName ($stateName) {
  49                 // Then construct the class' configuraton entry
  50                 $className = 'city_' . $stateName . '_state_class';
  51
  52                 // Get a class from that configuration entry
  53                 $stateInstance = self::createObjectByConfiguredName($className);
  54
  55                 // Get city instance
  56                 $cityInstance = CityDaemonFactory::createCityDaemonInstance();
  57
  58                 // Debug message
  59                 self::createDebugInstance(__CLASS__)->debugOutput('CITY-STATE-FACTORY[' . __METHOD__ . ':' . __LINE__ . ']: City daemon state has changed from ' . $cityInstance->getPrintableState() . ' to ' . $stateInstance->getStateName() . '.');
  60
  61                 // Once we have that state, set it in the city instance
  62                 $cityInstance->setStateInstance($stateInstance);
  63
  64                 // Update city data
  65                 $cityInstance->updateCityData();
  66
  67                 // For any purposes, return the state instance
  68                 return $stateInstance;
  69         }
  70 }