Bitrix API

Process

AbstractYes

Table of Contents

Constants

CALLBACK_TYPE_MANUAL  = 'manual'
CALLBACK_TYPE_QUOTA  = 'quota'
DEBUG_FILE  = '%SESSION_KEY%_process.txt'
DEBUG_FOLDER  = '%BX_ROOT%/tmp/'
DEBUG_MODE  = false
JUST_SHOW_STAGES  = false
LOCK_FILE  = '%SESSION_KEY%_lock'
MIN_TIME_LIMIT  = 5

Methods

__construct()  : mixed
addStage()  : mixed
calcSubPercent()  : mixed
checkProcessLocked()  : mixed
checkQuota()  : mixed
clearLogFile()  : mixed
getCurrentPercentRange()  : mixed
getCurrStageIndex()  : mixed
getCurrStageStepSize()  : mixed
getData()  : mixed
getLockFilePath()  : mixed
getLogFileDir()  : mixed
getLogFilePath()  : mixed
getMemoryPeak()  : mixed
getPercent()  : mixed
getPercentBetween()  : mixed
getPercentFromToCurrent()  : mixed
getStage()  : mixed
getStageCode()  : mixed
getStagePercent()  : mixed
getStep()  : mixed
getSubPercentByTotalAndDone()  : mixed
isStage()  : mixed
lockProcess()  : mixed
logFinalResult()  : mixed
logMemoryUsage()  : mixed
logMessage()  : mixed
nextStage()  : mixed
nextStep()  : mixed
onAfterPerformIteration()  : mixed
onBeforePerformIteration()  : mixed
performIteration()  : mixed
performStage()  : mixed
reset()  : mixed
restore()  : mixed
setStage()  : mixed
setStepSize()  : mixed
setTimeLimit()  : mixed
stageGT()  : mixed
stageLT()  : mixed
unLockProcess()  : mixed

Constants

CALLBACK_TYPE_MANUAL

public mixed CALLBACK_TYPE_MANUAL = 'manual'

CALLBACK_TYPE_QUOTA

public mixed CALLBACK_TYPE_QUOTA = 'quota'

DEBUG_FILE

public mixed DEBUG_FILE = '%SESSION_KEY%_process.txt'

DEBUG_FOLDER

public mixed DEBUG_FOLDER = '%BX_ROOT%/tmp/'

DEBUG_MODE

public mixed DEBUG_MODE = false

JUST_SHOW_STAGES

public mixed JUST_SHOW_STAGES = false

LOCK_FILE

public mixed LOCK_FILE = '%SESSION_KEY%_lock'

MIN_TIME_LIMIT

public mixed MIN_TIME_LIMIT = 5

Methods

__construct()

public __construct([mixed $options = array() ]) : mixed
Parameters
$options : mixed = array()

addStage()

public addStage(mixed $params) : mixed
Parameters
$params : mixed

calcSubPercent()

public calcSubPercent(mixed $range) : mixed
Parameters
$range : mixed

checkProcessLocked()

public checkProcessLocked() : mixed

checkQuota()

public checkQuota() : mixed

clearLogFile()

public clearLogFile() : mixed

getCurrentPercentRange()

public getCurrentPercentRange() : mixed

getCurrStageIndex()

public getCurrStageIndex() : mixed

getCurrStageStepSize()

public getCurrStageStepSize() : mixed

getLockFilePath()

public getLockFilePath() : mixed

getLogFileDir()

public getLogFileDir() : mixed

getLogFilePath()

public getLogFilePath() : mixed

getMemoryPeak()

public getMemoryPeak() : mixed

getPercent()

public getPercent() : mixed

getPercentBetween()

public getPercentBetween(mixed $codeFrom, mixed $codeTo) : mixed
Parameters
$codeFrom : mixed
$codeTo : mixed

getPercentFromToCurrent()

public getPercentFromToCurrent(mixed $codeFrom) : mixed
Parameters
$codeFrom : mixed

getStage()

public getStage(mixed $code) : mixed
Parameters
$code : mixed

getStageCode()

public getStageCode() : mixed

getStagePercent()

public getStagePercent([mixed $sNum = false ]) : mixed
Parameters
$sNum : mixed = false

getSubPercentByTotalAndDone()

public getSubPercentByTotalAndDone(mixed $total[, mixed $done = 0 ]) : mixed
Parameters
$total : mixed
$done : mixed = 0

isStage()

public isStage(mixed $code) : mixed
Parameters
$code : mixed

lockProcess()

public lockProcess() : mixed

logFinalResult()

public logFinalResult() : mixed

logMemoryUsage()

public logMemoryUsage() : mixed

logMessage()

public logMessage([mixed $message = '' ][, mixed $addTimeStamp = true ]) : mixed
Parameters
$message : mixed = ''
$addTimeStamp : mixed = true

nextStage()

public nextStage() : mixed

nextStep()

public nextStep() : mixed

onAfterPerformIteration()

public onAfterPerformIteration() : mixed

onBeforePerformIteration()

public onBeforePerformIteration() : mixed

performIteration()

public performIteration() : mixed

performStage()

public performStage() : mixed

setStage()

public setStage(mixed $stage) : mixed
Parameters
$stage : mixed

setStepSize()

public setStepSize(mixed $code, mixed $stepSize) : mixed
Parameters
$code : mixed
$stepSize : mixed

setTimeLimit()

public setTimeLimit(mixed $timeLimit) : mixed
Parameters
$timeLimit : mixed

stageGT()

public stageGT(mixed $code) : mixed
Parameters
$code : mixed

stageLT()

public stageLT(mixed $code) : mixed
Parameters
$code : mixed

unLockProcess()

public unLockProcess() : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results