ByTimeWorkflowInQueue Class Reference

Inheritance diagram for ByTimeWorkflowInQueue:
Item CustomFieldsModel RedBeanModel BeanModel ObservableComponent ByTimeWorkflowInQueueForTest

Static Public Member Functions

static canSaveMetadata ()
static getDefaultMetadata ()
static isTypeDeletable ()
static getModuleClassName ()
static resolveByWorkflowIdAndModel (SavedWorkflow $savedWorkflow, RedBeanModel $model)
static getModelsToProcess ($pageSize)

Protected Member Functions

 afterSave ()

Static Protected Member Functions

static getLabel ($language=null)
static getPluralLabel ($language=null)

Detailed Description

Class used to manage by-time workflow rules that need to be processed in the future.

See also:
ByTimeWorkflowInQueueJob which will process expired models and determine if actions or email messages need to be sent out. Expired refers to if the processDateTime is in the past.

Definition at line 42 of file ByTimeWorkflowInQueue.php.


Member Function Documentation

static canSaveMetadata (  )  [static]
Returns:
bool

Reimplemented from RedBeanModel.

Definition at line 47 of file ByTimeWorkflowInQueue.php.

static getDefaultMetadata (  )  [static]
Returns:
array

Reimplemented from Item.

Reimplemented in ByTimeWorkflowInQueueForTest.

Definition at line 55 of file ByTimeWorkflowInQueue.php.

static isTypeDeletable (  )  [static]
Returns:
bool

Reimplemented from Item.

Definition at line 88 of file ByTimeWorkflowInQueue.php.

static getLabel ( language = null  )  [static, protected]

Returns the display name for the model class.

Parameters:
null}string $language
Returns:
dynamic label name based on module.

Reimplemented from RedBeanModel.

Definition at line 98 of file ByTimeWorkflowInQueue.php.

static getPluralLabel ( language = null  )  [static, protected]

Returns the display name for plural of the model class.

Parameters:
null}string $language
Returns:
dynamic label name based on module.

Reimplemented from RedBeanModel.

Definition at line 108 of file ByTimeWorkflowInQueue.php.

static getModuleClassName (  )  [static]
Returns:
null|string

Reimplemented from RedBeanModel.

Definition at line 116 of file ByTimeWorkflowInQueue.php.

static resolveByWorkflowIdAndModel ( SavedWorkflow savedWorkflow,
RedBeanModel model 
) [static]
Parameters:
SavedWorkflow $savedWorkflow
RedBeanModel $model
Returns:
ByTimeWorkflowInQueue
Exceptions:
NotSupportedException 

Definition at line 127 of file ByTimeWorkflowInQueue.php.

static getModelsToProcess ( pageSize  )  [static]
Parameters:
$pageSize 
Returns:
array of ByTimeWorkflowInQueue models

Definition at line 174 of file ByTimeWorkflowInQueue.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Sun May 28 07:10:23 2017