Открытые члены
	getDynamicIDs ()

	getCurrentDynamicId ()

	addDynamicData ( $id, $content, $stub="", $containerId=null, $useBrowserStorage=false, $autoUpdate=true, $useAnimation=false)

	startDynamicWithID ($id)

	finishDynamicWithID ( $id, $stub="", $containerId=null, $useBrowserStorage=false, $autoUpdate=true, $useAnimation=false)

Открытые статические члены
static	getInstance ()

static	setEnable ($isEnabled=true)

static	isEnabled ()

static	setUseAppCache ($useAppCache=true)

static	getUseAppCache ()

static	setUseHTMLCache ($useHTMLCache=true)

static	getUseHTMLCache ()

static	isAjaxRequest ()

static	isInvalidationRequest ()

static	isBannerEnabled ()

static	setAutoUpdate ($flag)

static	getAutoUpdate ()

static	setAutoUpdateTTL ($ttl)

static	getAutoUpdateTTL ()

static	onBeforeEndBufferContent ()

static	startBuffering ($content)

static	endBuffering (&$originalContent, $compositeContent)

static	onBeforeRestartBuffer ()

static	onBeforeLocalRedirect (&$url, $skip_security_check, $isExternal)

static	getInjectedCSS ()

static	shouldBeEnabled ()

static	checkAdminPanel ()

static	isSelfHostedPortal ()

static	install ($setDefaults=true)

static	uninstall ()

static	isOn ()

static	onEpilog ()

static	onChangeFile ($path, $site)

static	onUserLogin ()

static	onUserLogout ()

static	isCurrentUserCC ()

static	setNCC ()

static	setCC ()

static	deleteCompositeCookies ()

static	setPreventAutoUpdate ($preventAutoUpdate=true)

static	getPreventAutoUpdate ()

Открытые атрибуты
const	PAGE_DELETION_LIMIT = 100

const	PAGE_DELETION_ATTEMPTS = 2

Подробное описание

См. определение в файле engine.php строка 27

Методы

◆ addDynamicData()

addDynamicData	(	$id,
		$content,
		$stub = "",
		$containerId = null,
		$useBrowserStorage = false,
		$autoUpdate = true,
		$useAnimation = false )

Adds dynamic data to be sent to the client.

Аргументы

string	$id	Unique identifier of the block.
string	$content	Dynamic part html.
string	$stub	Html to use as stub.
string	$containerId	Identifier of the html container.
boolean	$useBrowserStorage	Use browser storage for caching or not.
boolean	$autoUpdate	Automatically or manually update block contents.
boolean	$useAnimation	Animation flag.

Возвращает: void

См. определение в файле engine.php строка 1535

◆ checkAdminPanel()

static checkAdminPanel ( )

static

Checks if admin panel will be shown or not. Disables itself if panel will be show.

См. определение в файле engine.php строка 1228

◆ deleteCompositeCookies()

static deleteCompositeCookies ( )

static

Removes all composite cookies

См. определение в файле engine.php строка 1463

◆ endBuffering()

static endBuffering	(	&	$originalContent,
			$compositeContent )

static

Returns true if $originalContent was modified

Аргументы

$originalContent
$compositeContent

Возвращает: bool

См. определение в файле engine.php строка 401

◆ finishDynamicWithID()

finishDynamicWithID	(	$id,
		$stub = "",
		$containerId = null,
		$useBrowserStorage = false,
		$autoUpdate = true,
		$useAnimation = false )

Marks end of the dynamic block if it's the current dynamic block and its start was being marked early.

Аргументы

string	$id	Unique identifier of the block.
string	$stub	Html to use as stub.
string	$containerId	Identifier of the html container.
boolean	$useBrowserStorage	Use browser storage for caching or not.
boolean	$autoUpdate	Automatically or manually update block contents.
boolean	$useAnimation	Animation flag.

Возвращает: boolean

См. определение в файле engine.php строка 1580

◆ getAutoUpdate()

static getAutoUpdate ( )

static

Gets autoUpdate property

