BxBaseMenuSubmenu Class Reference

Inheritance diagram for BxBaseMenuSubmenu:

Public Member Functions
	__construct ($aObject, $oTemplate)
	isVisible ()
	setContentId ($iContentId)
	getDisplayAddons ()
	setDisplayAddons ($b)
	getObjectSubmenu ()
	setObjectSubmenu ($sMenuObject, $sForceMainMenuSelection=false)
	setObjectActionsMenu ($sActionsMenuObject)
	getObjectActionsMenu ()
	setServiceSocialSharing ($a)
	getServiceSocialSharing ()
	getClass ()
	getCode ()
	getCodeAPI ()
	getPageCoverParams ()
	getSelectedMenuItem ()
Public Member Functions inherited from BxBaseMenu
	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
	$_aSocialSharingService = false
	$_sObjectActionsMenu = false
	$_sObjectSubmenu = false
	$_oObjectSubmenu = null
	$_mixedMainMenuItemSelected = false
	$_sJsObject
	$_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()

BxBaseMenuSubmenu::__construct	(		$aObject,
			$oTemplate )

Reimplemented from BxTemplMenu.

Member Function Documentation

getClass()

BxBaseMenuSubmenu::getClass

(

)

Get class

Returns

class

getCode()

BxBaseMenuSubmenu::getCode

(

)

Get menu code.

Returns

string

Reimplemented from BxBaseMenu.

getCodeAPI()

BxBaseMenuSubmenu::getCodeAPI

(

)

Get menu code API.

Returns

array

Reimplemented from BxBaseMenu.

getDisplayAddons()

BxBaseMenuSubmenu::getDisplayAddons

(

)

Reimplemented from BxBaseMenu.

getObjectActionsMenu()

BxBaseMenuSubmenu::getObjectActionsMenu

(

)

Get current actions menu in submenu

Returns

menu object name

getObjectSubmenu()

BxBaseMenuSubmenu::getObjectSubmenu

(

)

Get current menu in submenu

Returns

menu object name

getServiceSocialSharing()

BxBaseMenuSubmenu::getServiceSocialSharing

(

)

Get social sharing menu in submenu

Returns

menu service call array (module, method, etc)

isVisible()

BxBaseMenuSubmenu::isVisible

(

)

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

Returns

boolean

Reimplemented from BxDolMenu.

setDisplayAddons()

BxBaseMenuSubmenu::setDisplayAddons

(

$b

)

Reimplemented from BxBaseMenu.

setObjectActionsMenu()

BxBaseMenuSubmenu::setObjectActionsMenu

(

$sActionsMenuObject

)

Set current actions menu in submenu

Parameters

$sActionsMenuObject

menu object name

setObjectSubmenu()

BxBaseMenuSubmenu::setObjectSubmenu	(		$sMenuObject,
			$sForceMainMenuSelection = false )

Set current menu object in submenu

Parameters

$sMenuObject	menu object name
$sForceMainMenuSelection	force main menu item selection by menu item name

setServiceSocialSharing()

BxBaseMenuSubmenu::setServiceSocialSharing

(

$a

)

Set social sharing menu in submenu

Parameters

$a	menu service call array (module, method, etc)

---

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

• template/scripts/BxBaseMenuSubmenu.php