icingaweb2/library/Icinga/Web/Widget/Tabextension/OutputFormat.php

102 lines
2.6 KiB
PHP

<?php
// {{{ICINGA_LICENSE_HEADER}}}
// {{{ICINGA_LICENSE_HEADER}}}
namespace Icinga\Web\Widget\Tabextension;
use Icinga\Web\Url;
use Icinga\Web\Widget\Tab;
use Icinga\Web\Widget\Tabs;
/**
* Tabextension that offers different output formats for the user in the dropdown area
*/
class OutputFormat implements Tabextension
{
/**
* PDF output type
*/
const TYPE_PDF = 'pdf';
/**
* JSON output type
*/
const TYPE_JSON = 'json';
/**
* CSV output type
*/
const TYPE_CSV = 'csv';
/**
* An array containing the tab definitions for all supported types
*
* Using array_keys on this array or isset allows to check whether a
* requested type is supported
*
* @var array
*/
private $supportedTypes = array(
self::TYPE_PDF => array(
'name' => 'pdf',
'title' => 'PDF',
'icon' => 'img/icons/pdf.png',
'urlParams' => array('format' => 'pdf'),
),
self::TYPE_CSV => array(
'name' => 'csv',
'title' => 'CSV',
'icon' => 'img/icons/csv.png',
'urlParams' => array('format' => 'csv')
),
self::TYPE_JSON => array(
'name' => 'json',
'title' => 'JSON',
'icon' => 'img/icons/json.png',
'urlParams' => array('format' => 'json')
)
);
/**
* An array of tabs to be added to the dropdown area
*
* @var array
*/
private $tabs = array();
/**
* Create a new OutputFormat extender
*
* In general, it's assumed that all types are supported when an outputFormat extension
* is added, so this class offers to remove specific types instead of adding ones
*
* @param array $disabled An array of output types to <b>not</b> show.
*/
public function __construct(array $disabled = array())
{
foreach ($this->supportedTypes as $type => $tabConfig) {
if (!in_array($type, $disabled)) {
$tabConfig['url'] = Url::fromRequest();
$tabConfig['tagParams'] = array(
'target' => '_blank'
);
$this->tabs[] = new Tab($tabConfig);
}
}
}
/**
* Applies the format selectio to the provided tabset
*
* @param Tabs $tabs The tabs object to extend with
*
* @see Tabextension::apply()
*/
public function apply(Tabs $tabs)
{
foreach ($this->tabs as $tab) {
$tabs->addAsDropdown($tab->getName(), $tab);
}
}
}