SideMenu Class Reference

SideMenu class this class display side menu item side menu is mmc's left menu, it regroups possible actions we can do in a spécific module like index/configuration/add machine/ add share in samba module this class require SideMenuItem. More...

Public Member Functions
	addSideMenuItem ($objSideMenuItem)
	add a sideMenu Item into the SideMenu
	display ()
	print the SideMenu and the sideMenuItem
	forceActiveItem ($item)
	Force a menu item to be displayed as activated Useful for pages that don't have a dedicated tab.
	getBackgroundImage ()
	Get the sidemenu background image.
	getClass ()
	getSideBarCss ()
	setBackgroundImage ($bg)
	Set the sidemenu background image.
	setClass ($class)
	CSS class.
	SideMenu ()
	SideMenu default constructor initalize empty itemArray for SideMenuItem.
Data Fields
	$activatedItem
	$backgroundImage
	$className
	$itemArray

---

Detailed Description

SideMenu class this class display side menu item side menu is mmc's left menu, it regroups possible actions we can do in a spécific module like index/configuration/add machine/ add share in samba module this class require SideMenuItem.

Definition at line 1312 of file PageGenerator.php.

---

Member Function Documentation

SideMenu::addSideMenuItem

(

$

objSideMenuItem

)

add a sideMenu Item into the SideMenu

Parameters:

$objSideMenuItem

object SideMenuItem

Definition at line 1332 of file PageGenerator.php.

                                               {
        $this->itemArray[]=&$objSideMenuItem;
    }

SideMenu::display

(

)

print the SideMenu and the sideMenuItem

Definition at line 1367 of file PageGenerator.php.

                       {
        echo "<div id=\"sidebar\">\n";
        echo "<ul class=\"".$this->className."\">\n";
        foreach ($this->itemArray as $objSideMenuItem) {
            $objSideMenuItem->display();
        }
        echo "</ul>\n";
        echo "</div>\n";
    }

SideMenu::forceActiveItem

(

$

item

)

Force a menu item to be displayed as activated Useful for pages that don't have a dedicated tab.

Definition at line 1397 of file PageGenerator.php.

                                    {
        $this->activatedItem = $item;
    }

SideMenu::getBackgroundImage

(

)

Get the sidemenu background image.

Definition at line 1360 of file PageGenerator.php.

                                  {
        return $this->backgroundImage;
    }

SideMenu::getClass

(

)

Returns:

className for CSS

Definition at line 1346 of file PageGenerator.php.

                        {
        return $this->className;
    }

SideMenu::getSideBarCss

(

)

Returns:

return the Css content for a sidebar static method to get SideBarCss String

Definition at line 1381 of file PageGenerator.php.

                             {
        $css = "";
        foreach ($this->itemArray as $objSideMenuItem) {
            $active = (($objSideMenuItem->submod == $_GET["submod"]) && (($objSideMenuItem->action == $_GET["action"]) || ($objSideMenuItem->action == $this->activatedItem)));
            $css = $css . $objSideMenuItem->getCss($active);
        }
        if ($this->backgroundImage) {
            $css .= "#sectionContainer { background-image: url(" . $this->backgroundImage . ") }";
        }
        return $css;
    }

SideMenu::setBackgroundImage

(

$

bg

)

Set the sidemenu background image.

Definition at line 1353 of file PageGenerator.php.

                                     {
        $this->backgroundImage = $bg;
    }

SideMenu::setClass

(

$

class

)

CSS class.

Definition at line 1339 of file PageGenerator.php.

                              {
        $this->className=$class;
    }

SideMenu::SideMenu

(

)

SideMenu default constructor initalize empty itemArray for SideMenuItem.

Definition at line 1322 of file PageGenerator.php.

                        {
        $this->itemArray = array();
        $this->backgroundImage = null;
        $this->activatedItem = null;
    }

---

Field Documentation

SideMenu::$activatedItem

Definition at line 1316 of file PageGenerator.php.

SideMenu::$backgroundImage

Definition at line 1315 of file PageGenerator.php.

SideMenu::$className

Definition at line 1314 of file PageGenerator.php.

SideMenu::$itemArray

Definition at line 1313 of file PageGenerator.php.

---

The documentation for this class was generated from the following file:

• mmc/includes/PageGenerator.php