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
  51         // Create new database connection layer
  52         public final static function createDatabaseConnection (DebugMiddleware $debugInstance, DatabaseFrontendInterface $dbLayer) {
  53                 // Get instance
  54                 $dbInstance = new DatabaseConnection();
  55
  56                 // Set debug output handler
  57                 $dbInstance->setDebugInstance($debugInstance);
  58
  59                 // Set database layer
  60                 $dbInstance->setDatabaseLayer($dbLayer);
  61
  62                 // Set db instance
  63                 self::$thisInstance = $dbInstance;
  64
  65                 // Return instance
  66                 return $dbInstance;
  67         }
  68
  69         // Get an instance of this class
  70         public final static function getInstance () {
  71                 return self::$thisInstance;
  72         }
  73
  74         // Public setter for database connection
  75         public final function setConnectionData ($login, $pass, $dbase, $host="localhost") {
  76                 // Transfer connection data
  77                 $this->connectData['login'] = (string) $login;
  78                 $this->connectData['pass']  = (string) $pass;
  79                 $this->connectData['dbase'] = (string) $dbase;
  80                 $this->connectData['host']  = (string) $host;
  81         }
  82
  83         /**
  84          * Getter for connection data
  85          *
  86          * @return      $connectData    Connection data stored with this clas
  87          */
  88         public final function getConnectionData () {
  89                 return $this->connectData;
  90         }
  91
  92         /**
  93          * Setter for the real database layer
  94          * @param       $dbLayer        An instance of the real database layer
  95          * @return      void
  96          */
  97         public final function setDatabaseLayer (DatabaseFrontendInterface $dbLayer) {
  98                 $this->dbLayer = $dbLayer;
  99         }
 100
 101         /**
 102          * Analyses if a unique ID has already been used or not. This method does
 103          * only pass the given ID through to the "real" database layer.
 104          *
 105          * @param       $uniqueID               A unique ID number which shall be checked
 106          *                                                      before it will be used
 107          * @param       $inConstructor  If called from a constructor or from
 108          *                                                      somewhere else
 109          * @return      $isUnused               true    = The unique ID was not found in the database,
 110          *                                                      false = It is already in use by an other object
 111          */
 112         public function isUniqueIdUsed ($uniqueID, $inConstructor = false) {
 113                 // Connect to the database
 114                 $this->dbLayer->connectToDatabase();
 115
 116                 // Pass the returning result through
 117                 return $this->dbLayer->isUniqueIdUsed($uniqueID, $inConstructor);
 118         }
 119
 120         /**
 121          * Runs a "select" statement on the database layer with given table name
 122          * and criteria. If this doesn't fail the result will be returned
 123          *
 124          * @param       $tableName                      Name of the "table" we shall query
 125          * @param       $criteriaInstance       An instance of a Criteria class
 126          * @return      $result                         The result as an array
 127          */
 128         public function doSelectByTableCriteria ($tableName, Criteria $criteriaInstance) {
 129                 // Connect to the database
 130                 $this->dbLayer->connectToDatabase();
 131
 132                 // Get result from query
 133                 $result = $this->dbLayer->querySelect("array", $tableName, $criteriaInstance);
 134
 135                 // Return the result
 136                 return $result;
 137         }
 138
 139         /**
 140          * Getter for last exception
 141          *
 142          * @return      $exceptionInstance      Last thrown exception
 143          */
 144         public final function getLastException () {
 145                 $exceptionInstance = $this->dbLayer->getLastException();
 146                 return $exceptionInstance;
 147         }
 148
 149         /**
 150          * "Inserts" a data set instance into a local file database folder
 151          *
 152          * @param       $dataSetInstance        A storeable data set
 153          * @return      void
 154          */
 155         public function queryInsertDataSet (StoreableCriteria $dataSetInstance) {
 156                 // Connect to the database
 157                 $this->dbLayer->connectToDatabase();
 158
 159                 // Ask the database layer
 160                 $this->dbLayer->queryInsertDataSet($dataSetInstance);
 161         }
 162
 163         /**
 164          * "Updates" a data set instance with a database layer
 165          *
 166          * @param       $dataSetInstance        A storeable data set
 167          * @return      void
 168          */
 169         public function queryUpdateDataSet (StoreableCriteria $dataSetInstance) {
 170                 // Connect to the database
 171                 $this->dbLayer->connectToDatabase();
 172
 173                 // Ask the database layer
 174                 $this->dbLayer->queryUpdateDataSet($dataSetInstance);
 175         }
 176
 177         /**
 178          * Getter for primary key column of specified table name
 179          *
 180          * @param       $tableName              Name of table we need the primary key column from
 181          * @return      $primaryKey             Primary key column of requested table
 182          */
 183         public function getPrimaryKeyOfTable ($tableName) {
 184                 // Connect to the database
 185                 $this->dbLayer->connectToDatabase();
 186
 187                 // Ask the database layer
 188                 $primaryKey = $this->dbLayer->getPrimaryKeyOfTable($tableName);
 189
 190                 // Return the value
 191                 return $primaryKey;
 192         }
 193 }
 194
 195 // [EOF]
 196 ?>