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

Add test for Icinga\Web\MenuItem 

refs #6011
This commit is contained in:
Johannes Meyer 2014-04-24 16:14:27 +02:00
parent 290fe9eeb5
commit c5c375e72d
3 changed files with 112 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
library/Icinga/Web/Menu.php
View File

@ -29,9 +29,9 @@
namespace Icinga\Web;
use Icinga\Logger\Logger;
use Icinga\Application\Config;
use Icinga\Application\Icinga;
use Icinga\Logger\Logger;
use Icinga\Exception\NotReadableError;
class Menu extends MenuItem
@ -39,34 +39,49 @@ class Menu extends MenuItem
/**
* Create menu from the application's menu config file plus the config files from all enabled modules
*
* @return Menu
* @return self
*/
public static function fromConfig()
{
$menu = new static('menu');
$manager = Icinga::app()->getModuleManager();
$manager = Icinga::app()->getModuleManager();
try {
$menuConfigs = array(Config::app('menu'));
} catch (NotReadableError $e) {
Logger::error($e);
$menuConfigs = array();
}
try {
foreach ($manager->listEnabledModules() as $moduleName) {
$moduleMenuConfig = Config::module($moduleName, 'menu');
if ($moduleMenuConfig) {
$menuConfigs[] = $moduleMenuConfig;
}
}
try {
$modules = $manager->listEnabledModules();
} catch (NotReadableError $e) {
Logger::error($e);
$modules = array();
}
foreach ($modules as $moduleName) {
try {
$moduleMenuConfig = Config::module($moduleName, 'menu');
} catch (NotReadableError $e) {
Logger::error($e);
$moduleMenuConfig = array();
}
if (!empty($moduleMenuConfig)) {
$menuConfigs[] = $moduleMenuConfig;
}
}
return $menu->loadMenuItems($menu->flattenConfigs($menuConfigs));
}
/**
* Flatten configs into a key-value array
* Flatten configs
*
* @param array $configs An two dimensional array of menu configurations
*
* @return array The flattened config, as key-value array
*/
public function flattenConfigs(array $configs)
{
@ -79,18 +94,23 @@ class Menu extends MenuItem
$flattened[$section] = $itemConfig;
}
}
ksort($flattened);
return $flattened;
}
/**
* Load menu items from a key-value array
* Load menu items
*
* @param array $items The items to load, as key-value array
*
* @return self
*/
public function loadMenuItems(array $flattened)
public function loadMenuItems(array $items)
{
foreach ($flattened as $id => $itemConfig) {
foreach ($items as $id => $itemConfig) {
$this->addChild($id, $itemConfig);
}
return $this;
}
}

86
library/Icinga/Web/MenuItem.php
View File

