3 * An interface for city-information (database) wrapper
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2015 City Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.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 interface CityInformationWrapper extends DatabaseWrapper {
26 * 'Registers' a new city id along with data provided in the city instance.
27 * This may sound confusing but avoids double code very nicely...
29 * @param $cityInstance A city instance
30 * @param $requestInstance An instance of a Requestable class
33 function registerCityId (BaseCity $cityInstance, Requestable $requestInstance);
36 * Checks whether there is an entry for given city instance
38 * @param $cityInstance An instance of a CityHelper class
39 * @return $isFound Whether a city id has been found for this city
41 function ifCityDataIsFound (CityHelper $cityInstance);
44 * Removes non-data from given array.
46 * @param $data An array with possible non-data that needs to be removed.
47 * @return $data A cleaned up array with only data.
49 function removeNonPublicDataFromArray(array $data);
52 * Checks whether the user has already founded a city
54 * @return $hasFounded Whether the user has already founded a city
56 function ifUserHasFoundedCity ();
59 * Checks whether the given city name is taken
61 * @para $cityName Name of city
62 * @return $isTaken Whether the given city name is taken
64 function ifCityExists ($cityName);
67 * Creates a city from given request
69 * @para $requestInstance An instance of a Requestable class
72 function createCityByRequest (Requestable $requestInstance);