BxTemplMenuSite Class Reference

Inheritance diagram for BxTemplMenuSite:

Public Member Functions
	__construct ($aObject, $oTemplate=false)
	getCode ()
	__construct ($aObject, $oTemplate=false)
	getCode ()
	__construct ($aObject, $oTemplate=false)
	getCode ()
	__construct ($aObject, $oTemplate=false)
Public Member Functions inherited from BxBaseMenuMoreAuto
	isMoreAuto ()
Public Member Functions inherited from BxBaseMenu
	getDisplayAddons ()
	setDisplayAddons ($b)
	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
	_getMenuItem ($a)
	_getMenuItem ($a)
	_getMenuItem ($a)
Protected Member Functions inherited from BxBaseMenuMoreAuto
	_isMoreAuto ()
	_getTemplateVars ()
	_getJsCodeMoreAuto ()
	_getHtmlIds ()
	_getHtmlIdMain ()
	_getJsClassMoreAuto ()
	_getJsObjectMoreAuto ()
	_getTmplContentItemMore ()
	_getTmplContentItemMorePopup ()
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)

Protected Attributes
	$_sModule
	$_oModule
	$_bSiteMenu
	$_bSiteMenuInPanel
	$_bApplicationMenu
	$_aHideFromSiteMenu
	$_aHideFromSiteMenuInPanel
	$_bSiteMenuSubmenu
Protected Attributes inherited from BxBaseMenuMoreAuto
	$_sTmplNameItemMore
	$_sTmplNameItemMorePopup
	$_bMoreAuto
	$_iMoreAutoItemsStatic
	$_bMoreAutoItemsStaticOnly
	$_sJsClassMoreAuto
	$_sJsObjectMoreAuto
	$_sJsCallMoreAuto
	$_aHtmlIds
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
Protected Attributes inherited from BxBaseMenuSite
	$_bSiteMenuInPanel
	$_bApplicationMenu
	$_aHideFromSiteMenuInPanel

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

Detailed Description

See also

BxTemplMenuMoreAuto

BxDolMenu

Constructor & Destructor Documentation

__construct() [1/4]

BxTemplMenuSite::__construct	(		$aObject,
			$oTemplate = false )

Reimplemented from BxTemplMenuMoreAuto.

__construct() [2/4]

BxTemplMenuSite::__construct	(		$aObject,
			$oTemplate = false )

Reimplemented from BxTemplMenuMoreAuto.

__construct() [3/4]

BxTemplMenuSite::__construct	(		$aObject,
			$oTemplate = false )

Reimplemented from BxTemplMenuMoreAuto.

__construct() [4/4]

BxTemplMenuSite::__construct	(		$aObject,
			$oTemplate = false )

Reimplemented from BxTemplMenuMoreAuto.

Member Function Documentation

_getMenuItem() [1/3]

BxTemplMenuSite::_getMenuItem ( $a )

protected

Reimplemented from BxBaseMenuMoreAuto.

_getMenuItem() [2/3]

BxTemplMenuSite::_getMenuItem ( $a )

protected

Reimplemented from BxBaseMenuMoreAuto.

_getMenuItem() [3/3]

BxTemplMenuSite::_getMenuItem ( $a )

protected

Reimplemented from BxBaseMenuMoreAuto.

getCode() [1/3]

BxTemplMenuSite::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 BxBaseMenuMoreAuto.

getCode() [2/3]

BxTemplMenuSite::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 BxBaseMenuMoreAuto.

getCode() [3/3]

BxTemplMenuSite::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 BxBaseMenuMoreAuto.

---

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

• modules/boonex/artificer/data/template/system/scripts/BxTemplMenuSite.php
• modules/boonex/decorous/data/template/system/scripts/BxTemplMenuSite.php
• modules/boonex/lucid/data/template/system/scripts/BxTemplMenuSite.php
• template/scripts_templ/BxTemplMenuSite.php