inc/main/classes/database/frontend/class_NewsDatabaseWrapper.php

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Database\Wrapper;
   4
   5 // Import framework stuff
   6 use CoreFramework\Registry\Registerable;
   7
   8 /**
   9  * A database wrapper for news classes
  10  *
  11  * @author              Roland Haeder <webmaster@shipsimu.org>
  12  * @version             0.0.0
  13  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  14  * @license             GNU GPL 3.0 or any newer version
  15  * @link                http://www.shipsimu.org
  16  * @todo                Add missing own interface for public methods
  17  *
  18  * This program is free software: you can redistribute it and/or modify
  19  * it under the terms of the GNU General Public License as published by
  20  * the Free Software Foundation, either version 3 of the License, or
  21  * (at your option) any later version.
  22  *
  23  * This program is distributed in the hope that it will be useful,
  24  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  26  * GNU General Public License for more details.
  27  *
  28  * You should have received a copy of the GNU General Public License
  29  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  30  */
  31 class NewsDatabaseWrapper extends BaseDatabaseWrapper implements Registerable {
  32         // Constants for database table names
  33         const DB_TABLE_NEWS = 'news';
  34
  35         /**
  36          * Protected constructor
  37          *
  38          * @return      void
  39          */
  40         protected function __construct () {
  41                 // Call parent constructor
  42                 parent::__construct(__CLASS__);
  43         }
  44
  45         /**
  46          * Creates an instance of this database wrapper by a provided user class
  47          *
  48          * @return      $wrapperInstance        An instance of the created wrapper class
  49          */
  50         public static final function createNewsDatabaseWrapper () {
  51                 // Get a new instance
  52                 $wrapperInstance = new NewsDatabaseWrapper();
  53
  54                 // Set (primary!) table name
  55                 $wrapperInstance->setTableName(self::DB_TABLE_NEWS);
  56
  57                 // Return the instance
  58                 return $wrapperInstance;
  59         }
  60
  61 }