classes/help/HelpTocDAO.inc.php

<?php

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


import('help.HelpToc');

class HelpTocDAO extends XMLDAO {
   function &_getCache($tocId) {
      static $cache;
      $locale = Help::getLocale();

      if (!isset($cache[$locale][$tocId])) {
         import('cache.CacheManager');
         $help =& Help::getHelp();
         $cacheManager =& CacheManager::getManager();
         $cache[$locale][$tocId] = $cacheManager->getFileCache('help-toc-' . $help->getLocale(), $tocId, array($this, '_cacheMiss'));

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

   function _cacheMiss(&$cache, $id) {
      static $data;

      if (!isset($data)) {
         $helpFile = $this->getFilename($cache->getCacheId());
         $data = &$this->parseStruct($helpFile);

         // check if data exists before saving it to cache
         if ($data === false) {
            $returner = false;
            return $returner;
         }
         $cache->setEntireCache($data);
      }
      return null;
   }

   function &getMappingFile($tocId) {
      $help =& Help::getHelp();
      $mappingFiles =& $help->getMappingFiles();

      for ($i=0; $i < count($mappingFiles); $i++) {
         // "foreach by reference" hack
         $mappingFile =& $mappingFiles[$i];
         if ($mappingFile->containsToc($tocId)) return $mappingFile;
         unset($mappingFile);
      }
      $returner = null;
      return $returner;
   }

   function getFilename($tocId) {
      $mappingFile =& $this->getMappingFile($tocId);
      return $mappingFile?$mappingFile->getTocFilename($tocId):null;
   }

   function &getToc($tocId) {
      $cache =& $this->_getCache($tocId);
      $data = $cache->getContents();

      // check if data exists after loading
      if (!is_array($data)) {
         $returner = false;
         return $returner;
      }

      $toc = &new HelpToc();

      $toc->setId($data['toc'][0]['attributes']['id']);
      $toc->setTitle($data['toc'][0]['attributes']['title']);
      if (isset($data['toc'][0]['attributes']['parent_topic'])) {
         $toc->setParentTopicId($data['toc'][0]['attributes']['parent_topic']);
      }

      if (isset($data['topic'])) {
         foreach ($data['topic'] as $topicData) {
            $topic = &new HelpTopic();
            $topic->setId($topicData['attributes']['id']);
            $topic->setTitle($topicData['attributes']['title']);
            $toc->addTopic($topic);
         }
      }

      if (isset($data['breadcrumb'])) {
         foreach ($data['breadcrumb'] as $breadcrumbData) {
            $toc->addBreadcrumb($breadcrumbData['attributes']['title'], $breadcrumbData['attributes']['url']);
         }
      }

      return $toc;
   }
}

?>

---