pages/help/HelpHandler.inc.php

   1 <?php
   2
   3 /**
   4  * @file HelpHandler.inc.php
   5  *
   6  * Copyright (c) 2003-2008 John Willinsky
   7  * Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
   8  *
   9  * @class HelpHandler
  10  * @ingroup pages_help
  11  *
  12  * @brief Handle requests for viewing help pages.
  13  */
  14
  15 // $Id: HelpHandler.inc.php,v 1.5 2009/05/12 20:12:44 asmecher Exp $
  16
  17
  18 define('HELP_DEFAULT_TOPIC', 'index/topic/000000');
  19 define('HELP_DEFAULT_TOC', 'index/toc/000000');
  20
  21 import('help.HelpToc');
  22 import('help.HelpTocDAO');
  23 import('help.HelpTopic');
  24 import('help.HelpTopicDAO');
  25 import('help.HelpTopicSection');
  26 import('handler.Handler');
  27 import('help.Help');
  28
  29 class HelpHandler extends Handler {
  30         function HelpHandler() {
  31                 parent::Handler();
  32         }
  33
  34         /**
  35          * Display help table of contents.
  36          */
  37         function index() {
  38                 $this->view(array('index', 'topic', '000000'));
  39         }
  40
  41         function toc() {
  42                 $this->validate();
  43                 $this->setupTemplate();
  44
  45                 $templateMgr =& TemplateManager::getManager();
  46                 $help =& Help::getHelp();
  47                 $templateMgr->assign_by_ref('helpToc', $help->getTableOfContents());
  48                 $templateMgr->display('help/helpToc.tpl');
  49         }
  50
  51         /**
  52          * Display the selected help topic.
  53          * @param $args array first parameter is the ID of the topic to display
  54          */
  55         function view($args) {
  56                 $this->validate();
  57                 $this->setupTemplate();
  58
  59                 $topicId = implode('/',$args);
  60                 $keyword = trim(String::regexp_replace('/[^\w\s\.\-]/', '', strip_tags(Request::getUserVar('keyword'))));
  61                 $result = (int) Request::getUserVar('result');
  62
  63                 $topicDao =& DAORegistry::getDAO('HelpTopicDAO');
  64                 $topic = $topicDao->getTopic($topicId);
  65
  66                 if ($topic === false) {
  67                         // Invalid topic, use default instead
  68                         $topicId = HELP_DEFAULT_TOPIC;
  69                         $topic = $topicDao->getTopic($topicId);
  70                 }
  71
  72                 $tocDao =& DAORegistry::getDAO('HelpTocDAO');
  73                 $toc = $tocDao->getToc($topic->getTocId());
  74
  75                 if ($toc === false) {
  76                         // Invalid toc, use default instead
  77                         $toc = $tocDao->getToc(HELP_DEFAULT_TOC);
  78                 }
  79
  80                 if ($topic->getSubTocId() != null) {
  81                         $subToc = $tocDao->getToc($topic->getSubTocId());
  82                 } else {
  83                         $subToc =  null;
  84                 }
  85
  86                 $relatedTopics = $topic->getRelatedTopics();
  87
  88                 $topics = $toc->getTopics();
  89
  90                 $templateMgr =& TemplateManager::getManager();
  91                 $templateMgr->assign('currentTopicId', $topic->getId());
  92                 $templateMgr->assign_by_ref('topic', $topic);
  93                 $templateMgr->assign('toc', $toc);
  94                 $templateMgr->assign('subToc', $subToc);
  95                 $templateMgr->assign('relatedTopics', $relatedTopics);
  96                 $templateMgr->assign('locale', Locale::getLocale());
  97                 $templateMgr->assign('breadcrumbs', $toc->getBreadcrumbs());
  98                 if (!empty($keyword)) {
  99                         $templateMgr->assign('helpSearchKeyword', $keyword);
 100                 }
 101                 if (!empty($result)) {
 102                         $templateMgr->assign('helpSearchResult', $result);
 103                 }
 104                 $templateMgr->display('help/view.tpl');
 105         }
 106
 107         /**
 108          * Display search results for a topic search by keyword.
 109          */
 110         function search() {
 111                 $this->validate();
 112                 $this->setupTemplate();
 113
 114                 $searchResults = array();
 115
 116                 $keyword = trim(String::regexp_replace('/[^\w\s\.\-]/', '', strip_tags(Request::getUserVar('keyword'))));
 117
 118                 if (!empty($keyword)) {
 119                         $topicDao =& DAORegistry::getDAO('HelpTopicDAO');
 120                         $topics = $topicDao->getTopicsByKeyword($keyword);
 121
 122                         $tocDao =& DAORegistry::getDAO('HelpTocDAO');
 123                         foreach ($topics as $topic) {
 124                                 $searchResults[] = array('topic' => $topic, 'toc' => $tocDao->getToc($topic->getTocId()));
 125                         }
 126                 }
 127
 128                 $templateMgr =& TemplateManager::getManager();
 129                 $templateMgr->assign('showSearch', true);
 130                 $templateMgr->assign('pageTitle', Locale::translate('help.searchResults'));
 131                 $templateMgr->assign('helpSearchKeyword', $keyword);
 132                 $templateMgr->assign('searchResults', $searchResults);
 133                 $templateMgr->display('help/searchResults.tpl');
 134         }
 135
 136         /**
 137          * Initialize the template
 138          */
 139         function setupTemplate() {
 140                 $templateMgr =& TemplateManager::getManager();
 141                 $templateMgr->setCacheability(CACHEABILITY_PUBLIC);
 142         }
 143 }
 144
 145 ?>