From ba93e84964486bb58ab83a901b4415268b16e4b6 Mon Sep 17 00:00:00 2001
From: Michael M Slusarz <slusarz@curecanti.org>
Date: Mon, 8 Nov 2010 16:35:53 -0700
Subject: [PATCH] Clean up Horde_Menu.

No need to define menuitem in constructor.
Add Horde_Menu::MASK_BASE - allows insertion of config-based menu items
if no other mask items are defined.
Break out HTML rendering into separate protected method so that it can
be replaced by an extended class.
---
 framework/Core/lib/Horde/Menu.php | 87 ++++++++++++++++++++++++++-------------
 1 file changed, 59 insertions(+), 28 deletions(-)

diff --git a/framework/Core/lib/Horde/Menu.php b/framework/Core/lib/Horde/Menu.php
index e2de2ed54..bd9a92cee 100644
--- a/framework/Core/lib/Horde/Menu.php
+++ b/framework/Core/lib/Horde/Menu.php
@@ -21,35 +21,34 @@ class Horde_Menu
     const MASK_LOGIN = 2;
     const MASK_PREFS = 4;
     const MASK_PROBLEM = 8;
-    const MASK_ALL = 15;
+    const MASK_BASE = 16;
+    const MASK_ALL = 31;
 
     /* TODO */
     const POS_LAST = 999;
 
     /**
-     * Menu array.
+     * Mask defining what menu items to show.
      *
-     * @var array
+     * @var integer
      */
-    protected $_menu = array();
+    protected $_mask;
 
     /**
-     * Mask defining what general Horde links are shown in this Menu.
+     * Menu array.
      *
-     * @var integer
+     * @var array
      */
-    protected $_mask;
+    protected $_menu = array();
 
     /**
      * Constructor
+     *
+     * @param integer $mask  Display mask.
      */
     public function __construct($mask = self::MASK_ALL)
     {
-        /* Menuitem mask. */
         $this->_mask = $mask;
-
-        /* Location of the menufile. */
-        $this->_menufile = $GLOBALS['registry']->get('fileroot') . '/config/menu.php';
     }
 
     /**
@@ -146,11 +145,9 @@ class Horde_Menu
     }
 
     /**
-     * Return the unordered list representing the list of menu items. Styling
-     * is done through CSS.
+     * Return the rendered representation of the menu items.
      *
-     * @return string  An unordered list of menu elements that can be entirely
-     *                 styled with CSS.
+     * @return string  The rendered representation.
      */
     public function render()
     {
@@ -223,8 +220,21 @@ class Horde_Menu
             $this->_menu = array_reverse($this->_menu);
         }
 
-        $menu_view = $prefs->getValue('menu_view');
+        return $this->_render();
+    }
+
+    /**
+     * Unordered list representing the list of menu items. Styling is done
+     * through CSS.
+     *
+     * @return string  An unordered list of menu elements that can be entirely
+     *                 styled with CSS.
+     */
+    protected function _render()
+    {
+        $menu_view = $GLOBALS['prefs']->getValue('menu_view');
         $output = '<ul>';
+
         foreach ($this->_menu as $m) {
             /* Check for separators. */
             if ($m == 'separator') {
@@ -270,32 +280,51 @@ class Horde_Menu
     }
 
     /**
-     * Any links to other Horde applications defined in an application's config
-     * file by the $conf['menu']['apps'] array are added to the menu array.
+     * Add links to other Horde applications defined in an application's
+     * config file.
      */
     public function addAppLinks()
     {
+        global $registry;
+
+        foreach ($this->getAppLinks() as $app) {
+            try {
+                $this->add(Horde::url($registry->getInitialPage($app)), $registry->get('name', $app), $registry->get('icon', $app), '');
+            } catch (Horde_Exception $e) {}
+        }
+    }
+
+    /**
+     * List any links to other Horde applications defined in an application's
+     * config file.
+     *
+     * @return array  A list of applications to create menu items for.
+     */
+    public function getAppLinks()
+    {
         global $conf, $registry;
 
+        $out = array();
+
         if (isset($conf['menu']['apps']) && is_array($conf['menu']['apps'])) {
             foreach ($conf['menu']['apps'] as $app) {
-                if ($registry->get('status', $app) != 'inactive' && $registry->hasPermission($app, Horde_Perms::SHOW)) {
-                    try {
-                        $this->add(Horde::url($registry->getInitialPage($app)), $registry->get('name', $app), $registry->get('icon', $app), '');
-                    } catch (Horde_Exception $e) {}
+                if (($registry->get('status', $app) != 'inactive') &&
+                    $registry->hasPermission($app, Horde_Perms::SHOW)) {
+                    $out[] = $app;
                 }
             }
         }
+
+        return $out;
     }
 
     /**
-     * Add any other links found in $this->_menufile to be included in the
-     * menu.
+     * Add links found in the application's menu configuration.
      */
     public function addSiteLinks()
     {
-        foreach ($this->getSiteLinks() as $menuitem) {
-            $this->addArray($menuitem);
+        foreach ($this->getSiteLinks() as $item) {
+            $this->addArray($item);
         }
     }
 
@@ -306,8 +335,10 @@ class Horde_Menu
      */
     public function getSiteLinks()
     {
-        if (is_readable($this->_menufile)) {
-            include $this->_menufile;
+        $menufile = $GLOBALS['registry']->get('fileroot') . '/config/menu.php';
+
+        if (is_readable($menufile)) {
+            include $menufile;
             if (isset($_menu) && is_array($_menu)) {
                 return $_menu;
             }
-- 
2.11.0