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 CityManager extends BaseManager implements ManageableCity {
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 ManageableCity class
40 public final static function createCityManager () {
42 $managerInstance = new CityManager();
44 // Get database wrapper
45 $wrapperInstance = DatabaseWrapperFactory::createWrapperByConfiguredName('city_info_db_wrapper_class');
48 $managerInstance->setWrapperInstance($wrapperInstance);
50 // Return the prepared instance
51 return $managerInstance;
55 * Checks whether the current user has already founded a city
57 * @return $isFounded Whether the current user has already founded a city
59 public function isCityAlreadyFounded () {
60 // Check if the currently set user has already founded a city
61 $isFounded = $this->getWrapperInstance()->ifUserHasFoundedCity();
68 * Checks whether the given city name is already taken
70 * @para $cityName Name of city
71 * @return $isTaken Whether the given city name is already taken
73 public function ifCityNameExists ($cityName) {
74 // Check if the given city name is taken
75 $isTaken = $this->getWrapperInstance()->ifCityExists($cityName);
82 * Founds the first city. A dummy region will also be created
86 public function foundFirstCity () {
87 // Check on request instance and 'city_name' element
88 assert($this->getRequestInstance() instanceof Requestable);
89 assert($this->getRequestInstance()->isRequestElementSet(CityInformationDatabaseWrapper::DB_COLUMN_CITY_NAME));
92 $cityName = $this->getRequestInstance()->getRequestElement(CityInformationDatabaseWrapper::DB_COLUMN_CITY_NAME);
95 assert(!$this->isCityAlreadyFounded());
96 assert(!$this->ifCityNameExists($cityName));
99 $managerInstance = ManagerFactory::createManagerByType('region');
101 // The manager instance should be valid and no region should be created
102 assert($managerInstance instanceof ManageableRegion);
103 assert(!$managerInstance->ifUserHasCreatedRegion());
105 // Create first region and get back whole result
106 $regionResultInstance = $managerInstance->createFirstRegion();
109 $regionData = $regionResultInstance->current();
111 // Add region id from it
112 $this->getRequestInstance()->setRequestElement(CityInformationDatabaseWrapper::DB_COLUMN_CITY_REGION_ID, $regionData[RegionInformationDatabaseWrapper::DB_COLUMN_REGION_ID]);
114 // Then create the first city
115 $this->getWrapperInstance()->createCityByRequest($this->getRequestInstance());
119 * Renders the city map and forwards the output to the helper instance.
121 * @param $helperInstance An instance of a HelpableTemplate class
124 public function renderCityMap (HelpableTemplate $helperInstance) {
125 $this->partialStub('Please implement this method.');