application/city/classes/manager/city_entities/sections/class_CitySectionsManager.php

   1 <?php
   2 /**
   3  * A city sections manager
   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 CitySectionsManager extends BaseFrameworkSystem implements ManageableCitySections, 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 class
  37          *
  38          * @return      $managerInstance        An instance of a ManageableCitySections class
  39          */
  40         public final static function createCitySectionsManager () {
  41                 // Get new instance
  42                 $managerInstance = new CitySectionsManager();
  43
  44                 // Get database wrapper
  45                 $wrapperInstance = DatabaseWrapperFactory::createWrapperByConfiguredName('city_sections_db_wrapper_class');
  46
  47                 // And set it here
  48                 $managerInstance->setWrapperInstance($wrapperInstance);
  49
  50                 // Return the prepared instance
  51                 return $managerInstance;
  52         }
  53
  54         /**
  55          * Checks whether at least one map requires expansion
  56          *
  57          * @return      $requiresExpansion      Whether a map requires expansion
  58          * @todo        0% done
  59          */
  60         public function isMapPendingExpansion () {
  61                 // Default is no expansion is needed
  62                 $requireExpansion = FALSE;
  63
  64                 // First, a simple check if the sections table contains any entries at all
  65                 if ($this->getWrapperInstance()->countTotalRows() == 0) {
  66                         // This definedly requires expansion
  67                         $requireExpansion = TRUE;
  68                 } // END - if
  69
  70                 // Return status
  71                 return $requireExpansion;
  72         }
  73
  74         /**
  75          * Expands any map that requires expansion
  76          *
  77          * @return      void
  78          * @todo ~10% done
  79          * @todo z-coordinate not used
  80          */
  81         public function expandMaps () {
  82                 // Get a city info wrapper instance
  83                 $cityWrapperInstance = DatabaseWrapperFactory::createWrapperByConfiguredName('city_info_db_wrapper_class');
  84
  85                 // Get all city ids from it
  86                 $cityIds = $cityWrapperInstance->getAllCityIds();
  87
  88                 // Now check all ids
  89                 foreach ($cityIds as $cityId) {
  90                         // Does this id have any sections
  91                         if (!$this->getWrapperInstance()->ifCityHasSections($cityId)) {
  92                                 // Nothing found, so it is a brand-new city that needs first initialization
  93                                 $sections = $this->getWrapperInstance()->doInitialCityExpansion($cityId);
  94                         } else {
  95                                 // @TODO Maybe some expansion is needed
  96                         }
  97                 } // END - foreach
  98         }
  99 }
 100
 101 // [EOF]
 102 ?>