classes/db/DAO.inc.php

<?php

// $Id: DAO.inc.php,v 1.34 2008/07/07 18:07:30 asmecher Exp $


class DAO {
   var $_dataSource;

   function DAO($dataSource = null, $callHooks = true) {
      if ($callHooks === true && checkPhpVersion('4.3.0')) {
         $trace = debug_backtrace();
         // Call hooks based on the calling entity, assuming
         // this method is only called by a subclass. Results
         // in hook calls named e.g. "SessionDAO::_Constructor"
         if (HookRegistry::call($trace[1]['class'] . '::_Constructor', array(&$this, &$dataSource))) {
            return;
         }
      }

      if (!isset($dataSource)) {
         $this->_dataSource = &DBConnection::getConn();
      } else {
         $this->_dataSource = $dataSource;
      }
   }

   function &retrieve($sql, $params = false, $callHooks = true) {
      if ($callHooks === true && checkPhpVersion('4.3.0')) {
         $trace = debug_backtrace();
         // Call hooks based on the calling entity, assuming
         // this method is only called by a subclass. Results
         // in hook calls named e.g. "SessionDAO::_getSession"
         $value = null;
         if (HookRegistry::call($trace[1]['class'] . '::_' . $trace[1]['function'], array(&$sql, &$params, &$value))) {
            return $value;
         }
      }

      $result = &$this->_dataSource->execute($sql, $params !== false && !is_array($params) ? array($params) : $params);
      if ($this->_dataSource->errorNo()) {
         // FIXME Handle errors more elegantly.
         fatalError('DB Error: ' . $this->_dataSource->errorMsg());
      }
      return $result;
   }

   function &retrieveCached($sql, $params = false, $secsToCache = 3600, $callHooks = true) {
      if ($callHooks === true && checkPhpVersion('4.3.0')) {
         $trace = debug_backtrace();
         // Call hooks based on the calling entity, assuming
         // this method is only called by a subclass. Results
         // in hook calls named e.g. "SessionDAO::_getSession"
         $value = null;
         if (HookRegistry::call($trace[1]['class'] . '::_' . $trace[1]['function'], array(&$sql, &$params, &$secsToCache, &$value))) {
            return $value;
         }
      }

      $this->setCacheDir();

      $result = &$this->_dataSource->CacheExecute($secsToCache, $sql, $params !== false && !is_array($params) ? array($params) : $params);
      if ($this->_dataSource->errorNo()) {
         // FIXME Handle errors more elegantly.
         fatalError('DB Error: ' . $this->_dataSource->errorMsg());
      }
      return $result;
   }

   function &retrieveLimit($sql, $params = false, $numRows = false, $offset = false, $callHooks = true) {
      if ($callHooks === true && checkPhpVersion('4.3.0')) {
         $trace = debug_backtrace();
         // Call hooks based on the calling entity, assuming
         // this method is only called by a subclass. Results
         // in hook calls named e.g. "SessionDAO::_getSession"
         $value = null;
         if (HookRegistry::call($trace[1]['class'] . '::_' . $trace[1]['function'], array(&$sql, &$params, &$numRows, &$offset, &$value))) {
            return $value;
         }
      }

      $result = &$this->_dataSource->selectLimit($sql, $numRows === false ? -1 : $numRows, $offset === false ? -1 : $offset, $params !== false && !is_array($params) ? array($params) : $params);
      if ($this->_dataSource->errorNo()) {
         fatalError('DB Error: ' . $this->_dataSource->errorMsg());
      }
      return $result;
   }

   function &retrieveRange($sql, $params = false, $dbResultRange = null, $callHooks = true) {
      if ($callHooks === true && checkPhpVersion('4.3.0')) {
         $trace = debug_backtrace();
         // Call hooks based on the calling entity, assuming
         // this method is only called by a subclass. Results
         // in hook calls named e.g. "SessionDAO::_getSession"
         $value = null;
         if (HookRegistry::call($trace[1]['class'] . '::_' . $trace[1]['function'], array(&$sql, &$params, &$dbResultRange, &$value))) {
            return $value;
         }
      }

      if (isset($dbResultRange) && $dbResultRange->isValid()) {
         $result = &$this->_dataSource->PageExecute($sql, $dbResultRange->getCount(), $dbResultRange->getPage(), $params);
         if ($this->_dataSource->errorNo()) {
            fatalError('DB Error: ' . $this->_dataSource->errorMsg());
         }
      }
      else {
         $result = &$this->retrieve($sql, $params, false);
      }
      return $result;
   }

