doc/lib: Update controllers and views according to the recent changes

refs #6630

modules/doc/application/controllers/IcingawebController.php

@@ -46,17 +46,16 @@ class Doc_IcingawebController extends DocController
      */
     public function chapterAction()
     {
-        $chapterId = $this->getParam('chapterId');
+        $chapter = $this->getParam('chapter');
-        if ($chapterId === null) {
+        if ($chapter === null) {
             throw new Zend_Controller_Action_Exception(
-                sprintf($this->translate('Missing parameter \'%s\''), 'chapterId'),
+                sprintf($this->translate('Missing parameter %s'), 'chapter'),
                 404
             );
         }
         $this->renderChapter(
             $this->getPath(),
-            $chapterId,
+            $chapter,
-            'doc/icingaweb/toc',
             'doc/icingaweb/chapter'
         );
     }

modules/doc/application/controllers/ModuleController.php

@@ -122,10 +122,10 @@ class Doc_ModuleController extends DocController
     {
         $module = $this->getParam('moduleName');
         $this->assertModuleEnabled($module);
-        $chapterId = $this->getParam('chapterId');
+        $chapter = $this->getParam('chapter');
-        if ($chapterId === null) {
+        if ($chapter === null) {
             throw new Zend_Controller_Action_Exception(
-                sprintf($this->translate('Missing parameter \'%s\''), 'chapterId'),
+                sprintf($this->translate('Missing parameter %s'), 'chapter'),
                 404
             );
         }
@@ -133,8 +133,7 @@ class Doc_ModuleController extends DocController
         try {
             $this->renderChapter(
                 $this->getPath($module, Icinga::app()->getModuleManager()->getModuleDir($module, '/doc')),
-                $chapterId,
+                $chapter,
-                $this->_helper->url->url(array('moduleName' => $module), 'doc/module/toc'),
                 'doc/module/chapter',
                 array('moduleName' => $module)
             );

modules/doc/application/views/scripts/chapter.phtml

@@ -1,3 +1,3 @@
 <div class="chapter">
-    <?= $sectionRenderer->render($this, $this->getHelper('Url')); ?>
+    <?= /** @type \Icinga\Module\Doc\SectionRenderer $section */ $section ?>
 </div>

modules/doc/application/views/scripts/module/chapter.phtml

@@ -1,3 +1,3 @@
 <div class="chapter">
-    <?= $sectionRenderer->render($this, $this->getHelper('Url')); ?>
+    <?= /** @type \Icinga\Module\Doc\SectionRenderer $section */ $section ?>
 </div>

modules/doc/application/views/scripts/module/toc.phtml

@@ -1,6 +1,6 @@
 <div class="controls">
-    <h1><?= $title ?></h1>
+    <h1><?= /** @type string $title */ $title ?></h1>
 </div>
 <div class="content toc">
-    <?= $tocRenderer->render($this, $this->getHelper('Url')); ?>
+    <?= /** @type \Icinga\Module\Doc\TocRenderer $toc */ $toc ?>
 </div>

modules/doc/application/views/scripts/toc.phtml

@@ -1,6 +1,6 @@
 <div class="controls">
-    <h1><?= $title ?></h1>
+    <h1><?= /** @type string $title */ $title ?></h1>
 </div>
 <div class="content toc">
-    <?= $tocRenderer->render($this, $this->getHelper('Url')); ?>
+    <?= /** @type \Icinga\Module\Doc\TocRenderer $toc */ $toc ?>
 </div>

modules/doc/configuration.php

@@ -20,3 +20,5 @@ $section->add($this->translate('Developer - Style'), array(
     'url' => 'doc/style/guide',
     'priority' => 200,
 ));
+
+$this->provideSearchUrl($this->translate('Doc'), 'doc/search');

modules/doc/library/Doc/DocController.php

@@ -11,22 +11,18 @@ class DocController extends ModuleActionController
      * Render a chapter
      *
      * @param string    $path       Path to the documentation
-     * @param string    $chapterId      ID of the chapter
+     * @param string    $chapter    ID of the chapter
-     * @param string    $tocUrl
+     * @param string    $url        URL to replace links with
-     * @param string    $url
+     * @param array     $urlParams  Additional URL parameters
-     * @param array     $urlParams
      */
-    protected function renderChapter($path, $chapterId, $tocUrl, $url, array $urlParams = array())
+    protected function renderChapter($path, $chapter, $url, array $urlParams = array())
     {
         $parser = new DocParser($path);
-        $this->view->sectionRenderer = new SectionRenderer(
+        $section = new SectionRenderer($parser->getDocTree(), SectionRenderer::decodeUrlParam($chapter));
-            $parser->getDocTree(),
+        $this->view->section = $section
-            SectionRenderer::decodeUrlParam($chapterId),
+            ->setUrl($url)
-            $tocUrl,
+            ->setUrlParams($urlParams);
-            $url,
+        $this->view->title = $chapter;
-            $urlParams
-        );
-        $this->view->title = $chapterId;
         $this->render('chapter', null, true);
     }
 
@@ -35,13 +31,16 @@ class DocController extends ModuleActionController
      *
      * @param string    $path       Path to the documentation
      * @param string    $name       Name of the documentation
-     * @param string    $url
+     * @param string    $url        URL to replace links with
-     * @param array     $urlParams
+     * @param array     $urlParams  Additional URL parameters
      */
     protected function renderToc($path, $name, $url, array $urlParams = array())
     {
         $parser = new DocParser($path);
-        $this->view->tocRenderer = new TocRenderer($parser->getDocTree(), $url, $urlParams);
+        $toc = new TocRenderer($parser->getDocTree()->getIterator());
+        $this->view->toc = $toc
+            ->setUrl($url)
+            ->setUrlParams($urlParams);
         $name = ucfirst($name);
         $this->view->docName = $name;
         $this->view->title = sprintf($this->translate('%s Documentation'), $name);

modules/doc/run.php

@@ -9,7 +9,7 @@ if (Icinga::app()->isCli()) {
 }
 
 $docModuleChapter = new Zend_Controller_Router_Route(
-    'doc/module/:moduleName/chapter/:chapterId',
+    'doc/module/:moduleName/chapter/:chapter',
     array(
         'controller'    => 'module',
         'action'        => 'chapter',
@@ -18,7 +18,7 @@ $docModuleChapter = new Zend_Controller_Router_Route(
 );
 
 $docIcingaWebChapter = new Zend_Controller_Router_Route(
-    'doc/icingaweb/chapter/:chapterId',
+    'doc/icingaweb/chapter/:chapter',
     array(
         'controller'    => 'icingaweb',
         'action'        => 'chapter',