SettingsDAO.inc.php

<?php
 
abstract class SettingsDAO extends DAO {
   function loadSettings($id) {
      $settings = array();
 
      $result = $this->retrieve(
         'SELECT setting_name, setting_value, setting_type, locale FROM ' . $this->_getTableName() . ' WHERE ' . $this->_getPrimaryKeyColumn() . ' = ?',
         (int) $id
      );
 
      while (!$result->EOF) {
         $row = $result->getRowAssoc(false);
         $value = $this->convertFromDB($row['setting_value'], $row['setting_type']);
         if ($row['locale'] == '') $settings[$row['setting_name']] = $value;
         else $settings[$row['setting_name']][$row['locale']] = $value;
         $result->MoveNext();
      }
      $result->Close();
 
      $cache = $this->_getCache($id);
      if ($cache) $cache->setEntireCache($settings);
 
      return $settings;
   }
 
   function &getSettings($id) {
      $cache = $this->_getCache($id);
      if ($cache) return $cache->getContents();
      return $this->loadSettings($id);
   }
 
   function &getSetting($id, $name, $locale = null) {
      if ($cache = $this->_getCache($id)) {
         $returner = $cache->get($name);
      } else {
         $settings = $this->loadSettings($id);
         if (isset($settings[$name])) $returner = $settings[$name];
         else $returner = null;
      }
      if ($locale !== null) {
         if (!isset($returner[$locale]) || !is_array($returner)) {
            unset($returner);
            $returner = null;
            return $returner;
         }
         return $returner[$locale];
      }
      return $returner;
   }
 
   function _cacheMiss($cache, $id) {
      $settings = $this->loadSettings($cache->getCacheId());
      if (!isset($settings[$id])) {
         $cache->setCache($id, null);
         return null;
      }
      return $settings[$id];
   }
 
   function _performReplacement($rawInput, $paramArray = array()) {
      $value = preg_replace_callback('{{translate key="([^"]+)"}}', array($this, '_installer_regexp_callback'), $rawInput);
      foreach ($paramArray as $pKey => $pValue) {
         $value = str_replace('{$' . $pKey . '}', $pValue, $value);
      }
      return $value;
   }
 
   function _buildObject (&$node, $paramArray = array()) {
      $value = array();
      foreach ($node->getChildren() as $element) {
         $key = $element->getAttribute('key');
         $childArray = $element->getChildByName('array');
         if (isset($childArray)) {
            $content = $this->_buildObject($childArray, $paramArray);
         } else {
            $content = $this->_performReplacement($element->getValue(), $paramArray);
         }
         if (!empty($key)) {
            $key = $this->_performReplacement($key, $paramArray);
            $value[$key] = $content;
         } else $value[] = $content;
      }
      return $value;
   }
 
   function installSettings($id, $filename, $paramArray = array()) {
      $xmlParser = new XMLParser();
      $tree = $xmlParser->parse($filename);
      if (!$tree) return false;
 
      foreach ($tree->getChildren() as $setting) {
         $nameNode = $setting->getChildByName('name');
         $valueNode = $setting->getChildByName('value');
 
         if (isset($nameNode) && isset($valueNode)) {
            $type = $setting->getAttribute('type');
            $isLocaleField = $setting->getAttribute('locale');
            $name = $nameNode->getValue();
 
            if ($type == 'object') {
               $arrayNode = $valueNode->getChildByName('array');
               $value = $this->_buildObject($arrayNode, $paramArray);
            } else {
               $value = $this->_performReplacement($valueNode->getValue(), $paramArray);
            }
 
            // Replace translate calls with translated content
            $this->updateSetting(
               $id,
               $name,
               $isLocaleField?array(AppLocale::getLocale() => $value):$value,
               $type,
               $isLocaleField
            );
         }
      }
   }
 
   function _installer_regexp_callback($matches) {
      return __($matches[1]);
   }
 
   function updateSetting($id, $name, $value, $type = null, $isLocalized = false) {
      $keyFields = array('setting_name', 'locale', $this->_getPrimaryKeyColumn());
      if (!$isLocalized) {
         $value = $this->convertToDB($value, $type);
         $this->replace($this->_getTableName(),
            array(
               $this->_getPrimaryKeyColumn() => $id,
               'setting_name' => $name,
               'setting_value' => $value,
               'setting_type' => $type,
               'locale' => ''
            ),
            $keyFields
         );
      } else {
         if (is_array($value)) foreach ($value as $locale => $localeValue) {
            $this->update('DELETE FROM ' . $this->_getTableName() . ' WHERE ' . $this->_getPrimaryKeyColumn() . ' = ? AND setting_name = ? AND locale = ?', array($id, $name, $locale));
            if (empty($localeValue)) continue;
            $type = null;
            $this->update('INSERT INTO ' . $this->_getTableName() . '
               (' . $this->_getPrimaryKeyColumn() . ', setting_name, setting_value, setting_type, locale)
               VALUES (?, ?, ?, ?, ?)',
               array(
                  $id, $name, $this->convertToDB($localeValue, $type), $type, $locale
               )
            );
         }
      }
 
      $cache = $this->_getCache($id);
      if ($cache) $cache->setCache($name, $value);
   }
 
   function deleteSetting($id, $name, $locale = null) {
      $cache = $this->_getCache($id);
      if ($cache) $cache->setCache($name, null);
 
      $params = array($id, $name);
      $sql = 'DELETE FROM ' . $this->_getTableName() . ' WHERE ' . $this->_getPrimaryKeyColumn() . ' = ? AND setting_name = ?';
      if ($locale !== null) {
         $params[] = $locale;
         $sql .= ' AND locale = ?';
      }
 
      return $this->update($sql, $params);
   }
 
   function deleteById($id) {
      $cache = $this->_getCache($id);
      if ($cache) $cache->flush();
 
      return $this->update(
         'DELETE FROM ' . $this->_getTableName() . ' WHERE ' . $this->_getPrimaryKeyColumn() . ' = ?',
         (int) $id
      );
   }
 
   function _getCache($id) {
      $cacheName = $this->_getCacheName();
      if ($cacheName === null) return null;
 
      static $settingCache;
      if (!isset($settingCache)) {
         $settingCache = array();
      }
      if (!isset($settingCache[$id])) {
         $cacheManager = CacheManager::getManager();
         $settingCache[$id] = $cacheManager->getCache(
            $cacheName, $id,
            array($this, '_cacheMiss')
         );
      }
      return $settingCache[$id];
   }
 
   abstract protected function _getTableName();
 
   abstract protected function _getPrimaryKeyColumn();
 
   protected function _getCacheName() {
      return null;
   }
}