Class UserMenu

Description

Main menu for admin and normal users

  • todo: //TODO: combine the data storage with action.php for cleaner implementation

Located in /inc/menu.php (line 27)


	
			
Variable Summary
Method Summary
UserMenu UserMenu (BumblebeeAuth $auth, string $verb)
string getMenu ()
string _getHelpMenu ()
string _getMasqAlert ()
Variables
ActionListing $actionListing (line 32)

list of available actions

string $adminHeader (line 97)

text to include at start of admin menu section

string $headerStart = '<li class="menuSection">' (line 82)

html start-tag for each menu section

string $headerStop = '</li>' (line 87)

html stop-tag for each menu section

string $itemStart = '<li>' (line 67)

html start-tag for each menu entry

string $itemStop = '</li>' (line 72)

html stop-tag for each menu entry

string $mainMenuHeader (line 92)

text to include at start of main menu section

string $masqAlertTag = 'li' (line 102)

tag to use for the masq alert style (be careful of using div in an ul!)

string $masqDivId = 'masquerade' (line 77)

html id for div that alerts to current Masquerade setting

string $menuDivId = 'menulist' (line 47)

html id for the enclosing DIV

string $menuEpilogue = '' (line 42)

text output after end of menu block

string $menuHelp (line 57)

html menu entry (complete!) for the link to the online help

string $menuPrologue = '' (line 37)

text output before start of menu block

string $menuStart = '<ul>' (line 52)

html start-tag for the menu section

string $menuStop = '</ul>' (line 62)

html stop-tag for the menu section

boolean $showMenu = true (line 107)

display the menu

BumblebeeAuth $_auth (line 113)

logged in user's credentials

string $_verb (line 118)

currently selected action

Methods
Constructor UserMenu (line 125)

Constructor

UserMenu UserMenu (BumblebeeAuth $auth, string $verb)
  • BumblebeeAuth $auth: user's credentials
  • string $verb: current action
getMenu (line 137)

Generates an html representation of the menu

  • return: menu in html format
string getMenu ()
_constructMenuEntries (line 156)

Generates an html representation of the menu according to the current user's permissions

  • return: menu in html format
string _constructMenuEntries ()
_getHelpMenu (line 201)

Generates an html snippet to for the link to the online help

  • return: menu in html format
  • global: string $BUMBLEBEEVERSION: version of the Bumblebee installation (can serve different versions if necessary)
string _getHelpMenu ()
_getMasqAlert (line 188)

Generates an html div to alert the user that masquerading is in action

  • return: menu in html format
string _getMasqAlert ()

Documentation generated on Tue, 06 Mar 2007 10:01:46 +0000 by phpDocumentor 1.3.0