59e92fccf240d0da90947885d7c844fccbfa338c
[core.git] / inc / classes / main / database / wrapper / class_PaymentsDatabaseWrapper.php
1 <?php
2 /**
3  * A database wrapper for payments
4  *
5  * @author              Roland Haeder <webmaster@shipsimu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Core 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 PaymentsDatabaseWrapper extends BaseDatabaseWrapper {
25         // Constants for exceptions
26         const EXCEPTION_CLIENT_USERNAME_NOT_FOUND = 0x180;
27
28         // Constants for database table names
29         const DB_TABLE_PAYMENTS = 'payments';
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 createPaymentsDatabaseWrapper () {
47                 // Get a new instance
48                 $wrapperInstance = new PaymentsDatabaseWrapper();
49
50                 // Set (primary!) table name
51                 $wrapperInstance->setTableName(self::DB_TABLE_PAYMENTS);
52
53                 // Return the instance
54                 return $wrapperInstance;
55         }
56 }
57
58 // [EOF]
59 ?>