BxBaseMenu Class Reference

Inheritance diagram for BxBaseMenu:

Public Member Functions
	__construct ($aObject, $oTemplate)
	getDisplayAddons ()
	setDisplayAddons ($b)
	getCode ()
	getCodeAPI ()
	getShortCodeAPI ()
	getCodeItem ($sName)
	getMenuItems ()
	getMenuItem ($sName)
	getMenuIconHtml ($sIcon)
Public Member Functions inherited from BxDolMenu
	isHtmx ()
	isVisible ()
	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 Member Functions
	_getCode ($sTmplName, $aTmplVars)
	_getTemplateVars ()
	getMenuItemsRaw ()
	_getMenuItem ($a)
	_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)

Protected Attributes
	$_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)
Static Protected Attributes inherited from BxDolMenu
static	$SEL_MODULE = ''
static	$SEL_NAME = ''

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.

Reimplemented in BxBaseMenuInteractive, and BxFilesMenuViewActionsInline.

_getTemplateVars()

BxBaseMenu::_getTemplateVars ( )

protected

Get template variables array

Returns

array

Reimplemented in BxBaseMenuMoreAuto, BxFilesMenuViewActionsInline, BxTemplMenu, BxTemplMenu, and BxTimelineMenuFeeds.

getCode()

BxBaseMenu::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 in BxAdsMenuView, BxAdsMenuViewActions, BxBaseMenuAddRelation, BxBaseMenuFooter, BxBaseMenuHomepage, BxBaseMenuInteractive, BxBaseMenuManage, BxBaseMenuMoreAuto, BxBaseMenuProfileAdd, BxBaseMenuSite, BxBaseMenuSocialSharing, BxBaseMenuSubmenu, BxBaseMenuWiki, BxBaseModGeneralMenuSnippetMeta, BxBaseModProfileMenuViewMeta, BxMarketMenuView, BxMarketMenuViewActions, BxNtfsMenuPreview, BxPaymentMenuSbsActions, BxShopifyMenuView, BxTemplMenuSite, BxTemplMenuSite, and BxTemplMenuSite.

getCodeAPI()

BxBaseMenu::getCodeAPI

(

)

Get menu code API.

Returns

array

Reimplemented in BxBaseMenuManage, and BxBaseMenuSubmenu.

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

Reimplemented in BxBaseCmtsMenuActions, BxBaseMenuAddRelation, BxBaseMenuFooter, BxBaseMenuInteractive, BxBaseMenuProfileStats, BxBaseMenuSetAclLevel, BxBaseMenuSetBadges, BxBaseMenuSwitchLanguage, BxBaseMenuSwitchTemplate, BxBaseMenuTagsCloud, BxBaseMenuToolbar, BxFilesMenuViewActionsInline, BxForumMenuCategories, BxNtfsMenuPreview, and BxTimelineMenuItemShare.

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

Reimplemented in BxBaseMenuAccountNotifications, BxBaseMenuCreatePost, BxBaseMenuDashboardContentManage, BxBaseMenuDashboardReportsManage, BxBaseMenuProfileFollowings, BxBaseMenuProfileStats, BxBaseMenuTagsCloud, BxBaseVoteReactionsMenuDo, BxCoursesMenuContentAdd, BxForumMenuCategories, BxNtfsMenuPreview, and BxTimelineMenuFeeds.

getShortCodeAPI()

BxBaseMenu::getShortCodeAPI

(

)

Get menu short code API.

Returns

array

---

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

• template/scripts/BxBaseMenu.php