3 * An interface city manager
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2015, 2016 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 ManageableCity extends Manageable {
27 * Checks whether the current user has already founded a city
29 * @return $isFounded Whether the current user has already founded a city
31 function isCityAlreadyFounded ();
34 * Checks whether the given city name is already taken
36 * @para $cityName Name of city
37 * @return $isTaken Whether the given city name is already taken
39 function ifCityNameExists ($cityName);
42 * Founds the first city. A dummy region will also be created
46 function foundFirstCity ();
49 * Renders the city map and forwards the output to the helper instance.
51 * @param $helperInstance An instance of a HelpableTemplate class
54 function renderCityMap (HelpableTemplate $helperInstance);