@ -13,7 +13,7 @@ class MenuItem
*
* @type string
*/
private $id;
protected $id;
/**
* Item title
@ -22,7 +22,7 @@ class MenuItem
*
* @type string
*/
private $title;
protected $title;
/**
* Item priority
@ -31,44 +31,48 @@ class MenuItem
*
* @type int
*/
private $priority = 100;
protected $priority = 100;
/**
* Item url
*
* @type string
*/
private $url;
protected $url;
/**
* Item icon path
*
* @type string
*/
private $icon;
protected $icon;
/**
* Item icon class
*
* @type string
*/
private $iconClass;
protected $iconClass;
/**
* Item's children
*
* @type array
*/
private $children = array();
private $attribs = array();
protected $children = array();
/**
* HTML anchor tag attributes
*
* @var array
*/
protected $attribs = array();
/**
* Create a new MenuItem
*
* @param int $id
* @param object $config
* @param int $id
* @param object $config
*/
public function __construct($id, $config = null)
{
@ -81,7 +85,7 @@ class MenuItem
/**
* Setter for id
*
* @param string $id
* @param string $id
*
* @return self
*/
@ -104,7 +108,7 @@ class MenuItem
/**
* Setter for title
*
* @param string $title
* @param string $title
*
* @return self
*/
@ -114,11 +118,10 @@ class MenuItem
return $this;
}
/**
* Getter for title
*
* @return string
* @return string
*/
public function getTitle()
{
@ -128,7 +131,7 @@ class MenuItem
/**
* Setter for priority
*
* @param int $priority
* @param int $priority
*
* @return self
*/
@ -141,7 +144,7 @@ class MenuItem
/**
* Getter for priority
*
* @return int
* @return int
*/
public function getPriority()
{
@ -151,7 +154,7 @@ class MenuItem
/**
* Setter for URL
*
* @param string $url
* @param string $url
*
* @return self
*/
@ -164,7 +167,7 @@ class MenuItem
/**
* Getter for URL
*
* @return string
* @return string
*/
public function getUrl()
{
@ -174,7 +177,7 @@ class MenuItem
/**
* Setter for icon path
*
* @param string $path
* @param string $path
*
* @return self
*/
@ -187,7 +190,7 @@ class MenuItem
/**
* Getter for icon path
*
* @return string
* @return string
*/
public function getIcon()
{
@ -197,7 +200,7 @@ class MenuItem
/**
* Setter for icon class
*
* @param string $iconClass
* @param string $iconClass
*
* @return self
*/
@ -210,7 +213,7 @@ class MenuItem
/**
* Getter for icon class
*
* @return string
* @return string
*/
public function getIconClass()
{
@ -220,7 +223,7 @@ class MenuItem
/**
* Set the configuration for the item
*
* @param object $config
* @param Zend_Config $config
*/
public function setConfig($config)
{
@ -249,18 +252,21 @@ class MenuItem
} else {
// Submenu item
list($parentId, $id) = explode('.', $id, 2);
if ($this->hasChild($parentId)) {
$parent = $this->getChild($parentId);
} else {
$parent = $this->addChild($parentId);
}
$menuItem = $parent->addChild($id, $itemConfig);
}
return $menuItem;
}
/**
* Check whether the item has children
* Check whether the item has any children
*
* @return bool
*/
@ -270,10 +276,11 @@ class MenuItem
}
/**
* Get children sorted
* Get sorted children
*
* @return array
* @see cmpChildren()
*
* @see MenuItem::cmpChildren()
*/
public function getChildren()
{
@ -282,11 +289,11 @@ class MenuItem
}
/**
* Whether a given child id exists
* Return whether a given child id exists
*
* @param string $id
*
* @return self|$default
* @return bool
*/
public function hasChild($id)
{
@ -300,20 +307,22 @@ class MenuItem
* @param mixed $default
*
* @return MenuItem
*
* @throws ProgrammingError
*/
public function getChild($id)
{
if ($this->hasChild($id)) {
return $this->children[$id];
if (!$this->hasChild($id)) {
throw new ProgrammingError(sprintf('Trying to get invalid Menu child "%s"', $id));
}
throw new ProgrammingError(sprintf('Trying to get invalid Menu child "%s"', $id));
return $this->children[$id];
}
/**
* Set HTML a tag attributes
* Set HTML anchor tag attributes
*
* @param array $attribs
* @param array $attribs
*
* @return self
*/
@ -324,9 +333,9 @@ class MenuItem
}
/**
* Get HTML a tag attributes
* Get HTML anchor tag attributes
*
* @return array
* @return array
*/
public function getAttribs()
{
@ -336,8 +345,8 @@ class MenuItem
/**
* Compare children based on priority and title
*
* @param MenuItem $a
* @param MenuItem $b
* @param MenuItem $a
* @param MenuItem $b
*
* @return int
*/
@ -346,6 +355,7 @@ class MenuItem
if ($a->priority === $b->priority) {
return ($a->getTitle() > $b->getTitle()) ? 1 : -1;
}
return ($a->priority > $b->priority) ? 1 : -1;
}
}

29
test/php/library/Icinga/Web/MenuItemTest.php Normal file
View File

@ -0,0 +1,29 @@
<?php
// {{{ICINGA_LICENSE_HEADER}}}
// {{{ICINGA_LICENSE_HEADER}}}
namespace Tests\Icinga\Web;
use Zend_Config;
use Icinga\Web\MenuItem;
use Icinga\Test\BaseTestCase;
class MenuItemTest extends BaseTestCase
{
public function testWhetherMenuItemsAreNaturallySorted()
{
$item = new MenuItem('test');
$item->addChild(5, new Zend_Config(array('title' => 'ccc5')));
$item->addChild(0, new Zend_Config(array('title' => 'aaa')));
$item->addChild(3, new Zend_Config(array('title' => 'ccc')));
$item->addChild(2, new Zend_Config(array('title' => 'bbb')));
$item->addChild(4, new Zend_Config(array('title' => 'ccc2')));
$item->addChild(1, new Zend_Config(array('title' => 'bb')));
$this->assertEquals(
array('aaa', 'bb', 'bbb', 'ccc', 'ccc2', 'ccc5'),
array_map(function ($it) { return $it->getTitle(); }, $item->getChildren()),
'MenuItem::getChildren does not return its elements in natural order'
);
}
}