application/city/main/database/frontend/region_map/class_RegionMapDatabaseWrapper.php

   1 <?php
   2 /**
   3  * A database wrapper for region maps
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2015 City Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.shipsimu.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 RegionMapDatabaseWrapper extends BaseDatabaseWrapper implements RegionMapWrapper, Registerable {
  25         // Constants for database table names
  26         const DB_TABLE_REGION_MAP = 'region_map';
  27
  28         // Constants for database column names
  29         const DB_COLUMN_REGION_ID = 'region_id';
  30
  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 database wrapper by a provided user class
  43          *
  44          * @return      $wrapperInstance        An instance of the created wrapper class
  45          */
  46         public static final function createRegionMapDatabaseWrapper () {
  47                 // Get a new instance
  48                 $wrapperInstance = new RegionMapDatabaseWrapper();
  49
  50                 // Set (primary!) table name
  51                 $wrapperInstance->setTableName(self::DB_TABLE_REGION_MAP);
  52
  53                 // Return the instance
  54                 return $wrapperInstance;
  55         }
  56
  57         /**
  58          * Removes non-public data from given array.
  59          *
  60          * @param       $data   An array with possible non-public data that needs to be removed.
  61          * @return      $data   A cleaned up array with only public data.
  62          */
  63         public function removeNonPublicDataFromArray(array $data) {
  64                 // Currently call only inner method
  65                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('REGION-WRAPPER[' . __METHOD__ . ':' . __LINE__ . ']: Calling parent::removeNonPublicDataFromArray(data) ...');
  66                 $data = parent::removeNonPublicDataFromArray($data);
  67
  68                 // Return cleaned data
  69                 return $data;
  70         }
  71
  72         /**
  73          * Creates a region by given name
  74          *
  75          * @return      void
  76          */
  77         public function createRegionByName () {
  78                 // Pre-check
  79                 die(__METHOD__ . ': Unfinshed!');
  80                 assert(!$this->ifRegionExists($regionName));
  81
  82                 // Get user instance
  83                 $userInstance = Registry::getRegistry()->getInstance('user');
  84
  85                 // Get a dataset instance
  86                 $dataSetInstance = ObjectFactory::createObjectByConfiguredName('dataset_criteria_class', array(self::DB_TABLE_REGION_MAP));
  87
  88                 // Set the primary key
  89                 $dataSetInstance->setUniqueKey(self::DB_COLUMN_REGION_ID);
  90
  91                 // Add region name and assign user id
  92                 $dataSetInstance->addCriteria(self::DB_COLUMN_REGION_ID     , ($this->countTotalRows() + 1));
  93
  94                 // "Insert" this dataset instance completely into the database
  95                 $this->queryInsertDataSet($dataSetInstance);
  96
  97                 // Post-check name
  98                 assert($this->ifRegionExists($regionName));
  99         }
 100 }
 101
 102 // [EOF]
 103 ?>