doc/lib: Search in module documentations too

refs #6630
This commit is contained in:
Eric Lippmann 2015-02-11 13:22:27 +01:00
parent 4931418c03
commit fa37f84cac
1 changed files with 51 additions and 3 deletions

View File

@ -5,22 +5,70 @@ use \Zend_Controller_Action_Exception;
use Icinga\Application\Icinga;
use Icinga\Module\Doc\DocController;
use Icinga\Module\Doc\DocParser;
use Icinga\Module\Doc\Exception\DocException;
use Icinga\Module\Doc\Search\DocSearch;
use Icinga\Module\Doc\Search\DocSearchIterator;
use Icinga\Module\Doc\Search\DocSearchRenderer;
class Doc_SearchController extends DocController
{
/**
* Render search
*/
public function indexAction()
{
$parser = new DocParser($this->getPath());
$parser = new DocParser($this->getWebPath());
$search = new DocSearchRenderer(
new DocSearchIterator(
$parser->getDocTree()->getIterator(),
new DocSearch($this->params->get('q'))
)
);
$this->view->search = $search->setUrl('doc/icingaweb/chapter');
$search->setUrl('doc/icingaweb/chapter');
$searches = array(
'Icinga Web 2' => $search
);
foreach (Icinga::app()->getModuleManager()->listEnabledModules() as $module) {
if (($path = $this->getModulePath($module)) !== null) {
try {
$parser = new DocParser($path);
} catch (DocException $e) {
continue;
}
$search = new DocSearchRenderer(
new DocSearchIterator(
$parser->getDocTree()->getIterator(),
new DocSearch($this->params->get('q'))
)
);
$search
->setUrl('doc/module/chapter')
->setUrlParams(array('moduleName' => $module));
$searches[$module] = $search;
}
}
$this->view->searches = $searches;
}
/**
* Get the path to a module's documentation
*
* @param string $module
*
* @return string|null
*/
protected function getModulePath($module)
{
if (is_dir(($path = Icinga::app()->getModuleManager()->getModuleDir($module, '/doc')))) {
return $path;
}
if (($path = $this->Config()->get('documentation', 'modules')) !== null) {
$path = str_replace('{module}', $module, $path);
if (is_dir($path)) {
return $path;
}
}
return null;
}
/**
@ -30,7 +78,7 @@ class Doc_SearchController extends DocController
*
* @throws Zend_Controller_Action_Exception If Icinga Web 2's documentation is not available
*/
protected function getPath()
protected function getWebPath()
{
$path = Icinga::app()->getBaseDir('doc');
if (is_dir($path)) {