Bitrix API

BufferArea extends StaticArea

Table of Contents

Methods

__construct()  : mixed
addDynamicArea()  : mixed
applyCachedData()  : StaticArea
Apply previously saved state.
begin()  : BufferArea
Starts an dynamic frame.
beginStub()  : BufferArea
Starts static part of dynamic frame which will be shown to user.
end()  : BufferArea
Ends dynamic part of the content.
finishDynamicArea()  : mixed
getAnimation()  : mixed
getAssetId()  : mixed
getAssetMode()  : mixed
getAutoUpdate()  : mixed
getBrowserStorage()  : mixed
getCachedData()  : array<string|int, mixed>
Returns internal state of the object for storing in cache.
getContainerId()  : mixed
getContainers()  : mixed
getCurrentDynamicArea()  : StaticArea
getCurrentDynamicId()  : mixed
getDynamicArea()  : StaticArea
getDynamicAreas()  : array<string|int, StaticArea>
getDynamicIDs()  : array<string|int, array<string|int, mixed>>
getId()  : mixed
getStub()  : mixed
isEnded()  : bool
Returns true if Frame was ended.
isStarted()  : bool
Returns true if Frame was started.
setAnimation()  : mixed
setAssetMode()  : mixed
setAutoUpdate()  : mixed
setBrowserStorage()  : mixed
setContainerId()  : mixed
setStub()  : mixed
startDynamicArea()  : mixed

Methods

__construct()

public __construct(mixed $id[, bool $autoContainer = true ]) : mixed
Parameters
$id : mixed
$autoContainer : bool = true

applyCachedData()

Apply previously saved state.

public static applyCachedData(mixed $cachedData) : StaticArea
Parameters
$cachedData : mixed
Return values
StaticArea

begin()

Starts an dynamic frame.

public begin([null|string $stub = null ]) : BufferArea

Returns self object instance.

Parameters
$stub : null|string = null
Tags
see
BufferArea
see
BufferArea::end
throws
NotSupportedException
Return values
BufferArea

beginStub()

Starts static part of dynamic frame which will be shown to user.

public beginStub() : BufferArea

Method begin() must be called before. Returns self object instance.

Tags
see
BufferArea
see
BufferArea::begin
throws
NotSupportedException
Return values
BufferArea

end()

Ends dynamic part of the content.

public end() : BufferArea

Method begin() must be called before. Returns self object instance.

Tags
see
BufferArea
see
BufferArea::begin
throws
NotSupportedException
Return values
BufferArea

finishDynamicArea()

public finishDynamicArea() : mixed

getBrowserStorage()

public getBrowserStorage() : mixed

getCachedData()

Returns internal state of the object for storing in cache.

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

getContainerId()

public getContainerId() : mixed

getContainers()

public static getContainers() : mixed

getCurrentDynamicId()

public static getCurrentDynamicId() : mixed

getDynamicIDs()

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

isEnded()

Returns true if Frame was ended.

public isEnded() : bool
Return values
bool

isStarted()

Returns true if Frame was started.

public isStarted() : bool
Return values
bool

setAnimation()

public setAnimation(mixed $useAnimation) : mixed
Parameters
$useAnimation : mixed

setAutoUpdate()

public setAutoUpdate(mixed $autoUpdate) : mixed
Parameters
$autoUpdate : mixed

setBrowserStorage()

public setBrowserStorage(mixed $useBrowserStorage) : mixed
Parameters
$useBrowserStorage : mixed

setContainerId()

public setContainerId(mixed $containerId) : mixed
Parameters
$containerId : mixed

setStub()

public setStub(mixed $stub) : mixed
Parameters
$stub : mixed

startDynamicArea()

public startDynamicArea() : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results