Documentation

TaskHandler
in package

Table of Contents

$cancelled  : bool
$delay  : int
$nextRun  : int
$period  : int
$task  : Task
$ownerName  : string
$taskName  : string
$timings  : TimingsHandler
__construct()  : mixed
cancel()  : void
getDelay()  : int
getNextRun()  : int
getOwnerName()  : string
getPeriod()  : int
getTask()  : Task
getTaskName()  : string
isCancelled()  : bool
isDelayed()  : bool
isRepeating()  : bool
remove()  : void
run()  : void
setNextRun()  : void

Properties

Methods

__construct()

public __construct(Task $task[, int $delay = -1 ][, int $period = -1 ][, string|null $ownerName = null ]) : mixed
Parameters
$task : Task
$delay : int = -1
$period : int = -1
$ownerName : string|null = null
Return values
mixed —

cancel()

public cancel() : void
Return values
void —

getDelay()

public getDelay() : int
Return values
int —

getNextRun()

public getNextRun() : int
Return values
int —

getOwnerName()

public getOwnerName() : string
Return values
string —

getPeriod()

public getPeriod() : int
Return values
int —

getTaskName()

public getTaskName() : string
Return values
string —

isCancelled()

public isCancelled() : bool
Return values
bool —

isDelayed()

public isDelayed() : bool
Return values
bool —

isRepeating()

public isRepeating() : bool
Return values
bool —

remove()

public remove() : void
Return values
void —

setNextRun()

public setNextRun(int $ticks) : void
Parameters
$ticks : int
Return values
void —

Search results