application/city/interfaces/manager/city/class_ManageableCity.php

   1 <?php
   2 /**
   3  * An interface city manager
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   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
  10  *
  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.
  15  *
  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.
  20  *
  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/>.
  23  */
  24 interface ManageableCity extends Manageable {
  25
  26         /**
  27          * Checks whether the current user has already founded a city
  28          *
  29          * @return      $isFounded      Whether the current user has already founded a city
  30          */
  31         function isCityAlreadyFounded ();
  32
  33         /**
  34          * Checks whether the given city name is already taken
  35          *
  36          * @para        $cityName       Name of city
  37          * @return      $isTaken        Whether the given city name is already taken
  38          */
  39         function ifCityNameExists ($cityName);
  40
  41         /**
  42          * Founds the first city. A dummy region will also be created
  43          *
  44          * @return      void
  45          */
  46         function foundFirstCity ();
  47
  48         /**
  49          * Renders the city map and forwards the output to the helper instance.
  50          *
  51          * @param       $helperInstance         An instance of a HelpableTemplate class
  52          * @return      void
  53          */
  54         function renderCityMap (HelpableTemplate $helperInstance);
  55 }