JobQueue Class Reference

Public Member Functions

 add ($jobType, $delay=0)
 getAll ()
 deleteAll ()
 processAll ()
 isEnabled ()
 getQueueJobLabel ()
 getQueueJobAgainLabel ()
 processByJobTypeAndDelay ($jobType, $delay, MessageLogger $messageLogger)
 resolveToAddJobTypeByModelByDateTimeAttribute (RedBeanModel $model, $attributeName, $jobType)

Protected Attributes

 $queuedJobs = array()

Detailed Description

Helper class for managing job queues. Override as needed.

Definition at line 40 of file JobQueue.php.


Member Function Documentation

add ( jobType,
delay = 0 
)
Parameters:
string $jobType
int $delay - seconds to delay job

Definition at line 48 of file JobQueue.php.

processAll (  ) 

Override if there is processing to complete. see

Definition at line 71 of file JobQueue.php.

isEnabled (  ) 

Override and toggle as needed.

Returns:
bool

Definition at line 79 of file JobQueue.php.

resolveToAddJobTypeByModelByDateTimeAttribute ( RedBeanModel model,
attributeName,
jobType 
)

For a given model, and dateTime attribute, resolve to add a job by the job type. The delay is calculated based on the value of the dateTime attribute

Parameters:
RedBeanModel $model
$attributeName 
$jobType 

Definition at line 105 of file JobQueue.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Thu Apr 27 07:10:26 2017