application/city/classes/database/frontend/game_options/class_CityGameOptionsDatabaseWrapper.php

   1 <?php
   2 /**
   3  * A database wrapper for game options
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2015, 2016 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 CityGameOptionsDatabaseWrapper extends BaseDatabaseWrapper implements CityGameOptionsWrapper, Registerable {
  25         // Constants for database table names
  26         const DB_TABLE_GAME_OPTION_INFORMATION = 'game_options';
  27
  28         // Constants for database column names
  29         const DB_COLUMN_GAME_OPTION_ID          = 'game_id';
  30         const DB_COLUMN_GAME_OPTION_USER_ID     = 'game_user_id';
  31         const DB_COLUMN_GAME_OPTION_FLAG_PAUSED = 'game_flag_paused';
  32
  33         /**
  34          * Protected constructor
  35          *
  36          * @return      void
  37          */
  38         protected function __construct () {
  39                 // Call parent constructor
  40                 parent::__construct(__CLASS__);
  41         }
  42
  43         /**
  44          * Creates an instance of this database wrapper by a provided user class
  45          *
  46          * @return      $wrapperInstance        An instance of the created wrapper class
  47          */
  48         public static final function createCityGameOptionsDatabaseWrapper () {
  49                 // Get a new instance
  50                 $wrapperInstance = new CityGameOptionsDatabaseWrapper();
  51
  52                 // Set (primary!) table name
  53                 $wrapperInstance->setTableName(self::DB_TABLE_GAME_OPTION_INFORMATION);
  54
  55                 // Return the instance
  56                 return $wrapperInstance;
  57         }
  58 }
  59
  60 // [EOF]
  61 ?>