application/city/interfaces/database/frontend/city/class_CityInformationWrapper.php

   1 <?php
   2 /**
   3  * An interface for city-information (database) wrapper
   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 CityInformationWrapper extends DatabaseWrapper {
  25         /**
  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...
  28          *
  29          * @param       $cityInstance           A city instance
  30          * @param       $requestInstance        An instance of a Requestable class
  31          * @return      void
  32          */
  33         function registerCityId (BaseCityDaemon $cityInstance, Requestable $requestInstance);
  34
  35         /**
  36          * Checks whether there is an entry for given city instance
  37          *
  38          * @param       $cityInstance   An instance of a CityHelper class
  39          * @return      $isFound                Whether a city id has been found for this city
  40          */
  41         function ifCityDataIsFound (CityHelper $cityInstance);
  42
  43         /**
  44          * Removes non-data from given array.
  45          *
  46          * @param       $data   An array with possible non-data that needs to be removed.
  47          * @return      $data   A cleaned up array with only data.
  48          */
  49         function removeNonPublicDataFromArray(array $data);
  50
  51         /**
  52          * Checks whether the user has already founded a city
  53          *
  54          * @return      $hasFounded             Whether the user has already founded a city
  55          */
  56         function ifUserHasFoundedCity ();
  57
  58         /**
  59          * Checks whether the given city name is taken
  60          *
  61          * @para        $cityName       Name of city
  62          * @return      $isTaken        Whether the given city name is taken
  63          */
  64         function ifCityExists ($cityName);
  65
  66         /**
  67          * Creates a city from given request
  68          *
  69          * @para        $requestInstance        An instance of a Requestable class
  70          * @return      void
  71          */
  72         function createCityByRequest (Requestable $requestInstance);
  73
  74         /**
  75          * Getter for all city ids as an array
  76          *
  77          * @return      $cityIds        All city ids as an array
  78          */
  79         function getAllCityIds ();
  80 }
  81
  82 // [EOF]
  83 ?>