Возвращает: bool

См. определение в файле engine.php строка 228

◆ getAutoUpdateTTL()

static getAutoUpdateTTL ( )

static

Gets auto update ttl

Возвращает: int

См. определение в файле engine.php строка 249

◆ getCurrentDynamicId()

getCurrentDynamicId ( )

Returns the identifier of current dynamic area.

См. также: \Bitrix\Main\Composite\StaticArea::getCurrentDynamicId

Возвращает: string|false

См. определение в файле engine.php строка 1515

◆ getDynamicIDs()

getDynamicIDs ( )

Gets ids of the dynamic blocks.

Возвращает: array

См. определение в файле engine.php строка 1503

◆ getInjectedCSS()

static getInjectedCSS ( )

static

Returns css string to be injected.

@noinspection CssUnknownTarget

@noinspection CssUnusedSymbol

См. определение в файле engine.php строка 1063

◆ getInstance()

static getInstance ( )

static

Singleton instance.

Возвращает: Engine

См. определение в файле engine.php строка 65

◆ getPreventAutoUpdate()

static getPreventAutoUpdate ( )

static

Gets preventAutoUpdate property.

Возвращает: boolean

См. определение в файле engine.php строка 1492

◆ getUseAppCache()

static getUseAppCache ( )

static

Gets useAppCache property.

Возвращает: boolean

См. определение в файле engine.php строка 158

◆ getUseHTMLCache()

static getUseHTMLCache ( )

static

Gets useHTMLCache property.

Возвращает: boolean

См. определение в файле engine.php строка 183

◆ install()

static install ( $setDefaults = true )

static

См. определение в файле engine.php строка 1263

◆ isAjaxRequest()

static isAjaxRequest ( )

static

Returns true if current request was initiated by Ajax.

Возвращает: boolean

См. определение в файле engine.php строка 193

◆ isBannerEnabled()

static isBannerEnabled ( )

static

Returns true if we should inject banner into a page.

Возвращает: bool

См. определение в файле engine.php строка 207

◆ isCurrentUserCC()

static isCurrentUserCC ( )

static

См. определение в файле engine.php строка 1423

◆ isEnabled()

static isEnabled ( )

static

Gets isEnabled property.

Возвращает: boolean

См. определение в файле engine.php строка 131

◆ isInvalidationRequest()

static isInvalidationRequest ( )

static

См. определение в файле engine.php строка 198

◆ isOn()

static isOn ( )

static

Returns true if composite mode is turned on

Возвращает: bool

См. определение в файле engine.php строка 1301

◆ isSelfHostedPortal()

static isSelfHostedPortal ( )

static

Return true if it's a self-hosted portal.

Возвращает: bool

См. определение в файле engine.php строка 1251

◆ onBeforeEndBufferContent()

static onBeforeEndBufferContent ( )

static

OnBeforeEndBufferContent handler. Prepares the stage for composite mode handler.

Возвращает: void

См. определение в файле engine.php строка 260

◆ onBeforeLocalRedirect()

static onBeforeLocalRedirect	(	&	$url,
			$skip_security_check,
			$isExternal )

static

См. определение в файле engine.php строка 766

◆ onBeforeRestartBuffer()

static onBeforeRestartBuffer ( )

static

OnBeforeRestartBuffer event handler. Disables composite mode when called.

Возвращает: void

См. определение в файле engine.php строка 751

◆ onChangeFile()

static onChangeFile	(		$path,
			$site )

static

OnChangeFile Event Handler

См. определение в файле engine.php строка 1379

◆ onEpilog()

static onEpilog ( )

static

См. определение в файле engine.php строка 1311

◆ onUserLogin()

static onUserLogin ( )

static

OnUserLogin Event Handler

См. определение в файле engine.php строка 1395

◆ onUserLogout()

static onUserLogout ( )

static

OnUserLogout Event Handler

См. определение в файле engine.php строка 1415

◆ setAutoUpdate()

static setAutoUpdate ( $flag )

static

Sets autoUpdate property

Аргументы

