\pm_Scheduler

Manager of regular tasks for module.

Summary

Methods
Properties
Constants
__construct()
getInstance()
resetInstance()
listTasks()
getTaskById()
putTask()
removeTask()
removeAllTasks()
enableTask()
disableTask()
$EVERY_MIN
$EVERY_5_MIN
$EVERY_10_MIN
$EVERY_HOUR
$EVERY_DAY
$EVERY_WEEK
$EVERY_MONTH
No constants found
No protected methods found
No protected properties found
N/A

Properties

$EVERY_MIN

$EVERY_MIN : 

Type

$EVERY_5_MIN

$EVERY_5_MIN : 

Type

$EVERY_10_MIN

$EVERY_10_MIN : 

Type

$EVERY_HOUR

$EVERY_HOUR : 

Type

$EVERY_DAY

$EVERY_DAY : 

Type

$EVERY_WEEK

$EVERY_WEEK : 

Type

$EVERY_MONTH

$EVERY_MONTH : 

Type

Methods

__construct()

__construct() 

Create new manager of regular tasks

getInstance()

getInstance() : \pm_Scheduler

Get instance of pm_Scheduler

Returns

\pm_Scheduler

resetInstance()

resetInstance() 

Reset the singleton instance

listTasks()

listTasks() : array<mixed,\pm_Scheduler_Task>

List all tasks of current module

Returns

array<mixed,\pm_Scheduler_Task>

getTaskById()

getTaskById(string  $taskId) : \pm_Scheduler_Task

Return task by its id

Parameters

string $taskId

Returns

\pm_Scheduler_Task

putTask()

putTask(\pm_Scheduler_Task  $task) 

Update or add new task to scheduler

Parameters

\pm_Scheduler_Task $task

Throws

\pm_Exception

When task with the same parameters, but no ID assigned already exists in the database

removeTask()

removeTask(\pm_Scheduler_Task  $task) 

Remove task from scheduler

Parameters

\pm_Scheduler_Task $task

Throws

\pm_Exception

removeAllTasks()

removeAllTasks() 

Remove all tasks of current module

enableTask()

enableTask(\pm_Scheduler_Task  $task) 

Enable task

Parameters

\pm_Scheduler_Task $task

Throws

\pm_Exception

disableTask()

disableTask(\pm_Scheduler_Task  $task) 

Disable task

Parameters

\pm_Scheduler_Task $task

Throws

\pm_Exception