application/city/classes/manager/game/class_GameManager.php

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