5 * @author Roland Haeder <webmaster@ship-simu.org>
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
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.
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.
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/>.
24 class CityLotsManager extends BaseFrameworkSystem implements ManageableCityLots, Registerable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
36 * Creates an instance of this class
38 * @return $managerInstance An instance of a ManageableCityLots class
40 public final static function createCityLotsManager () {
42 $managerInstance = new CityLotsManager();
44 // Get database wrapper
45 $wrapperInstance = DatabaseWrapperFactory::createWrapperByConfiguredName('city_lots_db_wrapper_class');
48 $managerInstance->setWrapperInstance($wrapperInstance);
50 // Return the prepared instance
51 return $managerInstance;
55 * Checks whether at least one map requires expansion
57 * @return $requiresExpansion Whether a map requires expansion
60 public function isMapPendingExpansion () {
61 // Default is no expansion is needed
62 $requireExpansion = FALSE;
64 // First, a simple check if the lots table contains any entries at all
65 if ($this->getWrapperInstance()->countTotalRows() == 0) {
66 // This definedly requires expansion
67 $requireExpansion = TRUE;
71 return $requireExpansion;
75 * Expands any map that requires expansion
79 * @todo z-coordinate not used
81 public function expandMaps () {
82 // Get a city info wrapper instance
83 $cityWrapperInstance = DatabaseWrapperFactory::createWrapperByConfiguredName('city_info_db_wrapper_class');
85 // Get all city ids from it
86 $cityIds = $cityWrapperInstance->getAllCityIds();
89 foreach ($cityIds as $cityId) {
90 // Does this id have any lots
91 if (!$this->getWrapperInstance()->ifCityHasLots($cityId)) {
92 // Nothing found, so it is a brand-new city that needs first initialization
93 $lots = $this->getWrapperInstance()->doInitialCityExpansion($cityId);
95 // @TODO Maybe some expansion is needed