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

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\City\Manager\City;
   4
   5 // Import own stuff
   6 use Org\Mxchange\City\Manager\Manageable;
   7
   8 /**
   9  * An interface city manager
  10  *
  11  * @author              Roland Haeder <webmaster@shipsimu.org>
  12  * @version             0.0.0
  13  * @copyright   Copyright (c) 2015, 2016 City Developer Team
  14  * @license             GNU GPL 3.0 or any newer version
  15  * @link                http://www.shipsimu.org
  16  *
  17  * This program is free software: you can redistribute it and/or modify
  18  * it under the terms of the GNU General Public License as published by
  19  * the Free Software Foundation, either version 3 of the License, or
  20  * (at your option) any later version.
  21  *
  22  * This program is distributed in the hope that it will be useful,
  23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  * GNU General Public License for more details.
  26  *
  27  * You should have received a copy of the GNU General Public License
  28  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  29  */
  30 interface ManageableCity extends Manageable {
  31
  32         /**
  33          * Checks whether the current user has already founded a city
  34          *
  35          * @return      $isFounded      Whether the current user has already founded a city
  36          */
  37         function isCityAlreadyFounded ();
  38
  39         /**
  40          * Checks whether the given city name is already taken
  41          *
  42          * @para        $cityName       Name of city
  43          * @return      $isTaken        Whether the given city name is already taken
  44          */
  45         function ifCityNameExists (string $cityName);
  46
  47         /**
  48          * Founds the first city. A dummy region will also be created
  49          *
  50          * @return      void
  51          */
  52         function foundFirstCity ();
  53
  54         /**
  55          * Renders the city map and forwards the output to the helper instance.
  56          *
  57          * @param       $helperInstance         An instance of a HelpableTemplate class
  58          * @return      void
  59          */
  60         function renderCityMap (HelpableTemplate $helperInstance);
  61 }