Code merge from latest Ship-Simu code
[mailer.git] / inc / classes / main / database / class_BaseDatabaseFrontend.php
1 <?php
2 /**
3  * An abstract database access class for handling database I/O requests
4  *
5  * @see                 DatabaseFrontendInterface - An interface for database frontends (front-end to the application)
6  * @author              Roland Haeder <webmaster@ship-simu.org>
7  * @version             0.0.0
8  * @copyright   Copyright(c) 2007, 2008 Roland Haeder, this is free software
9  * @license             GNU GPL 3.0 or any newer version
10  * @link                http://www.ship-simu.org
11  *
12  * This program is free software: you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation, either version 3 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program. If not, see <http://www.gnu.org/licenses/>.
24  */
25 abstract class BaseDatabaseFrontend extends BaseFrameworkSystem implements DatabaseFrontendInterface, LimitableObject {
26         /**
27          * The limiter instance
28          */
29         private $limitInstance = null;
30
31         /**
32          * Protected constructor
33          *
34          * @return      void
35          */
36         protected function __construct($class) {
37                 // Call parent constructor
38                 parent::__construct($class);
39
40                 // Clean up a little
41                 $this->removeNumberFormaters();
42         }
43
44         /**
45          * Getter for limitation instance
46          *
47          * @return      $limitInstance          The instance to the object ObjectLimits
48          */
49         public final function getLimitInstance () {
50                 return $this->limitInstance;
51         }
52
53         /**
54          * Setup limitation for the saving process
55          *
56          * @param               $limitInstance  An instance of ObjectLimits which contains
57          *                                              elements we shall exclusivly include in
58          *                                              saving process
59          * @return      void
60          */
61         public final function limitObject (ObjectLimits $limitInstance) {
62                 // Get limitArray for validation
63                 $array = $limitInstance->getLimitArray();
64
65                 // Sanity-check if some limitations are in the object
66                 if ($array->count() > 0) {
67                         // Okay, there is enougth
68                         $this->limitInstance = $limitInstance;
69                 }
70         }
71 }
72
73 // [EOF]
74 ?>