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         // Constants for exceptions
  27         const EXCEPTION_SQL_QUERY = 0xc00;
  28
  29         /**
  30          * The limiter instance
  31          */
  32         private $limitInstance = null;
  33
  34         /**
  35          * Protected constructor
  36          *
  37          * @return      void
  38          */
  39         protected function __construct($class) {
  40                 // Call parent constructor
  41                 parent::__construct($class);
  42
  43                 // Clean up a little
  44                 $this->removeNumberFormaters();
  45         }
  46
  47         /**
  48          * Getter for limitation instance
  49          *
  50          * @return      $limitInstance          The instance to the object ObjectLimits
  51          */
  52         public final function getLimitInstance () {
  53                 return $this->limitInstance;
  54         }
  55
  56         /**
  57          * Setup limitation for the saving process
  58          *
  59          * @param               $limitInstance  An instance of ObjectLimits which contains
  60          *                                              elements we shall exclusivly include in
  61          *                                              saving process
  62          * @return      void
  63          */
  64         public final function limitObject (ObjectLimits $limitInstance) {
  65                 // Get limitArray for validation
  66                 $array = $limitInstance->getLimitArray();
  67
  68                 // Sanity-check if some limitations are in the object
  69                 if ($array->count() > 0) {
  70                         // Okay, there is enougth
  71                         $this->limitInstance = $limitInstance;
  72                 }
  73         }
  74 }
  75
  76 // [EOF]
  77 ?>