application/city/main/factories/city_daemon/class_CityDaemonFactory.php

   1 <?php
   2 /**
   3  * A factory class for cities
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2015 City Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 class CityDaemonFactory extends ObjectFactory {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33         }
  34
  35         /**
  36          * Returns a singleton (registry-based) CityHelper instance
  37          *
  38          * @param       $requestInstance        An instance of a class with an Requestable interface
  39          * @param       $responseInstance       An instance of a class with an Responseable interface
  40          * @return      $cityInstance           An instance of a CityHelper class
  41          * @throws      FactoryRequiredParameterException       If not all parameters are set and no instance 'city' is set.
  42          */
  43         public static final function createCityDaemonInstance (Requestable $requestInstance = NULL, Responseable $responseInstance = NULL) {
  44                 // Get new factory instance
  45                 $factoryInstance = new CityDaemonFactory();
  46
  47                 // If there is no handler?
  48                 if (Registry::getRegistry()->instanceExists('city')) {
  49                         // Get handler from registry
  50                         $cityInstance = Registry::getRegistry()->getInstance('city');
  51                 } elseif (($requestInstance instanceof Requestable) && ($responseInstance instanceof Responseable)) {
  52                         // The default city-mode is from our configuration
  53                         $cityMode = $factoryInstance->getConfigInstance()->getConfigEntry('city_default_mode');
  54
  55                         // Is the city 'mode' parameter set?
  56                         if ($requestInstance->isRequestElementSet('mode')) {
  57                                 // Then use this which overrides the config entry temporarily
  58                                 $cityMode = $requestInstance->getRequestElement('mode');
  59                         } else {
  60                                 // Set it for easier re-usage
  61                                 $requestInstance->setRequestElement('mode', $cityMode);
  62                         }
  63
  64                         // Now convert the city-mode in a class name
  65                         $className = 'Simulation' . $factoryInstance->convertToClassName($cityMode) . 'CityDaemon';
  66
  67                         // Get the city instance
  68                         $cityInstance = ObjectFactory::createObjectByName($className, array($requestInstance));
  69
  70                         // Get a registry
  71                         $applicationInstance = Registry::getRegistry()->getInstance('app');
  72
  73                         // Set the app instance
  74                         $cityInstance->setApplicationInstance($applicationInstance);
  75
  76                         // Add city-specific filters
  77                         $cityInstance->addExtraFilters($applicationInstance->getControllerInstance(), $responseInstance);
  78                 } else {
  79                         // Throw an exception here
  80                         throw new FactoryRequiredParameterException($factoryInstance, self::EXCEPTION_FACTORY_REQUIRE_PARAMETER);
  81                 }
  82
  83                 // Return the instance
  84                 return $cityInstance;
  85         }
  86 }
  87
  88 // [EOF]
  89 ?>