tyler.durden
/
icingaweb2
mirror of https://github.com/Icinga/icingaweb2.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Hook/ConfigurationTab: Remove deprecated implementation 

ConfigurationTab hook is not used anywhere. Test is
removed also.
This commit is contained in:
Marius Hein 2014-08-27 10:19:27 +02:00
parent 89541f5727
commit 5abf41edef
5 changed files with 0 additions and 430 deletions

145
library/Icinga/Web/Hook/Configuration/ConfigurationTab.php
View File

@ -1,145 +0,0 @@
<?php
// {{{ICINGA_LICENSE_HEADER}}}
// {{{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;
}
}

107
library/Icinga/Web/Hook/Configuration/ConfigurationTabBuilder.php
View File

@ -1,107 +0,0 @@
<?php
// {{{ICINGA_LICENSE_HEADER}}}
// {{{ICINGA_LICENSE_HEADER}}}
namespace Icinga\Web\Hook\Configuration;
use Icinga\Exception\ProgrammingError;
use Icinga\Web\Hook;
use Icinga\Web\Widget\Tabs;
/**
* Class ConfigurationTabBuilder
*
* Glue config tabs together
*
* @package Icinga\Web\Hook\Configuration
*/
class ConfigurationTabBuilder
{
/**
* Namespace for configuration tabs
*/
const HOOK_NAMESPACE = 'Configuration/Tabs';
/**
* Tabs widget
* @var Tabs
*/
private $tabs;
/**
* Create a new instance
* @param Tabs $tabs
*/
public function __construct(Tabs $tabs)
{
$this->setTabs($tabs);
$this->initializeSystemConfigurationTabs();
}
/**
* Setter for tabs
* @param \Icinga\Web\Widget\Tabs $tabs
*/
public function setTabs($tabs)
{
$this->tabs = $tabs;
}
/**
* Getter for tabs
* @return \Icinga\Web\Widget\Tabs
*/
public function getTabs()
{
return $this->tabs;
}
/**
* Build the tabs
*
*/
public function build()
{
/** @var ConfigurationTab $configTab */
$configTab = null;
foreach (Hook::all(self::HOOK_NAMESPACE) as $configTab) {
if (!$configTab instanceof ConfigurationTabInterface) {
throw new ProgrammingError('tab not instance of ConfigTabInterface');
}
$this->getTabs()->add($configTab->getModuleName(), $configTab->getTab());
}
}
/**
* Initialize system configuration tabs
*/
public function initializeSystemConfigurationTabs()
{
$configurationTab = new ConfigurationTab(
'configuration',
'configuration/index',
'Configuration'
);
// Display something about us
Hook::registerObject(
ConfigurationTabBuilder::HOOK_NAMESPACE,
$configurationTab->getModuleName(),
$configurationTab
);
$modulesOverviewTab = new ConfigurationTab(
'modules',
'modules/overview',
'Modules'
);
Hook::registerObject(
ConfigurationTabBuilder::HOOK_NAMESPACE,
$modulesOverviewTab->getModuleName(),
$modulesOverviewTab
);
}
}

27
library/Icinga/Web/Hook/Configuration/ConfigurationTabInterface.php
View File

@ -1,27 +0,0 @@
<?php
// {{{ICINGA_LICENSE_HEADER}}}
// {{{ICINGA_LICENSE_HEADER}}}
namespace Icinga\Web\Hook\Configuration;
/**
* Interface ConfigurationTabInterface
*
* Used to register configuration tab settings
*
* @package Icinga\Web\Hook\Configuration
*/
interface ConfigurationTabInterface
{
/**
* Returns a tab configuration to build configuration links
* @return array
*/
public function getTab();
/**
* Return the tab key
* @return string
*/
public function getModuleName();
}

72
test/php/library/Icinga/Web/Hook/Configuration/ConfigurationTabBuilderTest.php
View File

