VTTaskQueue
in package
Time based Queue of tasks ready for execution.
Table of Contents
- getReadyTasks() : A
- Get a list of taskId/entityId pairs ready for execution.
- queueTask() : mixed
- Queue a task for execution.
Methods
getReadyTasks()
Get a list of taskId/entityId pairs ready for execution.
public
getReadyTasks() : A
The method fetches task id/entity id where the when timestamp is less than the current time when the method was called.
Return values
A —list of pairs of the form array(taskId, entityId)
queueTask()
Queue a task for execution.
public
queueTask( $taskId, $entityId, $when[, mixed $taskContents = '' ]) : mixed
Parameters
- $taskId :
-
The id of the task to queue
- $entityId :
-
The id of the crm entity the task is assiciated with
- $when :
-
The time after which the task should be executed. This is an optional value with a default value of 0
- $taskContents : mixed = ''