BxBaseModGeneralMenuSnippetMeta Class Reference

Inheritance diagram for BxBaseModGeneralMenuSnippetMeta:

Public Member Functions
	__construct ($aObject, $oTemplate=false)
	getCode ()
	setContentId ($iContentId)
Public Member Functions inherited from BxBaseMenuUnitMeta
	setContext ($sContext)
	getUnitMetaItemLink ($sContent, $aAttrs=array())
	getUnitMetaItemText ($sContent, $aAttrs=array())
	getUnitMetaItemButton ($sContent, $aAttrs=array())
	getUnitMetaItemButtonSmall ($sContent, $aAttrs=array())
	getUnitMetaItemNl ($sContent='')
	getUnitMetaItemCustom ($sContent)
	getUnitMetaItemExtended ($sContent='', $sIcon='', $sUrl='', $bIsNoBg=false, $bIsNoPadding=false)
	getUnitMetaItem ($sName, $sContent, $aAttrs=array(), $sTemplate='unit_meta_item.html')
	getUnitMetaItemButtonOrLink ($sName, $sContent, $aAttrs=array())
Public Member Functions inherited from BxBaseMenuCustom
	getTemplateNameItem ($sName='')
	setTemplateById ($iTemplateId)
Public Member Functions inherited from BxBaseMenuMoreAuto
	isMoreAuto ()
Public Member Functions inherited from BxBaseMenu
	getDisplayAddons ()
	setDisplayAddons ($b)
	getCodeAPI ()
	getCodeItem ($sName)
	getMenuItems ()
	getMenuItem ($sName)
	getMenuIconHtml ($sIcon)
Public Member Functions inherited from BxDolMenu
	isVisible ()
	getTemplateId ()
	getTemplateName ($sName='')
	setSelected ($sModule, $sName)
	setDynamicMode ($bDynamicMode)
	getMarkers ()
	addMarkers ($a)
	removeMarker ($s)
	performActionSetCollapsed ($mixedValue)
	performActionSetCollapsedSubmenu ($sMenuItem, $mixedValue)
	getUserChoiceCollapsed ($sObject='')
	getUserChoiceCollapsedSubmenu ($mixedItem, $sObject='')

Protected Member Functions
	_getMenuItemAuthor ($aItem)
	_getMenuItemDate ($aItem)
	_getMenuItemCategory ($aItem)
	_getMenuItemTags ($aItem)
	_getMenuItemViews ($aItem, $aParams=[])
	_getMenuItemViewsObject ($aItem, $aParams=[])
	_getMenuItemVotes ($aItem, $aParams=[])
	_getMenuItemVotesObject ($aItem, $aParams=[])
	_getMenuItemRating ($aItem)
	_getMenuItemReactions ($aItem)
	_getMenuItemScore ($aItem, $aParams=[])
	_getMenuItemScoreObject ($aItem, $aParams=[])
	_getMenuItemComments ($aItem, $aParams=[])
	_getMenuItemCommentsObject ($aItem, $aParams=[])
	_getMenuItemDefault ($aItem)
Protected Member Functions inherited from BxBaseMenuUnitMeta
	_getMenuItemNl ($aItem)
	_getMenuItemAPI ($aItem, $mixedType='text', $aData=[])
	_getMenuItemElementAPI ($aItem, $aElement)
	_buttonsCounterReset ()
	_buttonsCounterIncrement ()
	_buttonsCounterCheck ()
	_isVisibleInContext ($aItem)
Protected Member Functions inherited from BxTemplMenuCustom
	_getMenuItem ($a)
Protected Member Functions inherited from BxBaseMenuCustom
	_getCode ($sTmplName, $aTmplVars)
	_getMenuItemMoreAuto ($aItem)
	_getMenuItemDefaultApi ($aItem)
	_getTmplContentItem ()
Protected Member Functions inherited from BxBaseMenuMoreAuto
	_isMoreAuto ()
	_getTemplateVars ()
	_getJsCodeMoreAuto ()
	_getHtmlIds ()
	_getHtmlIdMain ()
	_getJsClassMoreAuto ()
	_getJsObjectMoreAuto ()
	_getTmplContentItemMore ()
	_getTmplContentItemMorePopup ()
Protected Member Functions inherited from BxBaseMenu
	getMenuItemsRaw ()
	_getMenuIcon ($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
	$_bShowZeros
	$_sModule
	$_oModule
	$_iContentId
	$_aContentInfo
Protected Attributes inherited from BxBaseMenuUnitMeta
	$_sStylePrefix
	$_sContext
	$_iButtons
	$_iButtonsMax
Protected Attributes inherited from BxBaseMenuCustom
	$_sTmplContent
	$_sTmplContentItem
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

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 = ''

Constructor & Destructor Documentation

__construct()

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

Reimplemented from BxTemplMenuUnitMeta.

Member Function Documentation

_getMenuItemDefault()

BxBaseModGeneralMenuSnippetMeta::_getMenuItemDefault ( $aItem )

protected

Hooks:

'{module_name}', 'menu_custom_item' - hook to override menu item

• $unit_name - module name
• $action - equals menu_custom_item
• $object_id - not used
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • res - [string] by ref, menu item code, can be overridden in hook processing
  • menu - [string] menu name
  • menu_object - [object] an instance of menu,

    See also

    BxDolMenu

  • item - [array] menu item array as key&value pairs
  • module - [string] module name
  • content_id - [int] content id
  • content_data - [array] content info array as key&value pairs

    HOOKS

    '{module_name}', 'menu_custom_item' - hook to override menu item

Hooks:

'menu', 'menu_custom_item' - hook to override menu item

It's equivalent to '{module_name}', 'menu_custom_item' - hook to override menu item

HOOKS

'menu', 'menu_custom_item' - hook to override menu item

Reimplemented from BxBaseMenuUnitMeta.

getCode()

BxBaseModGeneralMenuSnippetMeta::getCode

(

)

Get menu code.

Returns

string

Reimplemented from BxBaseMenuMoreAuto.

---

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

• modules/base/general/classes/BxBaseModGeneralMenuSnippetMeta.php