Bitrix API

Engine

FinalYes

Table of Contents

Constants

PAGE_DELETION_ATTEMPTS  = 2
PAGE_DELETION_LIMIT  = 100

Methods

addDynamicData()  : void
Adds dynamic data to be sent to the client.
deleteCompositeCookies()  : mixed
Removes all composite cookies
finishDynamicWithID()  : bool
Marks end of the dynamic block if it's the current dynamic block and its start was being marked early.
getAutoUpdate()  : bool
Gets autoUpdate property
getAutoUpdateTTL()  : int
Gets auto update ttl
getCurrentDynamicId()  : string|false
Returns the identifier of current dynamic area.
getDynamicIDs()  : array<string|int, mixed>
Gets ids of the dynamic blocks.
getInstance()  : Engine
Singleton instance.
getPreventAutoUpdate()  : bool
Gets preventAutoUpdate property.
getUseAppCache()  : bool
Gets useAppCache property.
getUseHTMLCache()  : bool
Gets useHTMLCache property.
install()  : mixed
isAjaxRequest()  : bool
Returns true if current request was initiated by Ajax.
isBannerEnabled()  : bool
Returns true if we should inject banner into a page.
isCurrentUserCC()  : mixed
isEnabled()  : bool
Gets isEnabled property.
isInvalidationRequest()  : mixed
isOn()  : bool
Returns true if composite mode is turned on
isSelfHostedPortal()  : bool
Return true if it's a self-hosted portal.
onBeforeEndBufferContent()  : void
OnBeforeEndBufferContent handler.
onBeforeLocalRedirect()  : mixed
onBeforeRestartBuffer()  : void
OnBeforeRestartBuffer event handler.
onUserLogin()  : mixed
OnUserLogin Event Handler
onUserLogout()  : mixed
OnUserLogout Event Handler
setAutoUpdate()  : void
Sets autoUpdate property
setAutoUpdateTTL()  : void
Sets auto update ttl
setCC()  : mixed
Sets CC cookie
setEnable()  : void
Sets isEnable property value and attaches needed handlers.
setNCC()  : mixed
Sets NCC cookie
setPreventAutoUpdate()  : void
Sets useHTMLCache property.
setUseAppCache()  : void
Sets useAppCache property.
setUseHTMLCache()  : void
Sets useHTMLCache property.
startDynamicWithID()  : bool
Marks start of a dynamic block.
uninstall()  : mixed

Constants

PAGE_DELETION_ATTEMPTS

public mixed PAGE_DELETION_ATTEMPTS = 2

PAGE_DELETION_LIMIT

public mixed PAGE_DELETION_LIMIT = 100

Methods

addDynamicData()

Adds dynamic data to be sent to the client.

public addDynamicData(string $id, string $content[, string $stub = "" ][, string $containerId = null ][, bool $useBrowserStorage = false ][, bool $autoUpdate = true ][, bool $useAnimation = false ]) : void
Parameters
$id : string

Unique identifier of the block.

$content : string

Dynamic part html.

$stub : string = ""

Html to use as stub.

$containerId : string = null

Identifier of the html container.

$useBrowserStorage : bool = false

Use browser storage for caching or not.

$autoUpdate : bool = true

Automatically or manually update block contents.

$useAnimation : bool = false

Animation flag.

deleteCompositeCookies()

Removes all composite cookies

public static deleteCompositeCookies() : mixed

finishDynamicWithID()

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

public finishDynamicWithID(string $id[, string $stub = "" ][, string $containerId = null ][, bool $useBrowserStorage = false ][, bool $autoUpdate = true ][, bool $useAnimation = false ]) : bool
Parameters
$id : string

Unique identifier of the block.

$stub : string = ""

Html to use as stub.

$containerId : string = null

Identifier of the html container.

$useBrowserStorage : bool = false

Use browser storage for caching or not.

$autoUpdate : bool = true

Automatically or manually update block contents.

$useAnimation : bool = false

Animation flag.

Return values
bool

getAutoUpdate()

