BxBaseModTextTemplate Class Reference

Inheritance diagram for BxBaseModTextTemplate:

Public Member Functions
	__construct (&$oConfig, &$oDb)
	addLocationBase ()
	getJsCode ($sType, $aParams=array(), $bWrap=true)
	unit ($aData, $isCheckPrivateContent=true, $sTemplateName='unit.html', $aParams=array())
	entryAttachments ($aData, $aParams=array())
	entryAuthor ($aData, $iProfileId=false, $sFuncAuthorDesc='getAuthorDesc', $sTemplateName='author.html', $sFuncAuthorAddon='getAuthorAddon')
	entryBreadcrumb ($aContentInfo, $aTmplVarsItems=array())
	getAttachLinkForm ($iContentId=0)
	getAttachLinkField ($iUserId, $iContentId=0)
	getAttachLinkItem ($iUserId, $mixedLink)
	getEventLinks ($iContentId)
	getTmplVarsText ($aData)
	getAuthorDesc ($aData, $oProfile)
	getAuthorProfileDesc ($aData, $oProfile)
	getProfileSnippetMenu ($aData)
	getAuthorAddon ($aData, $oProfile)
	mediaExif ($aMediaInfo, $iProfileId=false, $sFuncAuthorDesc='', $sTemplateName='media-exif.html')
Public Member Functions inherited from BxBaseModGeneralTemplate
	getTitleAuto ($aData, $iMaxLen=20, $sEllipsisSign='...')
	getTitle ($aData, $mixedProcessOutput=BX_DATA_TEXT)
	getAbstract ($aData, $mixedProcessOutput=BX_DATA_TEXT)
	getText ($aData, $mixedProcessOutput=BX_DATA_HTML)
	getProfileLink ($mixedProfile)
	getLink ($sTemplate, $aParams)
	getContextAddon ($aData, $oProfile)
	getContextDesc ($aData)
	entryText ($aData, $sTemplateName='entry-text.html')
	entryLocation ($iContentId)
	entryInfo ($aData, $aValues=array())
	getFavoriteList ($oProfile, $iStart, $iPerPage, $aParams)
	getFavoritesListInfo ($aList, $oProfile)
	getBrowsingFilters ($aParams)
	entryAllActions ($sActions)
	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)
	entryPolls ($aData)
	entryPollAnswers ($aPoll, $bDynamic=false)
	entryPollResults ($aPoll, $bDynamic=false)
	getPollForm ($iParentCid=0)
	getPollField ($iContentId=0, $iProfileId=0)
	getPollItem ($mixedPoll, $iProfileId=0, $aParams=[])
	embedPollItem ($mixedPoll, $aParams=array())
	embedPollItems ($mixedContentInfo, $aParams=array())
	_getImageSettings ($sSettings)
	_prepareImage ($aData, $sUniqId, $aUploaders, $sStorage, $sField, $bAllowTweak, $bAllowMultiple=false)
	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)

Protected Member Functions
	_addCssJsPolls ($bDynamic=false)
	checkPrivacy ($aData, $isCheckPrivateContent, $oModule, $sTemplateName='')
	getUnitThumbAndGallery ($aData)
	getUnit ($aData, $aParams=array())
	getAttachmentsImagesTranscoders ($sStorage='')
	_getUnitName ($aData, $sTemplateName='unit.html')
	_getUnitClass ($aData, $sTemplateName='unit.html')
	_getUnitHtmlId ($aData, $sTemplateName='unit.html')
	_getHeaderImageParams ()
	_getHeaderImage ($aData)
Protected Member Functions inherited from BxBaseModGeneralTemplate
	getSummary ($aData, $sTitle='', $sText='', $sUrl='')
	getAttachmentsVideoTranscoders ($sStorage='')
	getAttachments ($sStorage, $aData, $aParams=array())
	_getPollAnswers ($aPoll, $bDynamic=false)
	_getPollResults ($aPoll, $bDynamic=false)
	_getPollBlockMenu ($aPoll, $sSelected='', $aParams=[])
	_embedChecks ($sStorageKey, $iFileId)

Protected Attributes
	$_sUnitClassShowCase
Protected Attributes inherited from BxBaseModGeneralTemplate
	$MODULE
	$_bIsApi
Protected Attributes inherited from BxDolModuleTemplate
	$_oDb
	$_oConfig
	$_bObStarted = 0
	$_oModule

Additional Inherited Members
Public Attributes inherited from BxBaseModGeneralTemplate
	$aMethodsToCallAddJsCss = array('entry', 'unit')

Detailed Description

Module representation.

Constructor & Destructor Documentation

__construct()

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

Reimplemented from BxBaseModGeneralTemplate.

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

Member Function Documentation

_addCssJsPolls()

BxBaseModTextTemplate::_addCssJsPolls ( $bDynamic = false )

protected

Reimplemented from BxBaseModGeneralTemplate.

addLocationBase()

BxBaseModTextTemplate::addLocationBase

(

)

Reimplemented from BxBaseModGeneralTemplate.

entryAttachments()

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

Reimplemented from BxBaseModGeneralTemplate.

entryBreadcrumb()

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

Reimplemented from BxBaseModGeneralTemplate.

getAttachmentsImagesTranscoders()

BxBaseModTextTemplate::getAttachmentsImagesTranscoders ( $sStorage = '' )

protected

Reimplemented from BxBaseModGeneralTemplate.

getJsCode()

BxBaseModTextTemplate::getJsCode	(		$sType,
			$aParams = array(),
			$bWrap = true )

Reimplemented from BxBaseModGeneralTemplate.

getTmplVarsText()

BxBaseModTextTemplate::getTmplVarsText

(

$aData

)

Hooks:

'system', 'image_editor' - hook to override profile cover editor

• $unit_name - equals system
• $action - equals image_editor
• $object_id - not used
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • module - [string] module name
  • content_id - [int] profile content id
  • is_allow_edit - [boolean] if edit action is allowed to current user
  • image_type - [string] image type equals to header_image
  • image_url - [string] image URL
  • uploader - [string] uploader name
  • storage - [string] storage name
  • transcoder - [string] transcoder name
  • field - [string] field name
  • is_background - [boolean] if image is used as background, always false
  • add_class - [string] by ref, class to add, can be overridden in hook processing
  • add_code - [array] by ref, code to add, can be overridden in hook processing

    HOOKS

    'system', 'image_editor' - hook to override profile cover editor

Reimplemented from BxBaseModGeneralTemplate.

getUnitThumbAndGallery()

BxBaseModTextTemplate::getUnitThumbAndGallery ( $aData )

protected

Reimplemented in BxAdsTemplate, BxClssTemplate, BxGlsrTemplate, BxPostsTemplate, BxReviewsTemplate, BxStrmTemplate, BxTasksTemplate, and BxVideosTemplate.

unit()

BxBaseModTextTemplate::unit	(		$aData,
			$isCheckPrivateContent = true,
			$sTemplateName = 'unit.html',
			$aParams = array() )

Hooks:

'{module_name}', 'unit' - hook to override content browsing unit

• $unit_name - module name
• $action - equals unit
• $object_id - not used
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • data - [array] content info array as key&value pairs
  • check_private_content - [boolean] check if it's a provate content
  • template - [string] or [array] with template for content unit
  • params - [array] additional params array as key&value pairs
  • tmpl_name - [string] by ref, template name, can be overridden in hook processing
  • tmpl_vars - [array] by ref, template parsable variables as key&value pairs, can be overridden in hook processing

    HOOKS

    '{module_name}', 'unit' - hook to override content browsing unit

---

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

• modules/base/text/classes/BxBaseModTextTemplate.php