SavedWorkflowsUtil Class Reference

Static Public Member Functions

static resolveSearchAttributeDataByModuleClassNames ($searchAttributeData, $moduleClassNames)
static resolveOrder (SavedWorkflow $savedWorkflow, $isBeingCopied=false)
static resolveBeforeSaveByModel (Item $model, User $triggeredByUser)
static resolveAfterSaveByModel (Item $model, User $triggeredByUser)
static resolveProcessDateTimeByWorkflowAndModel (Workflow $workflow, RedBeanModel $model)

Static Protected Member Functions

static resolveTimeStampForDateAttributeForProcessDateTime (TimeTriggerForWorkflowForm $trigger, RedBeanModel $model)
static resolveTimeStampForDateTimeAttributeForProcessDateTime (TimeTriggerForWorkflowForm $trigger, RedBeanModel $model)
static resolveModelValueByTimeTrigger (TimeTriggerForWorkflowForm $trigger, RedBeanModel $model)
static processToByTimeWorkflowInQueue (Workflow $workflow, RedBeanModel $model)

Detailed Description

Helper class for working with SavedWorkflow objects

Definition at line 40 of file SavedWorkflowsUtil.php.


Member Function Documentation

static resolveSearchAttributeDataByModuleClassNames ( searchAttributeData,
moduleClassNames 
) [static]

Given an array of moduleClassNames, construct the searchAttributeData

Parameters:
$searchAttributeData 
$moduleClassNames 
Returns:
array

Definition at line 48 of file SavedWorkflowsUtil.php.

static resolveOrder ( SavedWorkflow savedWorkflow,
isBeingCopied = false 
) [static]

Resolve the correct order for a savedWorkflow. If it is a new savedWorkflow then set the order to max plus 1. 'Max' is a calculation of the existing workflows that are for the specific moduleClassName. If the workflow is an existing workflow, then if moduleClassName has changed, the 'max' plus 1 should be used. Otherwise if it is new and the moduleClassName has not changed, then leave it alone

Parameters:
SavedWorkflow $savedWorkflow
bool $isBeingCopied
Exceptions:
NotSupportedException if the moduleClassName has not been defined yet

Definition at line 99 of file SavedWorkflowsUtil.php.

static resolveBeforeSaveByModel ( Item model,
User triggeredByUser 
) [static]

Given a RedBeanModel, query workflow rules and process any beforeSave triggers for either on-save or by-time workflows. Called from

See also:
WokflowsObserver->processWorkflowBeforeSave
Parameters:
Item $model
User $triggeredByUser
Exceptions:
NotSupportedException if the workflow type is not valid

Definition at line 124 of file SavedWorkflowsUtil.php.

static resolveAfterSaveByModel ( Item model,
User triggeredByUser 
) [static]

Given a RedBeanModel, process afterSave actions such as update related, create, and create related. Also process any email messages. If the workflow is by-time, then we should process the ByTimeWorkflowInQueue model.

Parameters:
Item $model
User $triggeredByUser
Exceptions:
NotSupportedException 

Definition at line 158 of file SavedWorkflowsUtil.php.

static resolveProcessDateTimeByWorkflowAndModel ( Workflow workflow,
RedBeanModel model 
) [static]

Public for testing purposes only

Parameters:
Workflow $workflow
RedBeanModel $model

Definition at line 183 of file SavedWorkflowsUtil.php.

static resolveTimeStampForDateAttributeForProcessDateTime ( TimeTriggerForWorkflowForm trigger,
RedBeanModel model 
) [static, protected]
Parameters:
TimeTriggerForWorkflowForm $trigger
RedBeanModel $model
Returns:
int
Exceptions:
ValueForProcessDateTimeIsNullException 

Definition at line 207 of file SavedWorkflowsUtil.php.

static resolveTimeStampForDateTimeAttributeForProcessDateTime ( TimeTriggerForWorkflowForm trigger,
RedBeanModel model 
) [static, protected]
Parameters:
TimeTriggerForWorkflowForm $trigger
RedBeanModel $model
Returns:
int
Exceptions:
ValueForProcessDateTimeIsNullException 

Definition at line 228 of file SavedWorkflowsUtil.php.

static resolveModelValueByTimeTrigger ( TimeTriggerForWorkflowForm trigger,
RedBeanModel model 
) [static, protected]
Parameters:
TimeTriggerForWorkflowForm $trigger
RedBeanModel $model
Returns:
mixed
Exceptions:
NotSupportedException 

Definition at line 248 of file SavedWorkflowsUtil.php.

static processToByTimeWorkflowInQueue ( Workflow workflow,
RedBeanModel model 
) [static, protected]
Parameters:
Workflow $workflow
RedBeanModel $model
Exceptions:
FailedToSaveModelException 

Definition at line 284 of file SavedWorkflowsUtil.php.


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