application/city/classes/tasks/daemon/map_expander/class_CityDaemonMapExpanderTask.php

   1 <?php
   2 /**
   3  * A map expander task for the daemon
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Hub 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 CityDaemonMapExpanderTask extends BaseCityTask implements Taskable, Visitable {
  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 class
  37          *
  38          * @return      $taskInstance   An instance of a Visitable class
  39          */
  40         public final static function createCityDaemonMapExpanderTask () {
  41                 // Get new instance
  42                 $taskInstance = new CityDaemonMapExpanderTask();
  43
  44                 // Get city daemon instance
  45                 $cityInstance = CityDaemonFactory::createCityDaemonInstance();
  46
  47                 // Set it here for "caching" it
  48                 $taskInstance->setCityInstance($cityInstance);
  49
  50                 // Return the prepared instance
  51                 return $taskInstance;
  52         }
  53
  54         /**
  55          * Accepts the visitor to process the visitor
  56          *
  57          * @param       $visitorInstance        An instance of a Visitor class
  58          * @return      void
  59          * @todo        Maybe visit some sub-objects
  60          */
  61         public function accept (Visitor $visitorInstance) {
  62                 // Visit this task
  63                 $visitorInstance->visitTask($this);
  64         }
  65
  66         /**
  67          * Executes the task
  68          *
  69          * @return      void
  70          * @todo        ~ 10% done
  71          */
  72         public function executeTask () {
  73                 // Get daemon instance
  74                 $cityInstance = $this->getCityInstance();
  75
  76                 // Is there at least one map to expand?
  77                 if ($cityInstance->isMapPendingExpansion()) {
  78                         // Expand the map
  79                         $cityInstance->expandMaps();
  80                 } // END - if
  81         }
  82
  83         /**
  84          * Shuts down the task
  85          *
  86          * @return      void
  87          * @todo        0% done
  88          */
  89         public function doShutdown () {
  90                 self::createDebugInstance(__CLASS__)->debugOutput('TASK[' . __METHOD__ . ':' . __LINE__ . ']: Shutting down...');
  91         }
  92 }
  93
  94 // [EOF]
  95 ?>