BxBaseMenuManage Class Reference

Inheritance diagram for BxBaseMenuManage:

Public Member Functions
	__construct ($aObject, $oTemplate)
	isVisible ()
	setContentId ($iContentId)
	getObjectManage ()
	setObjectManage ($sMenuObject, $bAsButton=false)
	getCode ()
	getCodeAPI ()
Public Member Functions inherited from BxBaseMenu
	getDisplayAddons ()
	setDisplayAddons ($b)
	getShortCodeAPI ()
	getCodeItem ($sName)
	getMenuItems ()
	getMenuItem ($sName)
	getMenuIconHtml ($sIcon)
Public Member Functions inherited from BxDolMenu
	isHtmx ()
	getQueryObject ()
	getTemplateId ()
	getTemplateName ($sName='')
	setTemplateById ($iTemplateId)
	setSelected ($sModule, $sName)
	setDynamicMode ($bDynamicMode)
	setHtmx ($bHx)
	getMarkers ()
	addMarkers ($a)
	removeMarker ($s)
	initContentParams ()
	setContentParams ($aParams)
	getContentParams ()
	performActionSetCollapsed ($mixedValue)
	performActionSetCollapsedSubmenu ($sMenuItem, $mixedValue)
	getUserChoiceCollapsed ($sObject='')
	getUserChoiceCollapsedSubmenu ($mixedItem, $sObject='')

Protected Attributes
	$_sObjectManage
	$_oObjectManage
	$_bAsButton
	$_iContentId
Protected Attributes inherited from BxBaseMenu
	$_oTemplate
	$_iPageType
	$_aOptionalParams = array('target' => '', 'onclick' => '')
	$_bDisplayAddons = false
	$_aSelected
Protected Attributes inherited from BxDolMenu
	$_bIsApi
	$_bHx
	$_bHxHead
	$_mHxPreload
	$_aHx
	$_bDynamicMode
	$_bAddNoFollow
	$_bSelModuleCheck
	$_sSelModule
	$_sSelName
	$_sObject
	$_aObject
	$_oQuery
	$_oPermalinks
	$_aMarkers = array()
	$_bMultilevel = false
	$_sSessionKeyCollapsed
	$_aContentParams

Additional Inherited Members
Static Public Member Functions inherited from BxDolMenu
static	getObjectInstance ($sObject, $oTemplate=false)
static	setSelectedGlobal ($sModule, $sName)
static	processMenuTrigger ($sMenuTriggerName)
Static Public Member Functions inherited from iBxDolFactoryObject
static	getObjectInstance ($sObject)
Protected Member Functions inherited from BxTemplMenu
	_getTemplateVars ()
	_getMenuItem ($a)
	_getTemplateVars ()
Protected Member Functions inherited from BxBaseMenu
	_getCode ($sTmplName, $aTmplVars)
	getMenuItemsRaw ()
	_getMenuIcon ($a)
	_getMenuIconAttrs ($sType, $a)
	_getMenuTitle ($a)
	_getMenuAddon ($aMenuItem)
	_getMenuMarkers ($aMenuItem)
	_getMenuAttrs ($aMenuItem)
	_addJsCss ()
	_getTmplVarsAddon ($mixedAddon, $aMenuItem)
Protected Member Functions inherited from BxDolMenu
	__construct ($aObject)
	_setCollapsed ($sName, $mixedValue)
	_isSelected ($a)
	_isActive ($a)
	_isVisible ($a)
	_getVisibilityClass ($a)
	_replaceMarkers ($a)
Static Protected Attributes inherited from BxDolMenu
static	$SEL_MODULE = ''
static	$SEL_NAME = ''

Detailed Description

Menu representation.

See also

BxDolMenu

Constructor & Destructor Documentation

__construct()

BxBaseMenuManage::__construct	(		$aObject,
			$oTemplate )

Reimplemented from BxTemplMenu.

Member Function Documentation

getCode()

BxBaseMenuManage::getCode

(

)

Get menu code.

Returns

string

Hooks:

'menu', 'get_code_before' - hook before menu output

• $unit_name - equals menu
• $action - equals get_code_before
• $object_id - not used
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • object_name - menu object name
  • object_array - menu object array
  • object - menu object
  • override_result - menu code

    HOOKS

    'menu', 'get_code_before' - hook before menu output

Hooks:

'menu', 'get_code_after' - hook after menu output

• $unit_name - equals menu
• $action - equals get_code_after
• $object_id - not used
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • object_name - menu object name
  • object_array - menu object array
  • object - menu object
  • override_result - menu code

    HOOKS

    'menu', 'get_code_after' - hook after menu output

Reimplemented from BxBaseMenu.

getCodeAPI()

BxBaseMenuManage::getCodeAPI

(

)

Get menu code API.

Returns

array

Reimplemented from BxBaseMenu.

getObjectManage()

BxBaseMenuManage::getObjectManage

(

)

Get current menu in manage menu

Returns

menu object name

isVisible()

BxBaseMenuManage::isVisible

(

)

Check if the menu is visible. The menu is visible if at least one menu item is visible.

Returns

boolean

Reimplemented from BxDolMenu.

setObjectManage()

BxBaseMenuManage::setObjectManage	(		$sMenuObject,
			$bAsButton = false )

Set current menu object in manage menu

Parameters

$sMenuObject	menu object name
$bAsButton	boolean use autogenerated menu with single 'more' button or not

---

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

• template/scripts/BxBaseMenuManage.php