application/city/interfaces/database/frontend/region/class_RegionInformationFrontend.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\City\Database\Frontend\Information\Region;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Database\Frontend\DatabaseFrontend;
   7
   8 /**
   9  * An interface for region-information (database) frontend
  10  *
  11  * @author              Roland Haeder <webmaster@shipsimu.org>
  12  * @version             0.0.0
  13  * @copyright   Copyright (c) 2015 - 2023 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 RegionInformationFrontend extends DatabaseFrontend {
  31         /**
  32          * Removes non-data from given array.
  33          *
  34          * @param       $data   An array with possible non-data that needs to be removed.
  35          * @return      $data   A cleaned up array with only data.
  36          */
  37         function removeNonPublicDataFromArray(array $data);
  38
  39         /**
  40          * Checks whether the user has already founded a region
  41          *
  42          * @return      $hasFounded             Whether the user has already founded a region
  43          */
  44         function ifUserHasCreatedRegion ();
  45
  46         /**
  47          * Checks whether the given region name is taken
  48          *
  49          * @param       $regionName             Name of region
  50          * @return      $isTaken                Whether the given region name is taken
  51          */
  52         function ifRegionExists ($regionName);
  53
  54         /**
  55          * Creates a region by given name
  56          *
  57          * @param       $regionName             Name of region
  58          * @return      void
  59          */
  60         function createRegionByName ($regionName);
  61 }