@ -1,72 +0,0 @@
<?php
// {{{ICINGA_LICENSE_HEADER}}}
// {{{ICINGA_LICENSE_HEADER}}}
namespace Tests\Icinga\Web\Hook\Configuration;
use \Mockery;
use Icinga\Test\BaseTestCase;
use Icinga\Web\Hook\Configuration\ConfigurationTab;
use Icinga\Web\Hook\Configuration\ConfigurationTabBuilder;
use Icinga\Web\Hook;
use Icinga\Web\Widget\Tabs;
class ConfigurationTabBuilderTest extends BaseTestCase
{
public function setUp()
{
parent::setUp();
Hook::clean();
}
public function tearDown()
{
parent::tearDown();
Hook::clean();
}
public function testDefaultTabs()
{
$widget = new Tabs();
$builder = new ConfigurationTabBuilder($widget);
$array = $builder->build();
$tabs = $builder->getTabs();
$this->assertInstanceOf('Icinga\\Web\\Widget\\Tab', $tabs->get('configuration'));
}
public function testTabCreation1()
{
$widget = new Tabs();
$builder = new ConfigurationTabBuilder($widget);
$tab1 = new ConfigurationTab('test1', '/test1', 'TEST1');
$tab2 = new ConfigurationTab('test2', '/test2', 'TEST2');
$tab3 = new ConfigurationTab('test3', '/test3', 'TEST3');
Hook::registerObject(ConfigurationTabBuilder::HOOK_NAMESPACE, 'test1', $tab1);
Hook::registerObject(ConfigurationTabBuilder::HOOK_NAMESPACE, 'test2', $tab2);
Hook::registerObject(ConfigurationTabBuilder::HOOK_NAMESPACE, 'test3', $tab3);
$builder->build();
$this->assertCount(5, $builder->getTabs());
}
/**
* @expectedException Icinga\Exception\ProgrammingError
* @expectedExceptionMessage tab not instance of ConfigTabInterface
*/
public function testTabCreation2()
{
$widget = new Tabs();
$builder = new ConfigurationTabBuilder($widget);
$tab = Mockery::mock('Tab');
Hook::registerObject(ConfigurationTabBuilder::HOOK_NAMESPACE, 'misc', $tab);
$builder->build();
$this->assertCount(5, $builder->getTabs());
}
}

79
test/php/library/Icinga/Web/Hook/Configuration/ConfigurationTabTest.php
View File

@ -1,79 +0,0 @@
<?php
// {{{ICINGA_LICENSE_HEADER}}}
// {{{ICINGA_LICENSE_HEADER}}}
namespace Tests\Icinga\Web\Hook\Configuration;
use Icinga\Test\BaseTestCase;
use Icinga\Web\Hook\Configuration\ConfigurationTab;
class ConfigurationTabTest extends BaseTestCase
{
public function testCreate1()
{
$tab = new ConfigurationTab(
'test1',
'/test/$555',
'TEST_TITLE'
);
$this->assertEquals('test1', $tab->getModuleName());
$testArray = array(
'title' => 'TEST_TITLE',
'url' => '/test/$555'
);
$this->assertEquals($testArray, $tab->getTab());
}
public function testCreate2()
{
$tab = new ConfigurationTab(
'test2',
'/test/$666'
);
$this->assertEquals('test2', $tab->getModuleName());
$testArray = array(
'title' => 'test2',
'url' => '/test/$666'
);
$this->assertEquals($testArray, $tab->getTab());
}
/**
* @expectedException Icinga\Exception\ProgrammingError
* @expectedExceptionMessage moduleName is missing
*/
public function testException1()
{
$tab = new ConfigurationTab();
$tab->getTab();
}
/**
* @expectedException Icinga\Exception\ProgrammingError
* @expectedExceptionMessage url is missing
*/
public function testException2()
{
$tab = new ConfigurationTab();
$tab->setModuleName('DING1');
$tab->getTab();
}
/**
* @expectedException Icinga\Exception\ProgrammingError
* @expectedExceptionMessage title is missing
*/
public function testException3()
{
$tab = new ConfigurationTab();
$tab->setModuleName('DING1');
$tab->setUrl('/ding/dong');
$tab->getTab();
}
}