application/city/interfaces/manager/region/class_ManageableRegion.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\City\Manager\Region;
   4
   5 // Import own stuff
   6 use Org\Mxchange\City\Manager\Manageable;
   7
   8 /**
   9  * An interface region manager
  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 ManageableRegion extends Manageable {
  31         /**
  32          * Checks whether the current user has already founded a region
  33          *
  34          * @return      $isFounded      Whether the current user has already founded a region
  35          */
  36         function ifUserHasCreatedRegion ();
  37
  38         /**
  39          * Checks whether the given region name is already taken
  40          *
  41          * @para        $regionName             Name of region
  42          * @return      $isTaken                Whether the given region name is already taken
  43          */
  44         function ifRegionNameExists ($regionName);
  45
  46         /**
  47          * Creates first region
  48          *
  49          * @return      $resultInstance         Found result after creating it
  50          */
  51         function createFirstRegion ();
  52 }