classes/help/HelpMappingFile.inc.php

<?php

// $Id: HelpMappingFile.inc.php,v 1.8 2008/07/01 01:16:09 asmecher Exp $


class HelpMappingFile {
   var $filename;
   var $cache;

   function HelpMappingFile($filename) {
      $this->filename = $filename;
   }

   function &_getCache() {
      if (!isset($this->cache)) {
         import('cache.CacheManager');
         $cacheManager =& CacheManager::getManager();
         $this->cache = $cacheManager->getFileCache(
            'helpmap', md5($this->filename),
            array(&$this, '_cacheMiss')
         );

         // Check to see if the cache info is outdated.
         $cacheTime = $this->cache->getCacheTime();
         if ($cacheTime !== null && file_exists($this->filename) && $cacheTime < filemtime($this->filename)) {
            // The cached data is out of date.
            $this->cache->flush();
         }
      }
      return $this->cache;
   }

   function _cacheMiss(&$cache, $id) {
      $mappings = array();

      // Add a debug note indicating an XML load.
      $notes =& Registry::get('system.debug.notes');
      $notes[] = array('debug.notes.helpMappingLoad', array('id' => $id, 'filename' => $this->filename));

      // Reload help XML file
      $xmlDao =& new XMLDAO();
      $data = $xmlDao->parseStruct($this->filename, array('topic'));
      // Build associative array of page keys and ids
      if (isset($data['topic'])) {
         foreach ($data['topic'] as $helpData) {
            $mappings[$helpData['attributes']['key']] = $helpData['attributes']['id'];
         }
      }

      $cache->setEntireCache($mappings);
      return isset($mappings[$id])?$mappings[$id]:null;
   }

   function map($key) {
      $cache =& $this->_getCache();
      return $cache->get($key);
   }

   function containsToc($tocId) {
      return file_exists($this->getTocFilename($tocId));
   }

   function containsTopic($topicId) {
      return file_exists($this->getTopicFilename($topicId));
   }

   function getTocFilename($tocId) {
      fatalError('HelpMappingFile::getTocFilename should be overridden');
   }

   function getTopicFilename($topicId) {
      fatalError('HelpMappingFile::getTopicFilename should be overridden');
   }

   function getSearchPath($locale = null) {
      fatalError('HelpMappingFile::getSearchPath should be overridden');
   }

   function getTopicIdForFilename($filename) {
      fatalError('HelpMappingFile::getSearchPath should be overridden');
   }
}

?>

---