class_BaseDatabaseWrapper.php

Go to the documentation of this file.

<?php
class BaseDatabaseWrapper extends BaseFrameworkSystem {
        private $cacheInstance = null;

        private $tableName = "unknown";

        protected function __construct($class) {
                // Call parent constructor
                parent::__construct($class);

                // Initialize the cache instance
                $this->initCacheInstance();

                // Clean up a little
                $this->removeNumberFormaters();
                $this->removeSystemArray();
        }

        private final function initCacheInstance () {
                // Set the new instance
                $this->cacheInstance = CacheFactory::getFactory()->createConfiguredCache();
        }

        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;
        }

        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;
        }

        protected final function setTableName ($tableName) {
                $this->tableName = (string) $tableName;
        }

        protected final function getTableName () {
                return $this->tableName;
        }

        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]
?>