Bitrix API

Cleaner extends Base

Table of Contents

Constants

ERR_ALREADY_RUNNING  = 10
ERR_NOT_RUNNING  = 20
ERR_NOT_STOPPED  = 30
ERR_SUCCESS  = 0
STATUS_FINISHED  = 70
STATUS_INACTIVE  = 10
STATUS_PENDING_CONTINUE  = 60
STATUS_PENDING_START  = 20
STATUS_PENDING_STOP  = 40
STATUS_RUNNING  = 30
STATUS_STOPPED  = 50
STATUS_UNDEFINED  = 0

Methods

continue()  : Result
delete()  : Result
getInstance()  : Cleaner
getStatusCode()  : string
isActive()  : bool
isReadyToStart()  : bool
run()  : string
start()  : Result
state()  : Result
stop()  : Result

Constants

ERR_ALREADY_RUNNING

public mixed ERR_ALREADY_RUNNING = 10

ERR_NOT_RUNNING

public mixed ERR_NOT_RUNNING = 20

ERR_NOT_STOPPED

public mixed ERR_NOT_STOPPED = 30

ERR_SUCCESS

public mixed ERR_SUCCESS = 0

STATUS_FINISHED

public mixed STATUS_FINISHED = 70

STATUS_INACTIVE

public mixed STATUS_INACTIVE = 10

STATUS_PENDING_CONTINUE

public mixed STATUS_PENDING_CONTINUE = 60

STATUS_PENDING_START

public mixed STATUS_PENDING_START = 20

STATUS_PENDING_STOP

public mixed STATUS_PENDING_STOP = 40

STATUS_RUNNING

public mixed STATUS_RUNNING = 30

STATUS_STOPPED

public mixed STATUS_STOPPED = 50

STATUS_UNDEFINED

public mixed STATUS_UNDEFINED = 0

Methods

continue()

public continue() : Result
Return values
Result

delete()

public delete() : Result
Return values
Result

getStatusCode()

public getStatusCode(int $id) : string
Parameters
$id : int
Return values
string

isActive()

public isActive() : bool
Return values
bool

isReadyToStart()

public isReadyToStart() : bool
Return values
bool

run()

public static run() : string
Return values
string

start()

public start(array<string|int, mixed> $params) : Result
Parameters
$params : array<string|int, mixed>
Return values
Result

state()

public state() : Result
Return values
Result

stop()

public stop() : Result
Return values
Result

        
On this page

Search results