BxBaseMenu Class Reference

Inheritance diagram for BxBaseMenu:

Public Member Functions
	getCode ()
	getCodeAPI ()
	getMenuItems ()
	getMenuItem ($sName)
Public Member Functions inherited from BxDolMenu
	isVisible ()
	getTemplateName ($sName='')
	setSelected ($sModule, $sName)
	getMarkers ()
	addMarkers ($a)
	removeMarker ($s)

Protected Member Functions
	_getTemplateVars ()
	getMenuItemsRaw ()
	_addJsCss ()
Protected Member Functions inherited from BxDolMenu
	__construct ($aObject)
	_isSelected ($a)
	_isActive ($a)
	_isVisible ($a)
	_replaceMarkers ($a)

Additional Inherited Members
Static Public Member Functions inherited from BxDolMenu
static	getObjectInstance ($sObject, $oTemplate=false)
static	setSelectedGlobal ($sModule, $sName)
static	processMenuTrigger ($sMenuTriggerName)

Detailed Description

Menu representation.

See also

BxDolMenu

Member Function Documentation

_addJsCss()

BxBaseMenu::_addJsCss ( )

protected

Add css/js files which are needed for menu display and functionality.

_getTemplateVars()

BxBaseMenu::_getTemplateVars ( )

protected

Get template variables array

Returns

array

getCode()

BxBaseMenu::getCode

(

)

Get menu code.

Returns

string

getCodeAPI()

BxBaseMenu::getCodeAPI

(

)

Get menu code API.

Returns

array

getMenuItem()

BxBaseMenu::getMenuItem

(

$sName

)

Get menu item array, which is ready to pass to whole menu or single menu item template. May return false if single menu item is requested but cannot be shown by circumstances.

Returns

array or false

getMenuItems()

BxBaseMenu::getMenuItems

(

)

Get menu items array, which is ready to pass to menu template.

Returns

array or false

getMenuItemsRaw()

BxBaseMenu::getMenuItemsRaw ( )

protected

Get menu items array, this is just a wrapper for DB function for make it easier to override. It is used in

See also

BxBaseMenu::getMenuItems

Returns

array

---

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

• template/scripts/BxBaseMenu.php