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

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