lib/pkp/pages/help/HelpHandler.inc.php

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