icingaweb2/library/Icinga/Web/Widget/SearchDashboard.php

112 lines
2.9 KiB
PHP

<?php
/* Icinga Web 2 | (c) 2014 Icinga Development Team | GPLv2+ */
namespace Icinga\Web\Widget;
use Zend_Controller_Action_Exception;
use Icinga\Application\Icinga;
use Icinga\Web\Url;
/**
* Class SearchDashboard display multiple search views on a single search page
*/
class SearchDashboard extends Dashboard
{
/**
* Name for the search pane
*
* @var string
*/
const SEARCH_PANE = 'search';
/**
* {@inheritdoc}
*/
public function getTabs()
{
if ($this->tabs === null) {
$this->tabs = new Tabs();
$this->tabs->add(
'search',
array(
'title' => t('Show Search', 'dashboard.pane.tooltip'),
'label' => t('Search'),
'url' => Url::fromRequest()
)
);
}
return $this->tabs;
}
/**
* Load all available search dashlets from modules
*
* @param string $searchString
*
* @return $this
*/
public function search($searchString = '')
{
$pane = $this->createPane(self::SEARCH_PANE)->getPane(self::SEARCH_PANE)->setTitle(t('Search'));
$this->activate(self::SEARCH_PANE);
$manager = Icinga::app()->getModuleManager();
$searchUrls = array();
foreach ($manager->getLoadedModules() as $module) {
if ($this->getUser()->can($manager::MODULE_PERMISSION_NS . $module->getName())) {
$moduleSearchUrls = $module->getSearchUrls();
if (! empty($moduleSearchUrls)) {
if ($searchString === '') {
$pane->add(t('Ready to search'), 'search/hint');
return $this;
}
$searchUrls = array_merge($searchUrls, $moduleSearchUrls);
}
}
}
usort($searchUrls, array($this, 'compareSearchUrls'));
foreach (array_reverse($searchUrls) as $searchUrl) {
$pane->createDashlet(
$searchUrl->title . ': ' . $searchString,
Url::fromPath($searchUrl->url, array('q' => $searchString))
)->setProgressLabel(t('Searching'));
}
return $this;
}
/**
* Renders the output
*
* @return string
*
* @throws Zend_Controller_Action_Exception
*/
public function render()
{
if (! $this->getPane(self::SEARCH_PANE)->hasDashlets()) {
throw new Zend_Controller_Action_Exception(t('Page not found'), 404);
}
return parent::render();
}
/**
* Compare search URLs based on their priority
*
* @param object $a
* @param object $b
*
* @return int
*/
private function compareSearchUrls($a, $b)
{
if ($a->priority === $b->priority) {
return 0;
}
return ($a->priority < $b->priority) ? -1 : 1;
}
}