Bitrix API

Journal

Class Journal Work with statistic of exports: time of start end finish of export, count of processed items

Table of Contents

Methods

__construct()  : mixed
Journal constructor.
addItemsCount()  : bool
Increase number of processed items for current type of export.
checkStopProcessFlag()  : mixed
clearStopProcessParams()  : bool
Remove process STOP flag
end()  : bool
Close log for current type by set finish time
getCriticalErrorsMessage()  : mixed
getCurrentProcess()  : mixed
getProgressFinishMessage()  : mixed
getProgressMessage()  : mixed
getStatisticText()  : bool|string
Get formatted string of statistic to selected type and export ID
getTooMuchTimeExportMessage()  : mixed
saveProcessParams()  : mixed
start()  : bool
Init log for current export type and set starting time.
stopProcessParams()  : bool
set flag STOP in params - preserve repeated process run

Methods

__construct()

Journal constructor.

public __construct(mixed $exportId, mixed $type) : mixed
Parameters
$exportId : mixed
  • int, ID of export profile
$type : mixed
  • string, type of current journal. May be ALBUMS or PRODUCTS.

addItemsCount()

Increase number of processed items for current type of export.

public addItemsCount(mixed $count) : bool
Parameters
$count : mixed
Tags
throws
Exception
Return values
bool

checkStopProcessFlag()

public static checkStopProcessFlag(mixed $exportId) : mixed
Parameters
$exportId : mixed

clearStopProcessParams()

Remove process STOP flag

public static clearStopProcessParams(mixed $exportId) : bool
Parameters
$exportId : mixed
Return values
bool

end()

Close log for current type by set finish time

public end() : bool
Tags
throws
Exception
Return values
bool

getCriticalErrorsMessage()

public static getCriticalErrorsMessage(mixed $exportId, mixed $txt) : mixed
Parameters
$exportId : mixed
$txt : mixed

getCurrentProcess()

public static getCurrentProcess(mixed $exportId) : mixed
Parameters
$exportId : mixed

getProgressFinishMessage()

public static getProgressFinishMessage([mixed $ok = true ]) : mixed
Parameters
$ok : mixed = true

getProgressMessage()

public static getProgressMessage(mixed $exportId, mixed $type) : mixed
Parameters
$exportId : mixed
$type : mixed

getStatisticText()

Get formatted string of statistic to selected type and export ID

public static getStatisticText(mixed $type, mixed $exportId) : bool|string
Parameters
$type : mixed
$exportId : mixed
Tags
throws
ArgumentException
Return values
bool|string

getTooMuchTimeExportMessage()

public static getTooMuchTimeExportMessage() : mixed

saveProcessParams()

public static saveProcessParams(mixed $exportId[, mixed $type = false ][, mixed $position = false ][, mixed $execCount = false ]) : mixed
Parameters
$exportId : mixed
$type : mixed = false
$position : mixed = false
$execCount : mixed = false

start()

Init log for current export type and set starting time.

public start() : bool
Tags
throws
Exception
Return values
bool

stopProcessParams()

set flag STOP in params - preserve repeated process run

public static stopProcessParams(mixed $exportId) : bool
Parameters
$exportId : mixed
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results