application/city/classes/manager/region/class_RegionManager.php

   1 <?php
   2 /**
   3  * A Region manager
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2015 Region Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.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 class RegionManager extends BaseManager implements ManageableRegion {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33         }
  34
  35         /**
  36          * Creates an instance of this class
  37          *
  38          * @return      $managerInstance        An instance of a ManageableRegion class
  39          */
  40         public final static function createRegionManager () {
  41                 // Get new instance
  42                 $managerInstance = new RegionManager();
  43
  44                 // Get database wrapper
  45                 $wrapperInstance = DatabaseWrapperFactory::createWrapperByConfiguredName('region_info_db_wrapper_class');
  46
  47                 // And set it here
  48                 $managerInstance->setWrapperInstance($wrapperInstance);
  49
  50                 // Return the prepared instance
  51                 return $managerInstance;
  52         }
  53
  54         /**
  55          * Checks whether the current user has already founded a region
  56          *
  57          * @return      $isFounded      Whether the current user has already founded a region
  58          */
  59         public function ifUserHasCreatedRegion () {
  60                 // Check if the currently set user has already founded a region
  61                 $isFounded = $this->getWrapperInstance()->ifUserHasCreatedRegion();
  62
  63                 // Return result
  64                 return $isFounded;
  65         }
  66
  67         /**
  68          * Checks whether the given region name is already taken
  69          *
  70          * @para        $regionName             Name of region
  71          * @return      $isTaken                Whether the given region name is already taken
  72          */
  73         public function ifRegionNameExists ($regionName) {
  74                 // Check if the given region name is taken
  75                 $isTaken = $this->getWrapperInstance()->ifRegionExists($regionName);
  76
  77                 // Return result
  78                 return $isTaken;
  79         }
  80
  81         /**
  82          * Founds the first region. A dummy region will also be created
  83          *
  84          * @return      $resultInstance         Found result after creating it
  85          */
  86         public function createFirstRegion () {
  87                 // Dummy name
  88                 // @TODO Move to language system
  89                 $regionName = 'Region 1';
  90
  91                 // Some pre-checks
  92                 assert(!$this->ifUserHasCreatedRegion());
  93                 assert(!$this->ifRegionNameExists($regionName));
  94
  95                 // First region can now be created
  96                 $this->getWrapperInstance()->createRegionByName($regionName);
  97
  98                 // Then try to find it
  99                 assert($this->ifRegionNameExists($regionName));
 100
 101                 // Get result instance
 102                 $resultInstance = $this->getResultInstance();
 103
 104                 // And return it
 105                 return $resultInstance;
 106         }
 107 }
 108
 109 // [EOF]
 110 ?>