3 * Database selector class
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.org
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.
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.
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/>.
24 class DatabaseConnection extends BaseMiddleware implements DatabaseConnector, Registerable {
26 * Array for connection data
28 private $connectData = array(
35 // The real database layer
36 private $dbLayer = null;
38 // An instance of this class
39 private static $thisInstance = null;
42 * Protected constructor
46 protected function __construct () {
47 // Call parent constructor
48 parent::__construct(__CLASS__);
51 // Create new database connection layer
52 public final static function createDatabaseConnection (DebugMiddleware $debugInstance, DatabaseFrontendInterface $dbLayer) {
54 $dbInstance = new DatabaseConnection();
56 // Set debug output handler
57 $dbInstance->setDebugInstance($debugInstance);
60 $dbInstance->setDatabaseLayer($dbLayer);
63 self::$thisInstance = $dbInstance;
69 // Get an instance of this class
70 public final static function getInstance () {
71 return self::$thisInstance;
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;
84 * Getter for connection data
86 * @return $connectData Connection data stored with this clas
88 public final function getConnectionData () {
89 return $this->connectData;
93 * Setter for the real database layer
94 * @param $dbLayer An instance of the real database layer
97 public final function setDatabaseLayer (DatabaseFrontendInterface $dbLayer) {
98 $this->dbLayer = $dbLayer;
102 * Getter for index key
104 * @return $indexKey Index key
106 public final function getIndexKey () {
107 return $this->dbLayer->getIndexKey();
111 * Runs a 'select' statement on the database layer with given table name
112 * and criteria. If this doesn't fail the result will be returned
114 * @param $tableName Name of the 'table' we shall query
115 * @param $criteriaInstance An instance of a Criteria class
116 * @return $result The result as an array
118 public function doSelectByTableCriteria ($tableName, Criteria $criteriaInstance) {
119 // Connect to the database
120 $this->dbLayer->connectToDatabase();
122 // Get result from query
123 $result = $this->dbLayer->querySelect('array', $tableName, $criteriaInstance);
130 * Getter for last exception
132 * @return $exceptionInstance Last thrown exception
134 public final function getLastException () {
135 $exceptionInstance = $this->dbLayer->getLastException();
136 return $exceptionInstance;
140 * 'Inserts' a data set instance into a local file database folder
142 * @param $dataSetInstance A storeable data set
145 public function queryInsertDataSet (StoreableCriteria $dataSetInstance) {
146 // Connect to the database
147 $this->dbLayer->connectToDatabase();
149 // Ask the database layer
150 $this->dbLayer->queryInsertDataSet($dataSetInstance);
154 * 'Updates' a data set instance with a database layer
156 * @param $dataSetInstance A storeable data set
159 public function queryUpdateDataSet (StoreableCriteria $dataSetInstance) {
160 // Connect to the database
161 $this->dbLayer->connectToDatabase();
163 // Ask the database layer
164 $this->dbLayer->queryUpdateDataSet($dataSetInstance);
168 * Getter for primary key column of specified table name
170 * @param $tableName Name of table we need the primary key column from
171 * @return $primaryKey Primary key column of requested table
173 public function getPrimaryKeyOfTable ($tableName) {
174 // Connect to the database
175 $this->dbLayer->connectToDatabase();
177 // Ask the database layer
178 $primaryKey = $this->dbLayer->getPrimaryKeyOfTable($tableName);