BxBasePage Class Reference

Inheritance diagram for BxBasePage:

Public Member Functions
	getCodeDynamic ()
	getCode ()
	isPageCover ()
	getBlockTitle ($aBlock)
	getBlockHelp ($aBlock)
	getBlockAsyncCode ($aBlock, $iAsync)
	getPageAPI ($aBlocks=[])
Public Member Functions inherited from BxDolPage
	displayPage ($oTemplate=null)
	addMarkers ($a)
	isPage ()

Protected Member Functions
	_getPageCodeVars ()
	processPageBlock (&$aBlock, $bApi=false)
	_getPageCode ()
	_getBlockOnlyCode ($iBlockId)
	_getBlockCode (&$aBlock, $iAsync=0)
	_addJsCss ()
	_addSysTemplateVars ()
	_selectMenu ()
	_setSubmenu ($aParams)
	_getBlockRaw ($aBlock)
	_getBlockCustom ($aBlock)
	_getBlockHtml ($aBlock)
	_getBlockCreative ($aBlock)
	_getBlockWiki ($aBlock)
	_getBlockLang ($aBlock)
	_getBlockImage ($aBlock)
	_getBlockRss ($aBlock)
	_getBlockMenu ($aBlock)
	_getBlockService ($aBlock)
	_getPageTitle ()
	_getPageMetaDesc ()
	_getPageMetaTitle ()
	_getPageMetaImage ()
	_getPageMetaKeywords ()
	_getPageMetaRobots ()
	_getPageNotFoundMsg ($mixedMsg=false)
	_getPageAccessDeniedMsg ($mixedMsg=false)
	_getPageCacheObject ()
	_getBlockCacheObject ()
	_getPageCacheKey ($isPrefixOnly=false)
	_getBlockCacheKey ($isPrefixOnly=false, $aBlock=array())
	_getPageCacheParams ()
	cleanCache ($isDelAllWithPagePrefix=false)
Protected Member Functions inherited from BxDolPage
	__construct ($aObject)
	_replaceMarkers ($mixed, $aAdditionalMarkers=array())
	_isVisibleBlock ($a)
	_isAvailablePage ($a)
	_isVisiblePage ($a)

Additional Inherited Members
Static Public Member Functions inherited from BxDolPage
static	getObjectInstanceByModuleAndURI ($sModule, $sURI='', $oTemplate=false)
static	getObjectInstanceByURI ($sURI='', $oTemplate=false, $bRedirectCheck=false)
static	getObjectInstance ($sObject, $oTemplate=false)
static	processPageTrigger ($sPageTriggerName)
static	getMultisite ($sLink, $sPageUri='', $sPageModule='', $aQueryParams=[])
static	deleteSeoLink ($sModule, $sContentInfoObject, $sId)
static	deleteSeoLinkByParam ($sParamName, $sId)
static	deleteSeoLinkByModule ($sModule)
static	getPageBySeoLink ($sRequest)
static	processSeoLink ($sRequest)
static	transformSeoLink ($sLink, $sPrefix, $aParams=array())
static	untransformSeoLink ($sSeoLink, $sPrefix)
static	seoRedirect ()
static	getEmbedData ($sUrl)

Detailed Description

Page representation.

See also

BxDolPage

Member Function Documentation

_addJsCss()

BxBasePage::_addJsCss ( )

protected

Add necessary js and css files.

_addSysTemplateVars()

BxBasePage::_addSysTemplateVars ( )

protected

Set system template variables, like page title, meta description, meta keywords and meta robots.

_getBlockCacheKey()

BxBasePage::_getBlockCacheKey (   $isPrefixOnly = false,   $aBlock = array()  )

protected

Get block cache key.

Parameters

$isPrefixOnly

return key prefix only.

Returns

string

_getBlockCacheObject()

BxBasePage::_getBlockCacheObject ( )

protected

Get block cache object.

Returns

cache object instance

_getBlockCode()

BxBasePage::_getBlockCode ( &  $aBlock,   $iAsync = 0  )

protected

Get block code.

Returns

string

_getBlockCreative()

BxBasePage::_getBlockCreative (   $aBlock )

protected

Get content for 'creative' block type.

Returns

string

_getBlockCustom()

BxBasePage::_getBlockCustom (   $aBlock )

protected

Get content for 'custom' block type.

Returns

string

_getBlockHtml()

BxBasePage::_getBlockHtml (   $aBlock )

protected

Get content for 'html' block type.

Returns

string

_getBlockImage()

BxBasePage::_getBlockImage (   $aBlock )

protected

Get content for 'image' block type.

Returns

string

_getBlockLang()

