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

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\City\Manager\Entities\Sections;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Factory\Database\Wrapper\DatabaseWrapperFactory;
   7 use Org\Mxchange\CoreFramework\Object\BaseFrameworkSystem;
   8 use Org\Mxchange\CoreFramework\Registry\Registerable;
   9
  10 /**
  11  * A city sections manager
  12  *
  13  * @author              Roland Haeder <webmaster@ship-simu.org>
  14  * @version             0.0.0
  15  * @copyright   Copyright (c) 2015, 2016 City Developer Team
  16  * @license             GNU GPL 3.0 or any newer version
  17  * @link                http://www.ship-simu.org
  18  *
  19  * This program is free software: you can redistribute it and/or modify
  20  * it under the terms of the GNU General Public License as published by
  21  * the Free Software Foundation, either version 3 of the License, or
  22  * (at your option) any later version.
  23  *
  24  * This program is distributed in the hope that it will be useful,
  25  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  26  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  27  * GNU General Public License for more details.
  28  *
  29  * You should have received a copy of the GNU General Public License
  30  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  31  */
  32 class CitySectionsManager extends BaseFrameworkSystem implements ManageableCitySections, Registerable {
  33         /**
  34          * Protected constructor
  35          *
  36          * @return      void
  37          */
  38         protected function __construct () {
  39                 // Call parent constructor
  40                 parent::__construct(__CLASS__);
  41         }
  42
  43         /**
  44          * Creates an instance of this class
  45          *
  46          * @return      $managerInstance        An instance of a ManageableCitySections class
  47          */
  48         public final static function createCitySectionsManager () {
  49                 // Get new instance
  50                 $managerInstance = new CitySectionsManager();
  51
  52                 // Get database wrapper
  53                 $wrapperInstance = DatabaseWrapperFactory::createWrapperByConfiguredName('city_sections_db_wrapper_class');
  54
  55                 // And set it here
  56                 $managerInstance->setWrapperInstance($wrapperInstance);
  57
  58                 // Return the prepared instance
  59                 return $managerInstance;
  60         }
  61
  62         /**
  63          * Checks whether at least one map requires expansion
  64          *
  65          * @return      $requiresExpansion      Whether a map requires expansion
  66          * @todo        0% done
  67          */
  68         public function isMapPendingExpansion () {
  69                 // Default is no expansion is needed
  70                 $requireExpansion = FALSE;
  71
  72                 // First, a simple check if the sections table contains any entries at all
  73                 if ($this->getWrapperInstance()->countTotalRows() == 0) {
  74                         // This definedly requires expansion
  75                         $requireExpansion = TRUE;
  76                 } // END - if
  77
  78                 // Return status
  79                 return $requireExpansion;
  80         }
  81
  82         /**
  83          * Expands any map that requires expansion
  84          *
  85          * @return      void
  86          * @todo ~10% done
  87          * @todo z-coordinate not used
  88          */
  89         public function expandMaps () {
  90                 // Get a city info wrapper instance
  91                 $cityWrapperInstance = DatabaseWrapperFactory::createWrapperByConfiguredName('city_info_db_wrapper_class');
  92
  93                 // Get all city ids from it
  94                 $cityIds = $cityWrapperInstance->getAllCityIds();
  95
  96                 // Now check all ids
  97                 foreach ($cityIds as $cityId) {
  98                         // Does this id have any sections
  99                         if (!$this->getWrapperInstance()->ifCityHasSections($cityId)) {
 100                                 // Nothing found, so it is a brand-new city that needs first initialization
 101                                 $sections = $this->getWrapperInstance()->doInitialCityExpansion($cityId);
 102                         } else {
 103                                 // @TODO Maybe some expansion is needed
 104                         }
 105                 } // END - foreach
 106         }
 107 }