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