*
* @author Roland Haeder <webmaster@ship-simu.org>
* @version 0.0.0
- * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
+ * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
* @license GNU GPL 3.0 or any newer version
* @link http://www.ship-simu.org
*
/**
* Cache instance
*/
- private $cacheInstance = null;
+ private $cacheInstance = NULL;
/**
* Current table name to use
*/
- private $tableName = "unknown";
+ private $tableName = 'unknown';
/**
* Protected constructor
$this->cacheInstance = CacheFactory::getFactory()->createConfiguredCache();
}
+ /**
+ * 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;
+ }
+
+ /**
+ * 'Inserts' a data set instance into a local file database folder
+ *
+ * @param $dataSetInstance A storeable data set
+ * @param $onlyKeys Only use these keys for a cache key
+ * @return void
+ */
+ protected function queryInsertDataSet (StoreableCriteria $dataSetInstance, array $onlyKeys = array()) {
+ // First get a key suitable for our cache and extend it with this class name
+ $cacheKey = $this->getCacheKeyByCriteria($dataSetInstance, $onlyKeys);
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-WRAPPER: Using cache key ' . $cacheKey . ' for purging ...');
+
+ // Does this key exists in cache?
+ if ($this->cacheInstance->offsetExists($cacheKey)) {
+ // Purge the cache
+ $this->cacheInstance->purgeOffset($cacheKey);
+ } // END - if
+
+ // Handle it over to the middleware
+ $this->getDatabaseInstance()->queryInsertDataSet($dataSetInstance);
+ }
+
+ /**
+ * 'Updates' a data set instance with a database layer
+ *
+ * @param $dataSetInstance A storeable data set
+ * @param $onlyKeys Only use these keys for a cache key
+ * @return void
+ */
+ protected function queryUpdateDataSet (StoreableCriteria $dataSetInstance, array $onlyKeys = array()) {
+ // First get a key suitable for our cache and extend it with this class name
+ $cacheKey = $this->getCacheKeyByCriteria($dataSetInstance, $onlyKeys);
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-WRAPPER: Using cache key ' . $cacheKey . ' for purging ...');
+
+ // Does this key exists in cache?
+ if ($this->cacheInstance->offsetExists($cacheKey)) {
+ // Purge the cache
+ $this->cacheInstance->purgeOffset($cacheKey);
+ } // END - if
+
+ // Handle it over to the middleware
+ $this->getDatabaseInstance()->queryUpdateDataSet($dataSetInstance);
+ }
+
+ /**
+ * Getter for index key
+ *
+ * @return $indexKey Index key
+ */
+ public final function getIndexKey () {
+ return $this->getDatabaseInstance()->getIndexKey();
+ }
+
+ /**
+ * Getter for last exception
+ *
+ * @return $lastException Last exception or NULL if none occured
+ */
+ public final function getLastException () {
+ return $this->getDatabaseInstance()->getLastException();
+ }
+
/**
* 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
+ * @param $onlyKeys Only use these keys for a cache key
* @return $resultInstance An instance of a database result class
*/
- public function doSelectByCriteria (Criteria $criteriaInstance) {
+ public function doSelectByCriteria (Criteria $criteriaInstance, array $onlyKeys = array()) {
// First get a key suitable for our cache and extend it with this class name
- $cacheKey = sprintf("%s@%s",
- $this->__toString(),
- $criteriaInstance->getCacheKey()
- );
+ $cacheKey = $this->getCacheKeyByCriteria($criteriaInstance, $onlyKeys);
// Does this key exists in cache?
if ($this->cacheInstance->offsetExists($cacheKey)) {
+ // Debug message
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-WRAPPER: Cache used for cacheKey=' . $cacheKey);
+
// Then use this result
- $result = $cacheInstance->offsetGet($cacheKey);
+ $result = $this->cacheInstance->offsetGet($cacheKey);
} else {
+ // Debug message
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-WRAPPER: Quering database, cacheKey=' . $cacheKey);
+
// Now it's time to ask the database layer for this select statement
$result = $this->getDatabaseInstance()->doSelectByTableCriteria($this->getTableName(), $criteriaInstance);
} else {
// This invalid result must be wrapped
$result = array(
- 'status' => "invalid",
- 'exception' => $this->getDatabaseInstance()->getLastException()
+ BaseDatabaseBackend::RESULT_INDEX_STATUS => 'invalid',
+ BaseDatabaseBackend::RESULT_INDEX_EXCEPTION => $this->getDatabaseInstance()->getLastException()
);
}
}
// Create an instance of a DatabaseResult class with the given result
- $resultInstance = DatabaseResult::createDatabaseResult($result);
+ $resultInstance = ObjectFactory::createObjectByConfiguredName('database_result_class', array($result));
// And return the instance
return $resultInstance;
* Count the numbers of rows we shall receive
*
* @param $criteriaInstance An instance of a Criteria class
+ * @param $onlyKeys Only use these keys for a cache key
* @return $numRows Numbers of rows of database entries
*/
- public function doSelectCountByCriteria (Criteria $criteriaInstance) {
- // Total numbers is zero by default
+ public function doSelectCountByCriteria (Criteria $criteriaInstance, $onlyKeys = array()) {
+ // Total numbers is -1 so we can distinglish between failed and valid queries
$numRows = 0;
// Get the result from above method
- $resultInstance = $this->doSelectByCriteria($criteriaInstance);
+ $resultInstance = $this->doSelectByCriteria($criteriaInstance, $onlyKeys);
// Was that query fine?
if ($resultInstance->ifStatusIsOkay()) {
// Then get the number of rows
$numRows = $resultInstance->getAffectedRows();
+
+ // Debug message
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-WRAPPER: numRows=' . $numRows);
} // 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
*
projects / core.git / blobdiff