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

   1 <?php
   2 /**
   3  * An interface for region-information (database) wrapper
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2015 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 RegionInformationWrapper extends DatabaseWrapper {
  25         /**
  26          * Removes non-data from given array.
  27          *
  28          * @param       $data   An array with possible non-data that needs to be removed.
  29          * @return      $data   A cleaned up array with only data.
  30          */
  31         function removeNonPublicDataFromArray(array $data);
  32
  33         /**
  34          * Checks whether the user has already founded a region
  35          *
  36          * @return      $hasFounded             Whether the user has already founded a region
  37          */
  38         function ifUserHasCreatedRegion ();
  39
  40         /**
  41          * Checks whether the given region name is taken
  42          *
  43          * @param       $regionName             Name of region
  44          * @return      $isTaken                Whether the given region name is taken
  45          */
  46         function ifRegionExists ($regionName);
  47 }
  48
  49 // [EOF]
  50 ?>