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@mxchange.org>
   7  * @version             0.3.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.mxchange.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          * Private constructor
  33          *
  34          * @return      void
  35          */
  36         private function __construct($class) {
  37                 // Call parent constructor
  38                 parent::constructor($class);
  39
  40                 // Debug message
  41                 if (((defined('DEBUG_DATABASE')) || (defined('DEBUG_ALL'))) && (defined('DEBUG_CONSTRUCT'))) $this->getDebugInstance()->output(sprintf("[%s:] Konstruktor erreicht.<br />\n",
  42                         $this->__toString()
  43                 ));
  44
  45                 // Clean up a little
  46                 $this->removeNumberFormaters();
  47         }
  48
  49         /**
  50          * The public constructor
  51          *
  52          * @return      void
  53          */
  54         public function constructor ($class) {
  55                 // Calls just the private one
  56                 $this->__construct($class);
  57         }
  58
  59         /**
  60          * Getter for limitation instance
  61          *
  62          * @return      $limitInstance          The instance to the object ObjectLimits
  63          */
  64         public final function getLimitInstance () {
  65                 if ((defined('DEBUG_DATABASE')) || (defined('DEBUG_ALL'))) $this->getDebugInstance()->output(sprintf("[%s:] Limitierungsinstanz <strong>%s</strong> angefordert.<br />\n",
  66                         $this->__toString(),
  67                         $this->limitInstance->__toString()
  68                 ));
  69                 return $this->limitInstance;
  70         }
  71
  72         /**
  73          * Setup limitation for the saving process
  74          *
  75          * @param               $limitInstance  An instance of ObjectLimits which contains
  76          *                                              elements we shall exclusivly include in
  77          *                                              saving process
  78          * @return      void
  79          */
  80         public final function limitObject (ObjectLimits $limitInstance) {
  81                 // Debug message
  82                 if ((defined('DEBUG_DATABASE')) || (defined('DEBUG_ALL'))) $this->getDebugInstance()->output(sprintf("[%s:] Limitierungsinstanz <strong>%s</strong> soll verwendet werden.<br />\n",
  83                         $this->__toString(),
  84                         $limitInstance->__toString()
  85                 ));
  86
  87                 // Get limitArray for validation
  88                 $array = $limitInstance->getLimitArray();
  89
  90                 // Sanity-check if some limitations are in the object
  91                 if ($array->count() > 0) {
  92                         // Okay, there is enougth
  93                         $this->limitInstance = $limitInstance;
  94
  95                         // Debug message
  96                         if ((defined('DEBUG_DATABASE')) || (defined('DEBUG_ALL'))) $this->getDebugInstance()->output(sprintf("[%s:] Limitierungsinstanz <strong>%s</strong> wird verwendet und beinhaltet <strong>%s</strong> Eintr&auml;ge.<br />\n",
  97                                 $this->__toString(),
  98                                 $limitInstance->__toString(),
  99                                 $array->count()
 100                         ));
 101                 }
 102         }
 103 }
 104
 105 // [EOF]
 106 ?>