BxBaseModGeneralPageEntry Class Reference

Inheritance diagram for BxBaseModGeneralPageEntry:

Public Member Functions
	__construct ($aObject, $oTemplate=false)
	getContentInfo ()
	getCode ()
Public Member Functions inherited from BxBasePage
	performActionGetHelp ()
	performActionGetShare ()
	performActionEmbed ()
	performActionCreativeSave ()
	isAllowedCreativeManage ()
	getCodeDynamic ()
	getIncludes ()
	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
	_isAvailablePage ($a)
	_isVisiblePage ($a)
	_getPageAccessDeniedMsg ($mixedMsg=false)
	_getPageMetaDesc ()
	_getThumbForMetaObject ()
	_getPageCacheParams ()
Protected Member Functions inherited from BxBasePage
	_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 ()
	_getPageMetaTitle ()
	_getPageMetaImage ()
	_getPageMetaKeywords ()
	_getPageMetaRobots ()
	_getPageNotFoundMsg ($mixedMsg=false)
	_getPageCacheObject ()
	_getBlockCacheObject ()
	_getCacheObject ($sSuffixObj='Page', $sSuffixParam='page')
	_getPageCacheKey ($isPrefixOnly=false)
	_getBlockCacheKey ($isPrefixOnly=false, $aBlock=array())
	cleanCache ($isDelAllWithPagePrefix=false)
Protected Member Functions inherited from BxDolPage
	__construct ($aObject)
	_replaceMarkers ($mixed, $aAdditionalMarkers=array())
	_isVisibleBlock ($a)

Protected Attributes
	$MODULE
	$_oModule
	$_aContentInfo = false
	$_sCoverClass
Protected Attributes inherited from BxBasePage
	$_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

Entry create/edit pages

Constructor & Destructor Documentation

__construct()

BxBaseModGeneralPageEntry::__construct	(		$aObject,
			$oTemplate = false )

Reimplemented from BxTemplPage.

Member Function Documentation

_getPageAccessDeniedMsg()

BxBaseModGeneralPageEntry::_getPageAccessDeniedMsg ( $mixedMsg = false )

protected

Get access denied message.

Returns

string

Reimplemented from BxBasePage.

_getPageCacheParams()

BxBaseModGeneralPageEntry::_getPageCacheParams ( )

protected

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

Returns

string

Reimplemented from BxBasePage.

_getPageMetaDesc()

BxBaseModGeneralPageEntry::_getPageMetaDesc ( )

protected

Get page meta description.

Returns

string

Reimplemented from BxBasePage.

_isAvailablePage()

BxBaseModGeneralPageEntry::_isAvailablePage ( $a )

protected

Check if page is available.

Parameters

type

$a

- page object.

Returns

boolean true if available, false or a string with error message otherwise.

Reimplemented from BxDolPage.

Reimplemented in BxBaseModGroupsPageEntry, BxBaseModTextPageEntry, BxMarketPageEntry, and BxStrmPageEntry.

_isVisiblePage()

BxBaseModGeneralPageEntry::_isVisiblePage ( $a )

protected

Check if page is visible.

Parameters

array

$a

- page object.

Returns

boolean true if visible, false or a string with error message otherwise.

Reimplemented from BxDolPage.

Reimplemented in BxBaseModGroupsPageEntry, and BxBaseModProfilePageEntry.

getCode()

BxBaseModGeneralPageEntry::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 from BxBasePage.

Reimplemented in BxAdsPageEntry, BxBaseModGroupsPageEntry, BxBaseModProfilePageEntry, BxBaseModTextPageEntry, BxClssPageEntry, BxEventsPageEntry, BxForumPageEntry, BxJobsPageEntry, BxMarketPageEntry, BxPhotosPageEntry, BxPollsPageEntry, BxShopifyPageEntry, and BxSnipcartPageEntry.

---

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

• modules/base/general/classes/BxBaseModGeneralPageEntry.php