Bitrix API

IVolumeClear

Table of Contents

Methods

canClearEntity()  : bool
Returns availability to drop entity.
clearEntity()  : int
Performs dropping entity.
countEntity()  : int
Returns count of entities.
getDroppedEntityCount()  : int
Returns dropped count of entities.
getErrors()  : array<string|int, Error>
Getting array of errors.
getFailCount()  : int
Returns error count.
getLastError()  : Error|null
Returns errors list.
getProcessOffset()  : int
Returns process offset.
hasErrors()  : bool
Has errors.
hasTimeLimitReached()  : bool
Tells true if time limit reached.
incrementDroppedEntityCount()  : void
Returns dropped count of entities.
incrementFailCount()  : void
Returns error count.
setDroppedEntityCount()  : void
Sets dropped count of entities.
setFailCount()  : void
Sets error count.
setProcessOffset()  : void
Setup process offset.
startTimer()  : void
Start up timer.

Methods

canClearEntity()

Returns availability to drop entity.

public canClearEntity() : bool
Return values
bool

clearEntity()

Performs dropping entity.

public clearEntity() : int
Return values
int

countEntity()

Returns count of entities.

public countEntity() : int
Return values
int

getDroppedEntityCount()

Returns dropped count of entities.

public getDroppedEntityCount() : int
Return values
int

getErrors()

Getting array of errors.

public getErrors() : array<string|int, Error>
Return values
array<string|int, Error>

getFailCount()

Returns error count.

public getFailCount() : int
Tags
@implements

Crm\Volume\IVolumeClear

Return values
int

getLastError()

Returns errors list.

public getLastError() : Error|null
Tags
@implements

Crm\Volume\IVolumeClear

Return values
Error|null

getProcessOffset()

Returns process offset.

public getProcessOffset() : int
Return values
int

hasErrors()

Has errors.

public hasErrors() : bool
Return values
bool

hasTimeLimitReached()

Tells true if time limit reached.

public hasTimeLimitReached() : bool
Return values
bool

incrementDroppedEntityCount()

Returns dropped count of entities.

public incrementDroppedEntityCount(int $count) : void
Parameters
$count : int

Amount to increment.

incrementFailCount()

Returns error count.

public incrementFailCount([int $count = 1 ]) : void
Parameters
$count : int = 1

Amount to increment.

Tags
@implements

Crm\Volume\IVolumeClearEvent

setDroppedEntityCount()

Sets dropped count of entities.

public setDroppedEntityCount(int $count) : void
Parameters
$count : int

Amount to set.

setFailCount()

Sets error count.

public setFailCount(int $count) : void
Parameters
$count : int

Amount to set.

Tags
@implements

Crm\Volume\IVolumeClear

setProcessOffset()

Setup process offset.

public setProcessOffset(int $offset) : void
Parameters
$offset : int

Offset position.

startTimer()

Start up timer.

public startTimer([int $timeLimit = 25 ]) : void
Parameters
$timeLimit : int = 25

Time limit.


        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results