application/city/classes/city_daemon/default/class_SimulationDefaultCityDaemon.php

   1 <?php
   2 /**
   3  * The default city daemon
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.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.shipsimu.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 SimulationDefaultCityDaemon extends BaseCityDaemon implements CityHelper, Registerable {
  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          * Creates an instance of this hub-node class
  37          *
  38          * @param       $requestInstance        An instance of a Requestable class
  39          * @return      $nodeInstance           An instance of this hub-node class
  40          */
  41         public static final function createSimulationDefaultCityDaemon (Requestable $requestInstance) {
  42                 // Get a new instance
  43                 $nodeInstance = new SimulationDefaultCityDaemon();
  44
  45                 // Set the request instance
  46                 $nodeInstance->setRequestInstance($requestInstance);
  47
  48                 // Return the instance
  49                 return $nodeInstance;
  50         }
  51
  52         /**
  53          * Method to "bootstrap" the city simulation. This step does also apply
  54          * provided command-line arguments stored in the request instance.
  55          *
  56          * @return      void
  57          * @todo        Implement this method
  58          */
  59         public function doBootstrapping () {
  60                 $this->partialStub();
  61         }
  62
  63         /**
  64          * Add some node-specific filters
  65          *
  66          * @return      void
  67          */
  68         public function addExtraCityFilters () {
  69                 // Get the application instance from registry
  70                 $applicationInstance = Registry::getRegistry()->getInstance('app');
  71
  72                 // Get the controller from the application
  73                 $controllerInstance = $applicationInstance->getControllerInstance();
  74
  75                 // Foo task
  76                 // @TODO $controllerInstance->addActivationFilter(ObjectFactory::createObjectByConfiguredName('city_foo_task_filter'));
  77
  78                 // @TODO Add some filters here
  79                 $this->partialStub('Add some filters here.');
  80         }
  81
  82         /**
  83          * Adds extra tasks to the given handler for this node
  84          *
  85          * @param       $handlerInstance        An instance of a HandleableTask class
  86          * @return      void
  87          * @todo        0% done
  88          */
  89         public function addExtraTasks (HandleableTask $handlerInstance) {
  90                 $this->partialStub('Please add some tasks or empty this method.');
  91         }
  92 }
  93
  94 // [EOF]
  95 ?>