171 lines
3.7 KiB
PHP
171 lines
3.7 KiB
PHP
<?php
|
|
// {{{ICINGA_LICENSE_HEADER}}}
|
|
/**
|
|
* This file is part of Icinga 2 Web.
|
|
*
|
|
* Icinga 2 Web - Head for multiple monitoring backends.
|
|
* Copyright (C) 2013 Icinga Development Team
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*
|
|
* @copyright 2013 Icinga Development Team <info@icinga.org>
|
|
* @license http://www.gnu.org/licenses/gpl-2.0.txt GPL, version 2
|
|
* @author Icinga Development Team <info@icinga.org>
|
|
*/
|
|
// {{{ICINGA_LICENSE_HEADER}}}
|
|
|
|
namespace Icinga\Web\Hook\Configuration;
|
|
|
|
use Icinga\Exception\ProgrammingError;
|
|
|
|
/**
|
|
* Class ConfigurationTab
|
|
*
|
|
* Hook to represent configuration tabs
|
|
*
|
|
* @package Icinga\Web\Hook\Configuration
|
|
*/
|
|
class ConfigurationTab implements ConfigurationTabInterface
|
|
{
|
|
/**
|
|
* Module name
|
|
* @var string
|
|
*/
|
|
private $moduleName;
|
|
|
|
/**
|
|
* Url segment to invoke controller
|
|
* @var string
|
|
*/
|
|
private $url;
|
|
|
|
/**
|
|
* Title of the tab
|
|
* @var string
|
|
*/
|
|
private $title;
|
|
|
|
/**
|
|
* Create a new instance
|
|
*
|
|
* @param string|null $name
|
|
* @param string|null $url
|
|
* @param string|null $title
|
|
*/
|
|
public function __construct($name = null, $url = null, $title = null)
|
|
{
|
|
if ($name !== null) {
|
|
$this->setModuleName($name);
|
|
|
|
if ($title === null) {
|
|
$this->setTitle($name);
|
|
}
|
|
}
|
|
|
|
if ($url !== null) {
|
|
$this->setUrl($url);
|
|
}
|
|
|
|
if ($title !== null) {
|
|
$this->setTitle($title);
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Setter for title
|
|
* @param string $title
|
|
*/
|
|
public function setTitle($title)
|
|
{
|
|
$this->title = $title;
|
|
}
|
|
|
|
/**
|
|
* Getter for title
|
|
* @return string
|
|
*/
|
|
public function getTitle()
|
|
{
|
|
return $this->title;
|
|
}
|
|
|
|
/**
|
|
* Setter for url
|
|
* @param string $url
|
|
*/
|
|
public function setUrl($url)
|
|
{
|
|
$this->url = $url;
|
|
}
|
|
|
|
/**
|
|
* Getter for url
|
|
* @return string
|
|
*/
|
|
public function getUrl()
|
|
{
|
|
return $this->url;
|
|
}
|
|
|
|
/**
|
|
* Setter for module name
|
|
* @param string $moduleName
|
|
*/
|
|
public function setModuleName($moduleName)
|
|
{
|
|
$this->moduleName = $moduleName;
|
|
}
|
|
|
|
private function assertConfiguration()
|
|
{
|
|
if (!$this->moduleName) {
|
|
throw new ProgrammingError('moduleName is missing');
|
|
}
|
|
|
|
if (!$this->getUrl()) {
|
|
throw new ProgrammingError('url is missing');
|
|
}
|
|
|
|
if (!$this->getTitle()) {
|
|
throw new ProgrammingError('title is missing');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns a tab configuration to build configuration links
|
|
* @return array
|
|
*/
|
|
public function getTab()
|
|
{
|
|
$this->assertConfiguration();
|
|
|
|
return array(
|
|
'title' => $this->getTitle(),
|
|
'url' => $this->getUrl()
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Return the tab key
|
|
* @return string
|
|
*/
|
|
public function getModuleName()
|
|
{
|
|
$this->assertConfiguration();
|
|
return $this->moduleName;
|
|
}
|
|
}
|