All Data Structures Functions Variables Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions
WorkflowMessageInQueueJob Class Reference
Inheritance diagram for WorkflowMessageInQueueJob:
InQueueJob BaseJob

Public Member Functions

 run ()
 
- Public Member Functions inherited from BaseJob
 run ()
 
 getErrorMessage ()
 
 setMessageLogger (MessageLogger $messageLogger)
 
 getMessageLogger ()
 

Static Public Member Functions

static getDisplayName ()
 
static getType ()
 
static getRecommendedRunFrequencyContent ()
 
- Static Public Member Functions inherited from InQueueJob
static resolveJobsForQueue ()
 
static getModelsTResolveToJobQueue ($pageSize, $offset, $modelClassName, $timeStamp)
 
static jobExecutionInQueueDependsOnTime ()
 
- Static Public Member Functions inherited from BaseJob
static shouldLoadJobQueueOnCleanupAndFallback ()
 
static getDisplayName ()
 
static getType ()
 
static resolveJobsForQueue ()
 
static loadJobQueue ()
 
static getRecommendedRunFrequencyContent ()
 
static getDefaultMessageLogger ()
 
static getRunTimeThresholdInSeconds ()
 
static showInJobManagerToRunManually ()
 
static jobExecutionInQueueDependsOnTime ()
 

Protected Member Functions

 resolveModel (WorkflowMessageInQueue $workflowMessageInQueue)
 
 resolveSavedWorkflowIsValid (WorkflowMessageInQueue $workflowMessageInQueue)
 
 processWorkflowMessageInQueue (WorkflowMessageInQueue $workflowMessageInQueue, RedBeanModel $model)
 
- Protected Member Functions inherited from InQueueJob
 resolveBatchSize ()
 

Static Protected Member Functions

static resolveTriggeredByUser (WorkflowMessageInQueue $workflowMessageInQueue)
 

Additional Inherited Members

- Data Fields inherited from BaseJob
const JOB_QUEUE_PAGE_SIZE = 100
 
- Protected Attributes inherited from BaseJob
 $errorMessage
 
- Static Protected Attributes inherited from InQueueJob
static $loadJobQueueOnCleanupAndFallback = true
 
- Static Protected Attributes inherited from BaseJob
static $loadJobQueueOnCleanupAndFallback = false
 

Detailed Description

A job for processing workflow messages that are not sent immediately when triggered

Definition at line 40 of file WorkflowMessageInQueueJob.php.

Member Function Documentation

static getDisplayName ( )
static
Returns
Translated label that describes this job type.

Definition at line 45 of file WorkflowMessageInQueueJob.php.

static getType ( )
static
Returns
The type of the NotificationRules

Definition at line 53 of file WorkflowMessageInQueueJob.php.

run ( )
See Also
BaseJob::run()

Definition at line 66 of file WorkflowMessageInQueueJob.php.

resolveModel ( WorkflowMessageInQueue  $workflowMessageInQueue)
protected
Parameters
WorkflowMessageInQueue$workflowMessageInQueue
Returns
RedBeanModel

Definition at line 119 of file WorkflowMessageInQueueJob.php.

resolveSavedWorkflowIsValid ( WorkflowMessageInQueue  $workflowMessageInQueue)
protected
Parameters
WorkflowMessageInQueue$workflowMessageInQueue
Exceptions
NotFoundException

Definition at line 129 of file WorkflowMessageInQueueJob.php.

processWorkflowMessageInQueue ( WorkflowMessageInQueue  $workflowMessageInQueue,
RedBeanModel  $model 
)
protected
Parameters
WorkflowMessageInQueue$workflowMessageInQueue
RedBeanModel$model

Definition at line 141 of file WorkflowMessageInQueueJob.php.

static resolveTriggeredByUser ( WorkflowMessageInQueue  $workflowMessageInQueue)
staticprotected
Parameters
WorkflowMessageInQueue$workflowMessageInQueue
Returns
User

Definition at line 158 of file WorkflowMessageInQueueJob.php.


The documentation for this class was generated from the following file:
Generated on Mon Jun 1 2020 07:11:10