application/city/classes/filter/task/city_daemon/class_CityDaemonTaskHandlerInitializerFilter.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\City\Daemon\Filter\Initialization\Tasks;
   4
   5 // Import application-specific stuff
   6 use Org\Mxchange\City\Filter\BaseCityFilter;
   7 use Org\Mxchange\Factory\City\Daemon\CityDaemonFactory;
   8
   9 // Import framework stuff
  10 use Org\Mxchange\CoreFramework\Factory\Object\ObjectFactory;
  11 use Org\Mxchange\CoreFramework\Filter\Filterable;
  12 use Org\Mxchange\CoreFramework\Registry\Object\ObjectRegistry;
  13 use Org\Mxchange\CoreFramework\Request\Requestable;
  14 use Org\Mxchange\CoreFramework\Response\Responseable;
  15
  16 /**
  17  * A TaskHandlerInitializer filter for hubs
  18  *
  19  * @author              Roland Haeder <webmaster@shipsimu.org>
  20  * @version             0.0.0
  21  * @copyright   Copyright (c) 2015 - 2023 City Developer Team
  22  * @license             GNU GPL 3.0 or any newer version
  23  * @link                http://www.shipsimu.org
  24  *
  25  * This program is free software: you can redistribute it and/or modify
  26  * it under the terms of the GNU General Public License as published by
  27  * the Free Software Foundation, either version 3 of the License, or
  28  * (at your option) any later version.
  29  *
  30  * This program is distributed in the hope that it will be useful,
  31  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  32  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  33  * GNU General Public License for more details.
  34  *
  35  * You should have received a copy of the GNU General Public License
  36  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  37  */
  38 class CityDaemonTaskHandlerInitializerFilter extends BaseCityFilter implements Filterable {
  39         /**
  40          * Protected constructor
  41          *
  42          * @return      void
  43          */
  44         protected function __construct () {
  45                 // Call parent constructor
  46                 parent::__construct(__CLASS__);
  47         }
  48
  49         /**
  50          * Creates an instance of this filter class
  51          *
  52          * @return      $filterInstance         An instance of this filter class
  53          */
  54         public static final function createCityDaemonTaskHandlerInitializerFilter () {
  55                 // Get a new instance
  56                 $filterInstance = new CityDaemonTaskHandlerInitializerFilter();
  57
  58                 // Return the instance
  59                 return $filterInstance;
  60         }
  61
  62         /**
  63          * Executes the filter with given request and response objects
  64          *
  65          * @param       $requestInstance        An instance of a class with an Requestable interface
  66          * @param       $responseInstance       An instance of a class with an Responseable interface
  67          * @return      void
  68          * @throws      FilterChainException    If the filter chain needs to be interrupted
  69          * @todo        Add more tasks
  70          */
  71         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  72                 // Get city instance
  73                 $cityInstance = CityDaemonFactory::createCityDaemonInstance();
  74
  75                 // Get a new task handler instance
  76                 $handlerInstance = ObjectFactory::createObjectByConfiguredName('task_handler_class');
  77
  78                 // Put the task handler in registry
  79                 ObjectRegistry::getRegistry('generic')->addInstance('task_handler', $handlerInstance);
  80
  81                 // Prepare a city map expansion task
  82                 $taskInstance = ObjectFactory::createObjectByConfiguredName('city_daemon_map_expander_task_class');
  83
  84                 // Register it
  85                 $handlerInstance->registerTask('map_expander', $taskInstance);
  86
  87                 // Prepare a household growth task
  88                 $taskInstance = ObjectFactory::createObjectByConfiguredName('city_daemon_household_growth_task_class');
  89
  90                 // Register it
  91                 $handlerInstance->registerTask('household_growth', $taskInstance);
  92
  93                 // Prepare a building growth task
  94                 $taskInstance = ObjectFactory::createObjectByConfiguredName('city_daemon_building_growth_task_class');
  95
  96                 // Register it
  97                 $handlerInstance->registerTask('building_growth', $taskInstance);
  98
  99                 /*
 100                  * Add extra tasks depending on daemon modus.
 101                  */
 102                 $cityInstance->addExtraTasks($handlerInstance);
 103         }
 104 }