tyler.durden/icingaweb2
1
0
Fork 0
mirror of https://github.com/Icinga/icingaweb2.git synced 2025-07-23 05:44:36 +02:00
Code Issues Packages Projects Releases Wiki Activity

Doc: Add action to view the toc of a module's documentation

Browse Source 
refs #4820
This commit is contained in:
Eric Lippmann 2014-05-27 14:53:25 +02:00
parent dd6427019a
commit 0f5e076771
1 changed files with 26 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
modules/doc/application/controllers/ModuleController.php
View File

@ -2,8 +2,9 @@
// {{{ICINGA_LICENSE_HEADER}}} // {{{ICINGA_LICENSE_HEADER}}}
// {{{ICINGA_LICENSE_HEADER}}} // {{{ICINGA_LICENSE_HEADER}}}
use \Zend_Controller_Action_Exception;
use Icinga\Application\Icinga; use Icinga\Application\Icinga;
use Icinga\Module\Doc\Controller as DocController; use Icinga\Module\Doc\DocController;
class Doc_ModuleController extends DocController class Doc_ModuleController extends DocController
{ {
@ -16,21 +17,34 @@ class Doc_ModuleController extends DocController
} }
/** /**
* Provide run-time dispatching of module documentation * Assert that the given module is enabled
* *
* @param string $methodName * @param $moduleName
* @param array $args
* *
* @return mixed * @throws Zend_Controller_Action_Exception
*/ */
public function __call($methodName, $args) protected function assertModuleEnabled($moduleName)
{ {
$moduleManager = Icinga::app()->getModuleManager(); if ($moduleName === null) {
$moduleName = substr($methodName, 0, -6); // Strip 'Action' suffix throw new Zend_Controller_Action_Exception('Missing parameter "moduleName"', 404);
if (! $moduleManager->hasEnabled($moduleName)) {
// TODO(el): Distinguish between not enabled and not installed
return parent::__call($methodName, $args);
} }
$this->renderDocAndToc($moduleName); $moduleManager = Icinga::app()->getModuleManager();
if (! $moduleManager->hasInstalled($moduleName)) {
throw new Zend_Controller_Action_Exception('Module ' . $moduleName . ' is not installed', 404);
}
if (! $moduleManager->hasEnabled($moduleName)) {
throw new Zend_Controller_Action_Exception('Module ' . $moduleName. ' is not enabled', 404);
}
}
/**
* View toc of a module's documentation
*/
public function tocAction()
{
$moduleName = $this->getParam('moduleName');
$this->assertModuleEnabled($moduleName);
$moduleManager = Icinga::app()->getModuleManager();
$this->renderToc($moduleManager->getModuleDir($moduleName, '/doc'), $moduleName);
} }
} }