BxCoursesTemplate Class Reference

Inheritance diagram for BxCoursesTemplate:

Public Member Functions
	__construct (&$oConfig, &$oDb)
	unit ($aData, $isCheckPrivateContent=true, $mixedTemplate=false, $aParams=[])
	unitVars ($aData, $isCheckPrivateContent=true, $mixedTemplate=false, $aParams=[])
	getCounters ($aCounters)
	getJoinedEntriesSummary ($iProfileId)
	entryStructureByLevel ($aContentInfo, $aParams=[])
	entryStructureByParentMl1 ($aContentInfo, $aParams=[])
	entryStructureByParentMl2 ($aContentInfo, $aParams=[])
	entryStructureByParentMl3 ($aContentInfo, $aParams=[])
	entryNode ($aContentInfo, $aParams=[])
	entryData ($aData, $sView)
Public Member Functions inherited from BxBaseModGroupsTemplate
	addLocationBase ()
	prepareCover ($aData, $aParams=[])
	getPopupSetRole ($aRoles, $iProfileId, $iProfileRole)
	getPopupQuestionnaire ($iContentId, $iProfileId)
	_image ($sField, $sTranscodeObject, $sNoImage, $aData, $bSubstituteNoImage=true)
Public Member Functions inherited from BxBaseModProfileTemplate
	unitAPI ($aData, $aParams=[])
	isProfilePublic ($aData)
	getSnippetMenuVars ($iProfileId, $bPublic=null, $aParams=[])
	getBlockCover ($aData, $aParams=[])
	setCover ($oPage, $aData, $sTemplateName='cover.html')
	avatar ($aData, $bSubstituteNoImage=true)
	thumb ($aData, $bSubstituteNoImage=true)
	icon ($aData, $bSubstituteNoImage=true)
	urlIcon ($aData, $bSubstituteNoImage=true)
	urlThumb ($aData, $bSubstituteNoImage=true)
	urlAvatar ($aData, $bSubstituteNoImage=true)
	urlAvatarBig ($aData, $bSubstituteNoImage=true)
	urlPicture ($aData, $bSubstituteNoImage=true)
	urlCover ($aData, $bSubstituteNoImage=false)
	urlCoverUnit ($aData, $bSubstituteNoImage=true)
Public Member Functions inherited from BxBaseModGeneralTemplate
	getJsCode ($sType, $aParams=array(), $mixedWrap=true)
	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)
	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, $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
	_entryNodeItems ($iProfileId, $iContentId, $aNode, $iUsage)
	_getNodeStatus ($iProfileId, $iContentId, $iNodeId)
Protected Member Functions inherited from BxBaseModGroupsTemplate
	_getUnitClass ($aData, $sTemplateName='unit.html')
	_getUnitSize ($aData, $sTemplateName='unit.html')
	_isUnitThumb ($aData, $sTemplateName='unit.html')
Protected Member Functions inherited from BxBaseModProfileTemplate
	_getUnitThumbUrl ($sSize, $aData, $bSubstituteNoImage=true)
Protected Member Functions inherited from BxBaseModGeneralTemplate
	getSummary ($aData, $sTitle='', $sText='', $sUrl='')
	getAttachmentsImagesTranscoders ($sStorage='')
	getAttachmentsVideoTranscoders ($sStorage='')
	getAttachments ($sStorage, $aData, $aParams=array())
	_embedChecks ($sStorageKey, $iFileId)

Protected Attributes
	$_iProfileId
Protected Attributes inherited from BxBaseModGroupsTemplate
	$_iUnitCharsSummary
	$_sUnitClassWoCover
Protected Attributes inherited from BxBaseModProfileTemplate
	$_sUnitDefault
	$_sUnitSizeDefault
	$_sUnitClass
	$_sUnitClassWithCover
	$_sUnitClassWoInfo
	$_sUnitClassWoInfoShowCase
	$_sUnitClassShowCase
	$_bLetterAvatar
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')

Constructor & Destructor Documentation

__construct()

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

Reimplemented from BxBaseModGroupsTemplate.

Member Function Documentation

entryStructureByParentMl1()

BxCoursesTemplate::entryStructureByParentMl1	(		$aContentInfo,
			$aParams = [] )

For 1 level bases structure ( Max Level = 1)

entryStructureByParentMl2()

BxCoursesTemplate::entryStructureByParentMl2	(		$aContentInfo,
			$aParams = [] )

For 2 levels bases structure ( Max Level = 2)

entryStructureByParentMl3()

BxCoursesTemplate::entryStructureByParentMl3	(		$aContentInfo,
			$aParams = [] )

For 3 levels bases structure ( Max Level = 3)

unit()

BxCoursesTemplate::unit	(		$aData,
			$isCheckPrivateContent = true,
			$mixedTemplate = false,
			$aParams = [] )

Get profile unit

Allow use separate template for private profiles. These templates will be used if privacy field "Visible to" don't allow to view content. To use them you need to create a template with a postfix "_private" and put it in specified module Example: "unit_private.html" for "unit.html" or "unit_wo_links_private.html" for "unit_wo_links.html"

Hooks:

'profile', 'unit' - hook to override profile browsing unit

• $unit_name - equals profile
• $action - equals unit
• $object_id - not used
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • module - [string] module name
  • data - [array] profile info array as key&value pairs
  • check_private_content - [boolean] check if it's a provate profile
  • template - [string] or [array] with template for profile 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

    'profile', 'unit' - hook to override profile browsing unit

Hooks:

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

It's equivalent to 'profile', 'unit' - hook to override profile browsing unit

HOOKS

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

Reimplemented from BxBaseModProfileTemplate.

unitVars()

BxCoursesTemplate::unitVars	(		$aData,
			$isCheckPrivateContent = true,
			$mixedTemplate = false,
			$aParams = [] )

Reimplemented from BxBaseModGroupsTemplate.

---

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

• modules/boonex/courses/classes/BxCoursesTemplate.php