1C-Bitrix 25.700.0
Загрузка...
Поиск...
Не найдено
Класс Engine

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

 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 строка 26

Методы

◆ addDynamicData()

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

Adds dynamic data to be sent to the client.

Аргументы
string$idUnique identifier of the block.
string$contentDynamic part html.
string$stubHtml to use as stub.
string$containerIdIdentifier of the html container.
boolean$useBrowserStorageUse browser storage for caching or not.
boolean$autoUpdateAutomatically or manually update block contents.
boolean$useAnimationAnimation flag.
Возвращает
void

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

◆ checkAdminPanel()

checkAdminPanel ( )
static

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

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

◆ deleteCompositeCookies()

deleteCompositeCookies ( )
static

Removes all composite cookies

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

◆ endBuffering()

endBuffering ( & $originalContent,
$compositeContent )
static

Returns true if $originalContent was modified

Аргументы
$originalContent
$compositeContent
Возвращает
bool

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

◆ 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$idUnique identifier of the block.
string$stubHtml to use as stub.
string$containerIdIdentifier of the html container.
boolean$useBrowserStorageUse browser storage for caching or not.
boolean$autoUpdateAutomatically or manually update block contents.
boolean$useAnimationAnimation flag.
Возвращает
boolean

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

◆ getAutoUpdate()

getAutoUpdate ( )
static

Gets autoUpdate property

Возвращает
bool

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

◆ getAutoUpdateTTL()

getAutoUpdateTTL ( )
static

Gets auto update ttl

Возвращает
int

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

◆ getCurrentDynamicId()

getCurrentDynamicId ( )

Returns the identifier of current dynamic area.

См. также
\Bitrix\Main\Composite\StaticArea::getCurrentDynamicId
Возвращает
string|false

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

◆ getDynamicIDs()

getDynamicIDs ( )

Gets ids of the dynamic blocks.

Возвращает
array

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

◆ getInjectedCSS()

getInjectedCSS ( )
static

Returns css string to be injected.

@noinspection CssUnknownTarget

@noinspection CssUnusedSymbol

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

◆ getInstance()

getInstance ( )
static

Singleton instance.

Возвращает
Engine

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

◆ getPreventAutoUpdate()

getPreventAutoUpdate ( )
static

Gets preventAutoUpdate property.

Возвращает
boolean

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

◆ getUseAppCache()

getUseAppCache ( )
static

Gets useAppCache property.

Возвращает
boolean

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

◆ getUseHTMLCache()

getUseHTMLCache ( )
static

Gets useHTMLCache property.

Возвращает
boolean

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

◆ install()

install ( $setDefaults = true)
static

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

◆ isAjaxRequest()

isAjaxRequest ( )
static

Returns true if current request was initiated by Ajax.

Возвращает
boolean

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

◆ isBannerEnabled()

isBannerEnabled ( )
static

Returns true if we should inject banner into a page.

Возвращает
bool

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

◆ isCurrentUserCC()

isCurrentUserCC ( )
static

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

◆ isEnabled()

isEnabled ( )
static

Gets isEnabled property.

Возвращает
boolean

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

◆ isInvalidationRequest()

isInvalidationRequest ( )
static

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

◆ isOn()

isOn ( )
static

Returns true if composite mode is turned on

Возвращает
bool

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

◆ isSelfHostedPortal()

isSelfHostedPortal ( )
static

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

Возвращает
bool

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

◆ onBeforeEndBufferContent()

onBeforeEndBufferContent ( )
static

OnBeforeEndBufferContent handler. Prepares the stage for composite mode handler.

Возвращает
void

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

◆ onBeforeLocalRedirect()

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

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

◆ onBeforeRestartBuffer()

onBeforeRestartBuffer ( )
static

OnBeforeRestartBuffer event handler. Disables composite mode when called.

Возвращает
void

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

◆ onChangeFile()

onChangeFile ( $path,
$site )
static

OnChangeFile Event Handler

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

◆ onEpilog()

onEpilog ( )
static

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

◆ onUserLogin()

onUserLogin ( )
static

OnUserLogin Event Handler

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

◆ onUserLogout()

onUserLogout ( )
static

OnUserLogout Event Handler

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

◆ setAutoUpdate()

setAutoUpdate ( $flag)
static

Sets autoUpdate property

Аргументы
bool$flag
Возвращает
void

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

◆ setAutoUpdateTTL()

setAutoUpdateTTL ( $ttl)
static

Sets auto update ttl

Аргументы
int$ttl- number of seconds
Возвращает
void

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

◆ setCC()

setCC ( )
static

Sets CC cookie

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

◆ setEnable()

setEnable ( $isEnabled = true)
static

Sets isEnable property value and attaches needed handlers.

Аргументы
bool$isEnabledMode control flag.
Возвращает
void

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

◆ setNCC()

setNCC ( )
static

Sets NCC cookie

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

◆ setPreventAutoUpdate()

setPreventAutoUpdate ( $preventAutoUpdate = true)
static

Sets useHTMLCache property.

Аргументы
boolean$preventAutoUpdateproperty.
Возвращает
void

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

◆ setUseAppCache()

setUseAppCache ( $useAppCache = true)
static

Sets useAppCache property.

Аргументы
boolean$useAppCacheAppCache mode control flag.
Возвращает
void

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

◆ setUseHTMLCache()

setUseHTMLCache ( $useHTMLCache = true)
static

Sets useHTMLCache property.

Аргументы
boolean$useHTMLCacheComposite mode control flag.
Возвращает
void

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

◆ shouldBeEnabled()

shouldBeEnabled ( )
static

Checks whether HTML Cache should be enabled.

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

◆ startBuffering()

startBuffering ( $content)
static
Аргументы
$content
Возвращает
null|string

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

◆ startDynamicWithID()

startDynamicWithID ( $id)

Marks start of a dynamic block.

Аргументы
integer$idUnique identifier of the block.
Возвращает
boolean

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

◆ uninstall()

uninstall ( )
static

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

Поля

◆ PAGE_DELETION_ATTEMPTS

const PAGE_DELETION_ATTEMPTS = 2

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

◆ PAGE_DELETION_LIMIT

const PAGE_DELETION_LIMIT = 100

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

Объявления и описания членов класса находятся в файле: