5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2015, 2016 City Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.org
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.
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.
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/>.
24 class RegionManager extends BaseManager implements ManageableRegion {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
36 * Creates an instance of this class
38 * @return $managerInstance An instance of a ManageableRegion class
40 public final static function createRegionManager () {
42 $managerInstance = new RegionManager();
44 // Get database wrapper
45 $wrapperInstance = DatabaseWrapperFactory::createWrapperByConfiguredName('region_info_db_wrapper_class');
48 $managerInstance->setWrapperInstance($wrapperInstance);
50 // Return the prepared instance
51 return $managerInstance;
55 * Checks whether the current user has already founded a region
57 * @return $isFounded Whether the current user has already founded a region
59 public function ifUserHasCreatedRegion () {
60 // Check if the currently set user has already founded a region
61 $isFounded = $this->getWrapperInstance()->ifUserHasCreatedRegion();
68 * Checks whether the given region name is already taken
70 * @para $regionName Name of region
71 * @return $isTaken Whether the given region name is already taken
73 public function ifRegionNameExists ($regionName) {
74 // Check if the given region name is taken
75 $isTaken = $this->getWrapperInstance()->ifRegionExists($regionName);
82 * Founds the first region. A dummy region will also be created
84 * @return $resultInstance Found result after creating it
86 public function createFirstRegion () {
88 // @TODO Move to language system
89 $regionName = 'Region 1';
92 assert(!$this->ifUserHasCreatedRegion());
93 assert(!$this->ifRegionNameExists($regionName));
95 // First region can now be created
96 $this->getWrapperInstance()->createRegionByName($regionName);
98 // Then try to find it
99 assert($this->ifRegionNameExists($regionName));
101 // Get result instance
102 $resultInstance = $this->getResultInstance();
105 return $resultInstance;