doc/lib: Update controllers and views according to the recent changes
refs #6630
This commit is contained in:
Eric Lippmann
parent
41355fe0e2
commit
005ef8c92f
|
|
@ -46,17 +46,16 @@ class Doc_IcingawebController extends DocController
|
|||
*/
|
||||
public function chapterAction()
|
||||
{
|
||||
$chapterId = $this->getParam('chapterId');
|
||||
if ($chapterId === null) {
|
||||
$chapter = $this->getParam('chapter');
|
||||
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,
|
||||
'doc/icingaweb/toc',
|
||||
$chapter,
|
||||
'doc/icingaweb/chapter'
|
||||
);
|
||||
}
|
||||
|
|
|
|||
|
|
@ -122,10 +122,10 @@ class Doc_ModuleController extends DocController
|
|||
{
|
||||
$module = $this->getParam('moduleName');
|
||||
$this->assertModuleEnabled($module);
|
||||
$chapterId = $this->getParam('chapterId');
|
||||
if ($chapterId === null) {
|
||||
$chapter = $this->getParam('chapter');
|
||||
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,
|
||||
$this->_helper->url->url(array('moduleName' => $module), 'doc/module/toc'),
|
||||
$chapter,
|
||||
'doc/module/chapter',
|
||||
array('moduleName' => $module)
|
||||
);
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
<div class="chapter">
|
||||
<?= $sectionRenderer->render($this, $this->getHelper('Url')); ?>
|
||||
<?= /** @type \Icinga\Module\Doc\SectionRenderer $section */ $section ?>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
<div class="chapter">
|
||||
<?= $sectionRenderer->render($this, $this->getHelper('Url')); ?>
|
||||
<?= /** @type \Icinga\Module\Doc\SectionRenderer $section */ $section ?>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -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>
|
||||
|
|
|
|||
|
|
@ -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>
|
||||
|
|
|
|||
|
|
@ -20,3 +20,5 @@ $section->add($this->translate('Developer - Style'), array(
|
|||
'url' => 'doc/style/guide',
|
||||
'priority' => 200,
|
||||
));
|
||||
|
||||
$this->provideSearchUrl($this->translate('Doc'), 'doc/search');
|
||||
|
|
|
|||
|
|
@ -10,38 +10,37 @@ class DocController extends ModuleActionController
|
|||
/**
|
||||
* Render a chapter
|
||||
*
|
||||
* @param string $path Path to the documentation
|
||||
* @param string $chapterId ID of the chapter
|
||||
* @param string $tocUrl
|
||||
* @param string $url
|
||||
* @param array $urlParams
|
||||
* @param string $path Path to the documentation
|
||||
* @param string $chapter ID of the chapter
|
||||
* @param string $url URL to replace links with
|
||||
* @param array $urlParams Additional URL parameters
|
||||
*/
|
||||
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(
|
||||
$parser->getDocTree(),
|
||||
SectionRenderer::decodeUrlParam($chapterId),
|
||||
$tocUrl,
|
||||
$url,
|
||||
$urlParams
|
||||
);
|
||||
$this->view->title = $chapterId;
|
||||
$section = new SectionRenderer($parser->getDocTree(), SectionRenderer::decodeUrlParam($chapter));
|
||||
$this->view->section = $section
|
||||
->setUrl($url)
|
||||
->setUrlParams($urlParams);
|
||||
$this->view->title = $chapter;
|
||||
$this->render('chapter', null, true);
|
||||
}
|
||||
|
||||
/**
|
||||
* Render a toc
|
||||
*
|
||||
* @param string $path Path to the documentation
|
||||
* @param string $name Name of the documentation
|
||||
* @param string $url
|
||||
* @param array $urlParams
|
||||
* @param string $path Path to the documentation
|
||||
* @param string $name Name of the documentation
|
||||
* @param string $url URL to replace links with
|
||||
* @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);
|
||||
|
|
|
|||
|
|
@ -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',
|
||||
|
|
|
|||
Loading…
Reference in New Issue