+++ /dev/null
-<?php
-/**
- * A generic database wrapper
- *
- * @author Roland Haeder <webmaster@ship-simu.org>
- * @version 0.0.0
- * @copyright Copyright (c) 2007, 2008 Roland Haeder, this is free software
- * @license GNU GPL 3.0 or any newer version
- * @link http://www.ship-simu.org
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
- */
-class BaseDatabaseWrapper extends BaseFrameworkSystem {
- /**
- * Cache instance
- */
- private $cacheInstance = null;
-
- /**
- * Current table name to use
- */
- private $tableName = "unknown";
-
- /**
- * Protected constructor
- *
- * @return void
- */
- protected function __construct($class) {
- // Call parent constructor
- parent::__construct($class);
-
- // Initialize the cache instance
- $this->initCacheInstance();
-
- // Clean up a little
- $this->removeNumberFormaters();
- $this->removeSystemArray();
- }
-
- /**
- * Initializes the cache instance with a new object
- *
- * @return void
- */
- private final function initCacheInstance () {
- // Set the new instance
- $this->cacheInstance = CacheFactory::getFactory()->createConfiguredCache();
- }
-
- /**
- * Do a "select" query on the current table with the given search criteria and
- * store it in cache for later usage
- *
- * @param $criteriaInstance An instance of a Criteria class
- * @return $resultInstance An instance of a database result class
- */
- public function doSelectByCriteria (Criteria $criteriaInstance) {
- // First get a key suitable for our cache and extend it with this class name
- $cacheKey = sprintf("%s@%s",
- $this->__toString(),
- $criteriaInstance->getCacheKey()
- );
-
- // Does this key exists in cache?
- if ($this->cacheInstance->offsetExists($cacheKey)) {
- // Then use this result
- $result = $cacheInstance->offsetGet($cacheKey);
- } else {
- // Now it's time to ask the database layer for this select statement
- $result = $this->getDatabaseInstance()->doSelectByTableCriteria($this->getTableName(), $criteriaInstance);
-
- // Cache the result if not null
- if (!is_null($result)) {
- // A valid result has returned from the database layer
- $this->cacheInstance->offsetSet($cacheKey, $result);
- } else {
- // This invalid result must be wrapped
- $result = array(
- 'status' => "invalid",
- 'exception' => $this->getDatabaseInstance()->getLastException()
- );
- }
- }
-
- // Create an instance of a DatabaseResult class with the given result
- $resultInstance = DatabaseResult::createDatabaseResult($result);
-
- // And return the instance
- return $resultInstance;
- }
-
- /**
- * Count the numbers of rows we shall receive
- *
- * @param $criteriaInstance An instance of a Criteria class
- * @return $numRows Numbers of rows of database entries
- */
- public function doSelectCountByCriteria (Criteria $criteriaInstance) {
- // Total numbers is zero by default
- $numRows = 0;
-
- // Get the result from above method
- $resultInstance = $this->doSelectByCriteria($criteriaInstance);
-
- // Was that query fine?
- if ($resultInstance->ifStatusIsOkay()) {
- // Then get the number of rows
- $numRows = $resultInstance->getAffectedRows();
- } // END - if
-
- // Return the result
- return $numRows;
- }
-
- /**
- * Setter for table name
- *
- * @param $tableName Name of table name to set
- * @return void
- */
- protected final function setTableName ($tableName) {
- $this->tableName = (string) $tableName;
- }
-
- /**
- * Getter for table name
- *
- * @return $tableName Name of table name to set
- */
- protected final function getTableName () {
- return $this->tableName;
- }
-
- /**
- * Getter for primary key used in wrapped table
- *
- * @return $primaryKey Primary key used in wrapped table
- */
- public final function getPrimaryKeyValue () {
- // Get the table name and a database instance and ask for it
- $primaryKey = $this->getDatabaseInstance()->getPrimaryKeyOfTable($this->getTableName());
-
- // Return value
- return $primaryKey;
- }
-}
-
-// [EOF]
-?>
projects / shipsimu.git / blobdiff