BxBasePage::_getBlockLang (   $aBlock )

protected

Get content for 'lang' block type.

Returns

string

_getBlockMenu()

BxBasePage::_getBlockMenu (   $aBlock )

protected

Get content for 'menu' block type.

Returns

string

_getBlockOnlyCode()

BxBasePage::_getBlockOnlyCode (   $iBlockId )

protected

Get one block code only.

Returns

string

_getBlockRaw()

BxBasePage::_getBlockRaw (   $aBlock )

protected

Get content for 'raw' block type.

Returns

string

_getBlockRss()

BxBasePage::_getBlockRss (   $aBlock )

protected

Get content for 'rss' block type.

Returns

string

_getBlockService()

BxBasePage::_getBlockService (   $aBlock )

protected

Get content for 'service' block type.

Returns

string

_getBlockWiki()

BxBasePage::_getBlockWiki (   $aBlock )

protected

Get content for 'wiki' block type.

Returns

string

_getPageAccessDeniedMsg()

BxBasePage::_getPageAccessDeniedMsg (   $mixedMsg = false )

protected

Get access denied message.

Returns

string

_getPageCacheKey()

BxBasePage::_getPageCacheKey (   $isPrefixOnly = false )

protected

Get page cache key.

Parameters

$isPrefixOnly

return key prefix only.

Returns

string

_getPageCacheObject()

BxBasePage::_getPageCacheObject ( )

protected

Get page cache object.

Returns

cache object instance

_getPageCacheParams()

BxBasePage::_getPageCacheParams ( )

protected

Additional cache key. In the case of dynamic page. For example - profile page, where each profile has own page.

Returns

string

_getPageCode()

BxBasePage::_getPageCode ( )

protected

Get page code only.

Returns

string

_getPageCodeVars()

BxBasePage::_getPageCodeVars ( )

protected

Get page code vars

Returns

string

_getPageMetaDesc()

BxBasePage::_getPageMetaDesc ( )

protected

Get page meta description.

Returns

string

_getPageMetaImage()

BxBasePage::_getPageMetaImage ( )

protected

Get page meta image.

Returns

string

_getPageMetaKeywords()

BxBasePage::_getPageMetaKeywords ( )

protected

Get page meta keywords.

Returns

string

_getPageMetaRobots()

BxBasePage::_getPageMetaRobots ( )

protected

Get page meta robots.

Returns

string

_getPageMetaTitle()

BxBasePage::_getPageMetaTitle ( )

protected

Get page meta title.

Returns

string

_getPageNotFoundMsg()

BxBasePage::_getPageNotFoundMsg (   $mixedMsg = false )

protected

Get page not found message.

Returns

string

_getPageTitle()

BxBasePage::_getPageTitle ( )

protected

Get page title.

Returns

string

_selectMenu()

BxBasePage::_selectMenu ( )

protected

Select menu from page properties.

_setSubmenu()

BxBasePage::_setSubmenu (   $aParams )

protected

Set page submenu if it's specified

cleanCache()

BxBasePage::cleanCache (   $isDelAllWithPagePrefix = false )

protected

Clean page cache.

Parameters

$isDelAllWithPagePrefix

delete cache by prefix, it can be used for dynamic pages, like profile view, where for each profile separate cache is generated.

Returns

string

getBlockAsyncCode()

BxBasePage::getBlockAsyncCode	(		$aBlock,
			$iAsync
	)

Get code to load block asyncroniously

Parameters

$aBlock	block code
$iAsync	if greater than 0 the it defines loading indicator for the block

Returns

HTML code string

getBlockHelp()

BxBasePage::getBlockHelp

(

$aBlock

)

Get help control if help is available for the block.

Returns

string

getBlockTitle()

BxBasePage::getBlockTitle

(

$aBlock

)

Get block title.

Returns

string

getCode()

BxBasePage::getCode

(

)

Get page code with automatic caching, adding necessary css/js files and system template vars.

Returns

string.

getCodeDynamic()

BxBasePage::getCodeDynamic

(

)

Very similar to BxBasePage::getCode but adds css and js files which are needed for the corect page display

getPageAPI()

BxBasePage::getPageAPI

(

$aBlocks = []

)

Get page array with all cells and blocks

Profile/Context view page.

Process page cover with related menus and lists.

Process page mange menu.

isPageCover()

BxBasePage::isPageCover

(

)

Is page cover enabled.

Returns

string

processPageBlock()

BxBasePage::processPageBlock ( &  $aBlock,   $bApi = false  )

protected

Process block values, especially if someting need to be overrided

---

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

• template/scripts/BxBasePage.php