bool $flag

Возвращает: void

См. определение в файле engine.php строка 219

◆ setAutoUpdateTTL()

static setAutoUpdateTTL ( $ttl )

static

Sets auto update ttl

Аргументы

int $ttl - number of seconds

Возвращает: void

См. определение в файле engine.php строка 240

◆ setCC()

static setCC ( )

static

Sets CC cookie

См. определение в файле engine.php строка 1450

◆ setEnable()

static setEnable ( $isEnabled = true )

static

Sets isEnable property value and attaches needed handlers.

Аргументы

bool $isEnabled Mode control flag.

Возвращает: void

См. определение в файле engine.php строка 82

◆ setNCC()

static setNCC ( )

static

Sets NCC cookie

См. определение в файле engine.php строка 1439

◆ setPreventAutoUpdate()

static setPreventAutoUpdate ( $preventAutoUpdate = true )

static

Sets useHTMLCache property.

Аргументы

boolean $preventAutoUpdate property.

Возвращает: void

См. определение в файле engine.php строка 1481

◆ setUseAppCache()

static setUseAppCache ( $useAppCache = true )

static

Sets useAppCache property.

Аргументы

boolean $useAppCache AppCache mode control flag.

Возвращает: void

См. определение в файле engine.php строка 143

◆ setUseHTMLCache()

static setUseHTMLCache ( $useHTMLCache = true )

static

Sets useHTMLCache property.

Аргументы

boolean $useHTMLCache Composite mode control flag.

Возвращает: void

См. определение в файле engine.php строка 172

◆ shouldBeEnabled()

static shouldBeEnabled ( )

static

Checks whether HTML Cache should be enabled.

См. определение в файле engine.php строка 1143

◆ startBuffering()

static startBuffering ( $content )

static

Аргументы

$content

Возвращает: null|string

См. определение в файле engine.php строка 332

◆ startDynamicWithID()

startDynamicWithID ( $id )

Marks start of a dynamic block.

Аргументы

integer $id Unique identifier of the block.

Возвращает: boolean

См. определение в файле engine.php строка 1558

◆ uninstall()

static uninstall ( )

static

См. определение в файле engine.php строка 1284

Данные класса

◆ PAGE_DELETION_ATTEMPTS

const PAGE_DELETION_ATTEMPTS = 2

См. определение в файле engine.php строка 30

◆ PAGE_DELETION_LIMIT

const PAGE_DELETION_LIMIT = 100

См. определение в файле engine.php строка 29

Bitrix-D7 23.9

Открытые члены

Открытые статические члены

Открытые атрибуты

Подробное описание

Методы

◆ addDynamicData()

◆ checkAdminPanel()

◆ deleteCompositeCookies()

◆ endBuffering()

◆ finishDynamicWithID()

◆ getAutoUpdate()

◆ getAutoUpdateTTL()

◆ getCurrentDynamicId()

◆ getDynamicIDs()

◆ getInjectedCSS()

◆ getInstance()

◆ getPreventAutoUpdate()

◆ getUseAppCache()

◆ getUseHTMLCache()

◆ install()

◆ isAjaxRequest()

◆ isBannerEnabled()

◆ isCurrentUserCC()

◆ isEnabled()

◆ isInvalidationRequest()

◆ isOn()

◆ isSelfHostedPortal()

◆ onBeforeEndBufferContent()

◆ onBeforeLocalRedirect()

◆ onBeforeRestartBuffer()

◆ onChangeFile()

◆ onEpilog()

◆ onUserLogin()

◆ onUserLogout()

◆ setAutoUpdate()

◆ setAutoUpdateTTL()

◆ setCC()

◆ setEnable()

◆ setNCC()

◆ setPreventAutoUpdate()

◆ setUseAppCache()

◆ setUseHTMLCache()

◆ shouldBeEnabled()

◆ startBuffering()

◆ startDynamicWithID()

◆ uninstall()

Данные класса

◆ PAGE_DELETION_ATTEMPTS

◆ PAGE_DELETION_LIMIT