   function update($sql, $params = false, $callHooks = true, $dieOnError = true) {
      if ($callHooks === true && checkPhpVersion('4.3.0')) {
         $trace = debug_backtrace();
         // Call hooks based on the calling entity, assuming
         // this method is only called by a subclass. Results
         // in hook calls named e.g. "SessionDAO::_updateSession"
         $value = null;
         if (HookRegistry::call($trace[1]['class'] . '::_' . $trace[1]['function'], array(&$sql, &$params, &$value))) {
            return $value;
         }
      }

      $this->_dataSource->execute($sql, $params !== false && !is_array($params) ? array($params) : $params);
      if ($dieOnError && $this->_dataSource->errorNo()) {
         fatalError('DB Error: ' . $this->_dataSource->errorMsg());
      }
      return $this->_dataSource->errorNo() == 0 ? true : false;
   }

   function replace($table, $arrFields, $keyCols) {
      $arrFields = array_map(array($this->_dataSource, 'qstr'), $arrFields);
      $this->_dataSource->Replace($table, $arrFields, $keyCols, false);
   }

   function getInsertId($table = '', $id = '', $callHooks = true) {
      return $this->_dataSource->po_insert_id($table, $id);
   }

   function setCacheDir() {
      static $cacheDir;
      if (!isset($cacheDir)) {
         global $ADODB_CACHE_DIR;

         import('cache.CacheManager');
         $cacheDir = CacheManager::getFileCachePath() . '/_db';

         $ADODB_CACHE_DIR = $cacheDir;
      }
   }

   function flushCache() {
      $this->setCacheDir();
      $this->_dataSource->CacheFlush();
   }

   function datetimeToDB($dt) {
      return $this->_dataSource->DBTimeStamp($dt);
   }

   function dateToDB($d) {
      return $this->_dataSource->DBDate($d);
   }

   function datetimeFromDB($dt) {
      if ($dt === null) return null;
      return $this->_dataSource->UserTimeStamp($dt, 'Y-m-d H:i:s');
   }
   function dateFromDB($d) {
      if ($d === null) return null;
      return $this->_dataSource->UserDate($d, 'Y-m-d');
   }

   function convertFromDB($value, $type) {
      switch ($type) {
         case 'bool':
            $value = (bool) $value;
            break;
         case 'int':
            $value = (int) $value;
            break;
         case 'float':
            $value = (float) $value;
            break;
         case 'object':
            $value = unserialize($value);
            break;
         case 'date':
            if ($value !== null) $value = strtotime($value);
            break;
         case 'string':
         default:
            // Nothing required.
            break;
      }
      return $value;
   }

   function getType($value) {
      switch (gettype($value)) {
         case 'boolean':
         case 'bool':
            return 'bool';
         case 'integer':
         case 'int':
            return 'int';
         case 'double':
         case 'float':
            return 'float';
         case 'array':
         case 'object':
            return 'object';
         case 'string':
         default:
            return 'string';
      }
   }

   function convertToDB($value, &$type) {
      if ($type == null) {
         $type = $this->getType($value);
      }

      switch ($type) {
         case 'object':
            $value = serialize($value);
            break;
         case 'bool':
            $value = $value ? 1 : 0;
            break;
         case 'date':
            if ($value !== null) {
               if (!is_numeric($value)) $value = strtotime($value);
               $value = strftime('%Y-%m-%d %H:%M:%S', $value);
            }
            break;
         default:
      }

      return $value;
   }

   function getLocaleFieldNames() {
      return array();
   }

   function updateDataObjectSettings($tableName, &$dataObject, $idArray) {
      $idFields = array_keys($idArray);
      $idFields[] = 'locale';
      $idFields[] = 'setting_name';

      foreach ($this->getLocaleFieldNames() as $field) {
         $values = $dataObject->getData($field);
         if (!is_array($values)) continue;

         foreach ($values as $locale => $value) {
            $idArray['setting_type'] = null;
            $idArray['locale'] = $locale;
            $idArray['setting_name'] = $field;
            $idArray['setting_value'] = $this->convertToDB($value, $idArray['setting_type']);

            $this->replace($tableName, $idArray, $idFields);
         }
      }
   }

   function getDataObjectSettings($tableName, $idFieldName, $idFieldValue, &$dataObject) {
      if ($idFieldName !== null) {
         $sql = "SELECT * FROM $tableName WHERE $idFieldName = ?";
         $params = array($idFieldValue);
      } else {
         $sql = "SELECT * FROM $tableName";
         $params = false;
      }
      $result =& $this->retrieve($sql, $params);

      while (!$result->EOF) {
         $row = &$result->getRowAssoc(false);
         $dataObject->setData($row['setting_name'], $this->convertFromDB($row['setting_value'], $row['setting_type']), $row['locale']);
         unset($row);
         $result->MoveNext();
      }

      $result->Close();
      unset($result);
   }
}

?>

---