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