Gets autoUpdate property

public static getAutoUpdate() : bool
Return values
bool

getAutoUpdateTTL()

Gets auto update ttl

public static getAutoUpdateTTL() : int
Return values
int

getCurrentDynamicId()

Returns the identifier of current dynamic area.

public getCurrentDynamicId() : string|false
Tags
see
StaticArea::getCurrentDynamicId
Return values
string|false

getDynamicIDs()

Gets ids of the dynamic blocks.

public getDynamicIDs() : array<string|int, mixed>
Return values
array<string|int, mixed>

getInstance()

Singleton instance.

public static getInstance() : Engine

just use static methods

Return values
Engine

getPreventAutoUpdate()

Gets preventAutoUpdate property.

public static getPreventAutoUpdate() : bool

use getAutoUpdate

Return values
bool

getUseAppCache()

Gets useAppCache property.

public static getUseAppCache() : bool
Return values
bool

getUseHTMLCache()

Gets useHTMLCache property.

public static getUseHTMLCache() : bool
Return values
bool

install()

public static install([mixed $setDefaults = true ]) : mixed
Parameters
$setDefaults : mixed = true

isAjaxRequest()

Returns true if current request was initiated by Ajax.

public static isAjaxRequest() : bool
Return values
bool

isBannerEnabled()

Returns true if we should inject banner into a page.

public static isBannerEnabled() : bool
Return values
bool

isCurrentUserCC()

public static isCurrentUserCC() : mixed

isEnabled()

Gets isEnabled property.

public static isEnabled() : bool
Return values
bool

isInvalidationRequest()

public static isInvalidationRequest() : mixed

isOn()

Returns true if composite mode is turned on

public static isOn() : bool
Return values
bool

isSelfHostedPortal()

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

public static isSelfHostedPortal() : bool
Return values
bool

onBeforeEndBufferContent()

OnBeforeEndBufferContent handler.

public static onBeforeEndBufferContent() : void

Prepares the stage for composite mode handler.

onBeforeLocalRedirect()

public static onBeforeLocalRedirect(mixed &$url, mixed $skip_security_check, mixed $isExternal) : mixed
Parameters
$url : mixed
$skip_security_check : mixed
$isExternal : mixed

onBeforeRestartBuffer()

OnBeforeRestartBuffer event handler.

public static onBeforeRestartBuffer() : void

Disables composite mode when called.

onUserLogin()

OnUserLogin Event Handler

public static onUserLogin() : mixed

onUserLogout()

OnUserLogout Event Handler

public static onUserLogout() : mixed

setAutoUpdate()

Sets autoUpdate property

public static setAutoUpdate(bool $flag) : void
Parameters
$flag : bool

setAutoUpdateTTL()

Sets auto update ttl

public static setAutoUpdateTTL(int $ttl) : void
Parameters
$ttl : int
  • number of seconds

setCC()

Sets CC cookie

public static setCC() : mixed

setEnable()

Sets isEnable property value and attaches needed handlers.

public static setEnable([bool $isEnabled = true ]) : void
Parameters
$isEnabled : bool = true

Mode control flag.

setNCC()

Sets NCC cookie

public static setNCC() : mixed

setPreventAutoUpdate()

Sets useHTMLCache property.

public static setPreventAutoUpdate([bool $preventAutoUpdate = true ]) : void

use setAutoUpdate

Parameters
$preventAutoUpdate : bool = true

property.

setUseAppCache()

Sets useAppCache property.

public static setUseAppCache([bool $useAppCache = true ]) : void
Parameters
$useAppCache : bool = true

AppCache mode control flag.

setUseHTMLCache()

Sets useHTMLCache property.

public static setUseHTMLCache([bool $useHTMLCache = true ]) : void
Parameters
$useHTMLCache : bool = true

Composite mode control flag.

startDynamicWithID()

Marks start of a dynamic block.

public startDynamicWithID(int $id) : bool
Parameters
$id : int

Unique identifier of the block.

Return values
bool

uninstall()

public static uninstall() : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results