3 namespace Org\Mxchange\City\Manager\Sections;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Object\BaseFrameworkSystem;
9 * A city sections manager
11 * @author Roland Haeder <webmaster@ship-simu.org>
13 * @copyright Copyright (c) 2015, 2016 City Developer Team
14 * @license GNU GPL 3.0 or any newer version
15 * @link http://www.ship-simu.org
17 * This program is free software: you can redistribute it and/or modify
18 * it under the terms of the GNU General Public License as published by
19 * the Free Software Foundation, either version 3 of the License, or
20 * (at your option) any later version.
22 * This program is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
27 * You should have received a copy of the GNU General Public License
28 * along with this program. If not, see <http://www.gnu.org/licenses/>.
30 class CitySectionsManager extends BaseFrameworkSystem implements ManageableCitySections, Registerable {
32 * Protected constructor
36 protected function __construct () {
37 // Call parent constructor
38 parent::__construct(__CLASS__);
42 * Creates an instance of this class
44 * @return $managerInstance An instance of a ManageableCitySections class
46 public final static function createCitySectionsManager () {
48 $managerInstance = new CitySectionsManager();
50 // Get database wrapper
51 $wrapperInstance = DatabaseWrapperFactory::createWrapperByConfiguredName('city_sections_db_wrapper_class');
54 $managerInstance->setWrapperInstance($wrapperInstance);
56 // Return the prepared instance
57 return $managerInstance;
61 * Checks whether at least one map requires expansion
63 * @return $requiresExpansion Whether a map requires expansion
66 public function isMapPendingExpansion () {
67 // Default is no expansion is needed
68 $requireExpansion = FALSE;
70 // First, a simple check if the sections table contains any entries at all
71 if ($this->getWrapperInstance()->countTotalRows() == 0) {
72 // This definedly requires expansion
73 $requireExpansion = TRUE;
77 return $requireExpansion;
81 * Expands any map that requires expansion
85 * @todo z-coordinate not used
87 public function expandMaps () {
88 // Get a city info wrapper instance
89 $cityWrapperInstance = DatabaseWrapperFactory::createWrapperByConfiguredName('city_info_db_wrapper_class');
91 // Get all city ids from it
92 $cityIds = $cityWrapperInstance->getAllCityIds();
95 foreach ($cityIds as $cityId) {
96 // Does this id have any sections
97 if (!$this->getWrapperInstance()->ifCityHasSections($cityId)) {
98 // Nothing found, so it is a brand-new city that needs first initialization
99 $sections = $this->getWrapperInstance()->doInitialCityExpansion($cityId);
101 // @TODO Maybe some expansion is needed