Inheritance diagram for BxBaseModGeneralTemplate:

Public Member Functions
	__construct (&$oConfig, &$oDb)

	addLocationBase ()

	getJsCode ($sType, $aParams=array(), $mixedWrap=true)

	getTitleAuto ($aData, $iMaxLen=20, $sEllipsisSign='...')

	getTitle ($aData, $mixedProcessOutput=BX_DATA_TEXT)

	getText ($aData, $mixedProcessOutput=BX_DATA_HTML)

	getProfileLink ($mixedProfile)

	getLink ($sTemplate, $aParams)

	getContextAddon ($aData, $oProfile)

	getContextDesc ($aData)

	getTmplVarsText ($aData)

	entryBreadcrumb ($aContentInfo, $aTmplVarsItems=array())

	entryText ($aData, $sTemplateName='entry-text.html')

	entryLocation ($iContentId)

	entryInfo ($aData, $aValues=array())

	getFavoriteList ($oProfile, $iStart, $iPerPage, $aParams)

	getFavoritesListInfo ($aList, $oProfile)

	getBrowsingFilters ($aParams)

	entryAllActions ($sActions)

	entryAttachments ($aData, $aParams=array())

	entryAttachmentsByStorage ($mixedStorage, $aData, $aParams=array())

	entryContext ($aData, $iProfileId=false, $sFuncContextDesc='getContextDesc', $sTemplateName='context.html', $sFuncContextAddon='getContextAddon')

	getAttachmentsData ($sStorage, $aData, $aParams=array())

	embedVideo ($iFileId)

	embedSound ($iFileId)

	_getImageSettings ($sSettings)

	_prepareImage ($aData, $sUniqId, $sUploader, $sStorage, $sField, $bAllowTweak)

	addCssJs ()

Public Member Functions inherited from BxDolModuleTemplate
	__construct (&$oConfig, &$oDb, $sRootPath=BX_DIRECTORY_PATH_ROOT, $sRootUrl=BX_DOL_URL_ROOT)

	getModule ()

	init ()

	addCssSystem ($mixedFiles, $bDynamic=false)

	addCss ($mixedFiles, $bDynamic=false)

	addJsSystem ($mixedFiles, $bDynamic=false)

	addJs ($mixedFiles, $bDynamic=false)

	addJsTranslation ($mixedKey, $bDynamic=false)

	addStudioCss ($mixedFiles, $bDynamic=false, $bSearchInModule=true)

	addStudioCssSystem ($mixedFiles, $bDynamic=false, $bSearchInModule=true)

	addStudioJs ($mixedFiles, $bDynamic=false, $bSearchInModule=true)

	addStudioJsSystem ($mixedFiles, $bDynamic=false, $bSearchInModule=true)

	addStudioJsTranslation ($mixedKey)

	_addFiles ($oTemplate, $sFuncAddFiles, $sFuncIsLocation, $sFuncAddLocation, $sFuncRemoveLocation, $sPath, $mixedFiles, $bDynamic=false, $bSearchInModule=true, $aLocations=array())

	addStudioInjection ($sKey, $sType, $sData, $iReplace=0)

	pageStart ()

	pageEnd ($isGetContent=true)

	isMethodExists ($s)

Public Attributes
	$aMethodsToCallAddJsCss = array('entry', 'unit')

Protected Member Functions
	getSummary ($aData, $sTitle='', $sText='', $sUrl='')

	getAttachmentsImagesTranscoders ($sStorage='')

	getAttachmentsVideoTranscoders ($sStorage='')

	getAttachments ($sStorage, $aData, $aParams=array())

	_embedChecks ($sStorageKey, $iFileId)

Protected Attributes
	$MODULE

	$_bIsApi

Protected Attributes inherited from BxDolModuleTemplate
	$_oDb

	$_oConfig

	$_bObStarted = 0

	$_oModule

Detailed Description

Module representation.

Constructor & Destructor Documentation

◆ __construct()

BxBaseModGeneralTemplate::__construct	(	&	$oConfig,
		&	$oDb )

Reimplemented in BxAlbumsTemplate, BxCnvTemplate, BxForumTemplate, BxGlsrTemplate, BxPhotosTemplate, BxPollsTemplate, BxShopifyTemplate, BxSnipcartTemplate, and BxVideosTemplate.

Member Function Documentation

◆ addCssJs()

BxBaseModGeneralTemplate::addCssJs ( )

Reimplemented from BxDolModuleTemplate.

◆ addLocationBase()

BxBaseModGeneralTemplate::addLocationBase ( )

Reimplemented from BxDolModuleTemplate.

◆ getJsCode()

BxBaseModGeneralTemplate::getJsCode	(	$sType,
		$aParams = array(),
		$mixedWrap = true )

Hooks:

'system', 'get_js_code' - hook to override an instance of JavaScript class associate with the page

$unit_name - equals system
$action - equals get_js_code
$object_id - not used
$sender_id - not used
$extra_params - array of additional params with the following array keys:
- mask - [string] by ref, a mask to generate JS code, can be overridden in hook processing
- mask_markers - [array] by ref, an array of markers to be parsed in the mask, can be overridden in hook processing
- object - [string] by ref, a string with JS object name, can be overridden in hook processing
- class - [string] by ref, a string with JS class name, can be overridden in hook processing
- params - [array] by ref, an array of parameters as key&value pairs which will be passed to constructor, can be overridden in hook processing
- override_result - [string] or [boolean] by ref, if string is returned then it will be used as resulting JS code, can be overridden in hook processing
  HOOKS
  'system', 'get_js_code' - hook to override an instance of JavaScript class associate with the page

◆ getTmplVarsText()

BxBaseModGeneralTemplate::getTmplVarsText ( $aData )

Reimplemented in BxBaseModTextTemplate.

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

modules/base/general/classes/BxBaseModGeneralTemplate.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes