BxBasePage Class Reference

Inheritance diagram for BxBasePage:

Public Member Functions
	__construct ($aObject, $oTemplate)
	performActionGetHelp ()
	performActionGetShare ()
	performActionEmbed ()
	performActionCreativeSave ()
	isAllowedCreativeManage ()
	getCodeDynamic ()
	getIncludes ()
	getCode ()
	getJsClassName ()
	getJsObjectName ()
	_wrapInTagJsCode ($sCode)
	getJsScript ()
	isPageCover ()
	setSubPage ($b=true)
	setPageCover ($bCover=true)
	getPageCoverImage ($bTranscoder=true)
	getPageCoverParams ()
	getBlockTitle ($aBlock)
	getBlockHelp ($aBlock)
	getBlockAsyncCode ($aBlock, $iAsync)
	getPageAPI ($aBlocks=[])
	getPageBlocksAPI ($aBlocks=[])
Public Member Functions inherited from BxDolPage
	displayPage ($oTemplate=null)
	getId ()
	getType ()
	getModule ()
	getSubMenu ()
	getMetaDescription ()
	getName ()
	getObject ()
	getInjections ()
	setTitle ($sTitle)
	addMarkers ($a)
	isAvailablePage ()
	isVisiblePage ()
	isPage ()
	isVisiblePageSubmenu ()
	isEditAllowed ()
	isDeleteAllowed ()

Protected Member Functions
	_getPageCodeVars ()
	processPageBlock (&$aBlock, $bApi=false)
	_getPageCode ()
	_getBlockOnlyCode ($iBlockId)
	_getBlockCodeWithCache (&$aBlock, $iAsync=0)
	_getBlockCode (&$aBlock, $iAsync=0)
	_addJsCss ()
	_addSysTemplateVars ()
	_selectMenu ()
	_setSubmenu ($aParams)
	_getBlockRaw ($aBlock)
	_getBlockCustom ($aBlock)
	_getBlockHtml ($aBlock)
	_getBlockCreative ($aBlock)
	_getBlockBentoGrid ($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 ()
	_getCacheObject ($sSuffixObj='Page', $sSuffixParam='page')
	_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)

Protected Attributes
	$_oTemplate
	$_sStorage
	$_oPageCacheObject = null
	$_oBlockCacheObject = null
	$_sJsClassName = ''
	$_sJsObjectName = ''
	$_aHtmlIds = []
	$_bStickyColumns = false
	$_bSubPage = false
Protected Attributes inherited from BxDolPage
	$_sObject
	$_aObject
	$_oQuery
	$_aMarkers = array ()

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	multisiteLinkCheck ($sLink, $sPageUri='', $sPageModule='', $aQueryParams=[])
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	getSeoHash ($s)
static	getEmbedData ($sUrl)
static	isLockedFromUnauthenticated ($sUri)
static	redirectToLoginForm ()
Static Public Member Functions inherited from iBxDolFactoryObject
static	getObjectInstance ($sObject)

Detailed Description

Page representation.

See also

BxDolPage

Member Function Documentation

_addJsCss()

BxBasePage::_addJsCss ( )

protected

Add necessary js and css files.

Reimplemented in BxAlbumsPageMedia, BxBasePageAccount, BxBasePageHome, BxMarketPageBrowse, and BxPollsPageEntry.

_addSysTemplateVars()

BxBasePage::_addSysTemplateVars ( )

protected

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

_getBlockBentoGrid()

BxBasePage::_getBlockBentoGrid ( $aBlock )

protected

Get content for 'bento_grid' block type.

Returns

string

Isn't supported for now.

_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

Reimplemented in BxBasePageHome.

_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

Reimplemented in BxBaseModTextPageEntry.

_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

Reimplemented in BxBaseModGeneralPageEntry.

_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

Reimplemented in BxBaseModGeneralPageEntry, and BxBasePageAccount.

_getPageCode()

BxBasePage::_getPageCode ( )

protected

Get page code only.

Returns

string

_getPageCodeVars()

BxBasePage::_getPageCodeVars ( )

protected

Get page code vars

Returns

string

Reimplemented in BxBasePageWiki.

_getPageMetaDesc()

BxBasePage::_getPageMetaDesc ( )

protected

Get page meta description.

Returns

string

Reimplemented in BxBaseModGeneralPageEntry.

_getPageMetaImage()

BxBasePage::_getPageMetaImage ( )

protected

Get page meta image.

Returns

string

Reimplemented in BxBasePageHome.

_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

Reimplemented in BxAdsPageEntry, BxBaseModTextPageEntry, BxClssPageEntry, BxGlsrPageEntry, BxPhotosPageEntry, BxPostsPageEntry, BxReviewsPageEntry, BxShopifyPageEntry, BxSnipcartPageEntry, BxStrmPageEntry, BxTasksPageEntry, and BxVideosPageEntry.

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.

Hooks:

'system', 'page_output_block' - hook with page block data to be output

• $unit_name - equals system
• $action - equals page_output_block
• $object_id - not used
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • page_name - [string] page object name
  • page_object - [object] an instance of page class,

    See also

    BxDolPage

  • page_query - [object] an instance of page related query class
  • block_id - [int] block id

    HOOKS

    'system', 'page_output_block' - hook with page block data to be output

Hooks:

'system', 'page_output' - hook with page data to be output

• $unit_name - equals system
• $action - equals page_output
• $object_id - not used
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • page_name - [string] page object name
  • page_object - [object] an instance of page class,

    See also

    BxDolPage

  • page_query - [object] an instance of page related query class
  • page_code - [string] by ref, final page code to be output, can be overridden in hook processing
  • sub_page - [boolean] if the page is used as subpage of some parent page

    HOOKS

    'system', 'page_output' - hook with page data to be output

Reimplemented in BxAdsPageEntry, BxAlbumsPageMedia, BxBaseCmtsPageView, BxBaseModGeneralPageEntry, BxBaseModGeneralPageListEntry, BxBaseModGroupsPageEntry, BxBaseModProfilePageEntry, BxBaseModTextPageAuthor, BxBaseModTextPageEntry, BxBasePageHome, BxClssPageEntry, BxEventsPageEntriesInContext, BxEventsPageEntry, BxForumPageEntry, BxGroupsPageEntriesInContext, BxJobsPageEntriesInContext, BxJobsPageEntry, BxMarketPageEntry, BxPhotosPageAuthor, BxPhotosPageBrowse, BxPhotosPageEntry, BxPollsPageEntry, BxShopifyPageEntry, BxSnipcartPageEntry, and BxTimelinePageViewItem.

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.

Hooks:

'system', 'get_page_api' - hook to override page peremeters, is used in API calls

• $unit_name - equals system
• $action - equals get_page_api
• $object_id - not used
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • page - [object] an instance of page class,

    See also

    BxDolPage

  • blocks - [array] array with page blocks
  • data - [array] by ref, page peremeters array as key&value pairs, can be overridden in hook processing

    HOOKS

    'system', 'get_page_api' - hook to override page peremeters, is used in API calls

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