framework/main/classes/database/frontend/class_PaymentsDatabaseWrapper.php

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Wrapper\Database;
   4
   5 // Import framework stuff
   6 use CoreFramework\Wrapper\Database\BaseDatabaseWrapper;
   7
   8 /**
   9  * A database wrapper for payments
  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 PaymentsDatabaseWrapper extends BaseDatabaseWrapper implements Registerable {
  32         // Constants for exceptions
  33         const EXCEPTION_CLIENT_USERNAME_NOT_FOUND = 0x180;
  34
  35         // Constants for database table names
  36         const DB_TABLE_PAYMENTS = 'payments';
  37
  38         /**
  39          * Protected constructor
  40          *
  41          * @return      void
  42          */
  43         protected function __construct () {
  44                 // Call parent constructor
  45                 parent::__construct(__CLASS__);
  46         }
  47
  48         /**
  49          * Creates an instance of this database wrapper by a provided user class
  50          *
  51          * @return      $wrapperInstance        An instance of the created wrapper class
  52          */
  53         public static final function createPaymentsDatabaseWrapper () {
  54                 // Get a new instance
  55                 $wrapperInstance = new PaymentsDatabaseWrapper();
  56
  57                 // Set (primary!) table name
  58                 $wrapperInstance->setTableName(self::DB_TABLE_PAYMENTS);
  59
  60                 // Return the instance
  61                 return $wrapperInstance;
  62         }
  63
  64 }