inc/classes/middleware/database/class_DatabaseConnection.php

   1 <?php
   2 /**
   3  * Database selector class
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright(c) 2007, 2008 Roland Haeder, this is free software
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.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 DatabaseConnection extends BaseMiddleware implements DatabaseConnector, Registerable {
  25         /**
  26          * Array for connection data
  27          */
  28         private $connectData = array(
  29                 'login' => "",
  30                 'pass'  => "",
  31                 'dbase' => "",
  32                 'host'  => ""
  33         );
  34
  35         // The real database layer
  36         private $dbLayer = null;
  37
  38         // An instance of this class
  39         private static $thisInstance = null;
  40
  41         /**
  42          * Protected constructor
  43          *
  44          * @return      void
  45          */
  46         protected function __construct() {
  47                 // Call parent constructor
  48                 parent::__construct(__CLASS__);
  49
  50                 // Set description
  51                 $this->setObjectDescription("Datenbank-Mittelschicht");
  52
  53                 // Create an unique ID
  54                 $this->generateUniqueId();
  55         }
  56
  57         // Create new database connection layer
  58         public final static function createDatabaseConnection (DebugMiddleware $debugInstance, DatabaseFrontendInterface $dbLayer) {
  59                 // Get instance
  60                 $dbInstance = new DatabaseConnection();
  61
  62                 // Set debug output handler
  63                 $dbInstance->setDebugInstance($debugInstance);
  64
  65                 // Set database layer
  66                 $dbInstance->setDatabaseLayer($dbLayer);
  67
  68                 // Set db instance
  69                 self::$thisInstance = $dbInstance;
  70
  71                 // Return instance
  72                 return $dbInstance;
  73         }
  74
  75         // Get an instance of this class
  76         public final static function getInstance () {
  77                 return self::$thisInstance;
  78         }
  79
  80         // Public setter for database connection
  81         public final function setConnectionData ($login, $pass, $dbase, $host="localhost") {
  82                 // Transfer connection data
  83                 $this->connectData['login'] = (string) $login;
  84                 $this->connectData['pass']  = (string) $pass;
  85                 $this->connectData['dbase'] = (string) $dbase;
  86                 $this->connectData['host']  = (string) $host;
  87         }
  88
  89         /**
  90          * Getter for connection data
  91          *
  92          * @return      $connectData    Connection data stored with this clas
  93          */
  94         public final function getConnectionData () {
  95                 return $this->connectData;
  96         }
  97
  98         /**
  99          * Setter for the real database layer
 100          * @param       $dbLayer        An instance of the real database layer
 101          * @return      void
 102          */
 103         public final function setDatabaseLayer (DatabaseFrontendInterface $dbLayer) {
 104                 $this->dbLayer = $dbLayer;
 105         }
 106
 107         /**
 108          * Analyses if a unique ID has already been used or not. This method does
 109          * only pass the given ID through to the "real" database layer.
 110          *
 111          * @param       $uniqueID               A unique ID number which shall be checked
 112          *                                                      before it will be used
 113          * @param       $inConstructor  If called from a constructor or from
 114          *                                                      somewhere else
 115          * @return      $isUnused               true    = The unique ID was not found in the database,
 116          *                                                      false = It is already in use by an other object
 117          */
 118         public function isUniqueIdUsed ($uniqueID, $inConstructor = false) {
 119                 // Connect to the database
 120                 $this->dbLayer->connectToDatabase();
 121
 122                 // Pass the returning result through
 123                 return $this->dbLayer->isUniqueIdUsed($uniqueID, $inConstructor);
 124         }
 125
 126         /**
 127          * Runs a "select" statement on the database layer with given table name
 128          * and criteria. If this doesn't fail the result will be returned
 129          *
 130          * @param       $tableName                      Name of the "table" we shall query
 131          * @param       $criteriaInstance       An instance of a Criteria class
 132          * @return      $result                         The result as an array
 133          */
 134         public function doSelectByTableCriteria ($tableName, Criteria $criteriaInstance) {
 135                 // Connect to the database
 136                 $this->dbLayer->connectToDatabase();
 137
 138                 // Get result from query
 139                 $result = $this->dbLayer->querySelect("array", $tableName, $criteriaInstance);
 140
 141                 // Return the result
 142                 return $result;
 143         }
 144
 145         /**
 146          * Getter for last exception
 147          *
 148          * @return      $exceptionInstance      Last thrown exception
 149          */
 150         public final function getLastException () {
 151                 $exceptionInstance = $this->dbLayer->getLastException();
 152                 return $exceptionInstance;
 153         }
 154
 155         /**
 156          * "Inserts" a data set instance into a local file database folder
 157          *
 158          * @param       $dataSetInstance        A storeable data set
 159          * @return      void
 160          */
 161         public function insertDataSet (StoreableCriteria $dataSetInstance) {
 162                 // Connect to the database
 163                 $this->dbLayer->connectToDatabase();
 164
 165                 // Ask the database layer
 166                 $this->dbLayer->insertDataSet($dataSetInstance);
 167         }
 168 }
 169
 170 // [EOF]
 171 ?>