All Data Structures Functions Variables Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions
ByTimeWorkflowInQueueJob Class Reference
Inheritance diagram for ByTimeWorkflowInQueueJob:
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 (ByTimeWorkflowInQueue $byTimeWorkflowInQueue)
 
 resolveSavedWorkflowIsValid (ByTimeWorkflowInQueue $byTimeWorkflowInQueue)
 
 processByTimeWorkflowInQueue (ByTimeWorkflowInQueue $byTimeWorkflowInQueue, RedBeanModel $model)
 
- Protected Member Functions inherited from InQueueJob
 resolveBatchSize ()
 

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 expired By-Time workflow objects

Definition at line 40 of file ByTimeWorkflowInQueueJob.php.

Member Function Documentation

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

Definition at line 45 of file ByTimeWorkflowInQueueJob.php.

static getType ( )
static
Returns
The type of the NotificationRules

Definition at line 53 of file ByTimeWorkflowInQueueJob.php.

run ( )
See Also
BaseJob::run()

Definition at line 66 of file ByTimeWorkflowInQueueJob.php.

resolveModel ( ByTimeWorkflowInQueue  $byTimeWorkflowInQueue)
protected
Parameters
ByTimeWorkflowInQueue$byTimeWorkflowInQueue
Returns
RedBeanModel

Definition at line 121 of file ByTimeWorkflowInQueueJob.php.

resolveSavedWorkflowIsValid ( ByTimeWorkflowInQueue  $byTimeWorkflowInQueue)
protected
Parameters
ByTimeWorkflowInQueue$byTimeWorkflowInQueue
Exceptions
NotFoundException

Definition at line 131 of file ByTimeWorkflowInQueueJob.php.

processByTimeWorkflowInQueue ( ByTimeWorkflowInQueue  $byTimeWorkflowInQueue,
RedBeanModel  $model 
)
protected
Parameters
ByTimeWorkflowInQueue$byTimeWorkflowInQueue
RedBeanModel$model
Exceptions
FailedToSaveModelException

Definition at line 144 of file ByTimeWorkflowInQueueJob.php.


The documentation for this class was generated from the following file:
Generated on Wed Jun 3 2020 07:10:41