All Data Structures Functions Variables Pages
Public Member Functions | Static Public Member Functions | Data Fields
Workflow Class Reference
Inheritance diagram for Workflow:

Public Member Functions

 __toString ()
 
 getDescription ()
 
 setDescription ($description)
 
 getIsActive ()
 
 setIsActive ($isActive)
 
 getModuleClassName ()
 
 setModuleClassName ($moduleClassName)
 
 getOrder ()
 
 setOrder ($order)
 
 getTriggerOn ()
 
 setTriggerOn ($triggerOn)
 
 setTriggersStructure ($triggersStructure)
 
 getTriggersStructure ()
 
 getId ()
 
 setId ($id)
 
 getName ()
 
 setName ($name)
 
 getType ()
 
 setType ($type)
 
 isNew ()
 
 setTimeTriggerAttribute ($timeTriggerAttribute)
 
 getTimeTriggerAttribute ()
 
 getTimeTrigger ()
 
 setTimeTrigger (TimeTriggerForWorkflowForm $timeTrigger)
 
 removeTimeTrigger ()
 
 getTriggers ()
 
 addTrigger (TriggerForWorkflowForm $trigger)
 
 removeAllTriggers ()
 
 getActions ()
 
 addAction (ActionForWorkflowForm $action)
 
 removeAllActions ()
 
 getEmailMessages ()
 
 addEmailMessage (EmailMessageForWorkflowForm $emailMessage)
 
 removeAllEmailMessages ()
 
 doesTimeTriggerRequireChangeToProcess ()
 
 setTimeTriggerRequireChangeToProcessToFalse ()
 

Static Public Member Functions

static getTypeDropDownArray ()
 
static getWorkflowSupportedModulesAndLabelsForCurrentUser ()
 
static getWorkflowSupportedModulesClassNamesCurrentUserHasAccessTo ()
 

Data Fields

const TYPE_ON_SAVE = 'OnSave'
 
const TYPE_BY_TIME = 'ByTime'
 
const TRIGGER_ON_NEW = 'New'
 
const TRIGGER_ON_NEW_AND_EXISTING = 'NewAndExisting'
 
const TRIGGER_ON_EXISTING = 'Existing'
 

Detailed Description

Class for interacting with Workflow definitions. Gets information from either a SavedWorkflow or via a POST. Contains information about how a workflow should be constructed including how it looks in the user interface when run. The components of a workflow are a time trigger, triggers, actions, and email messages

There are 2 different types of workflows: TYPE_ON_SAVE and TYPE_BY_TIME

Definition at line 44 of file Workflow.php.

Member Function Documentation

static getTypeDropDownArray ( )
static
Returns
array

Definition at line 137 of file Workflow.php.

static getWorkflowSupportedModulesAndLabelsForCurrentUser ( )
static

Based on the current user, return the workflow supported modules and their display labels. Only include modules that the user has a right to access.

Returns
array of module class names and display labels.

Definition at line 148 of file Workflow.php.

static getWorkflowSupportedModulesClassNamesCurrentUserHasAccessTo ( )
static
Returns
array

Definition at line 174 of file Workflow.php.

__toString ( )
Returns
string

Definition at line 194 of file Workflow.php.

getDescription ( )
Returns
mixed

Definition at line 206 of file Workflow.php.

setDescription (   $description)
Parameters
$description

Definition at line 214 of file Workflow.php.

getIsActive ( )
Returns
bool

Definition at line 223 of file Workflow.php.

setIsActive (   $isActive)
Parameters
bool$isActive

Definition at line 231 of file Workflow.php.

getModuleClassName ( )
Returns
string

Definition at line 240 of file Workflow.php.

setModuleClassName (   $moduleClassName)
Parameters
$moduleClassName

Definition at line 248 of file Workflow.php.

getOrder ( )
Returns
int

Definition at line 257 of file Workflow.php.

setOrder (   $order)
Parameters
integer$order

Definition at line 265 of file Workflow.php.

getTriggerOn ( )
Returns
string

Definition at line 274 of file Workflow.php.

setTriggerOn (   $triggerOn)
Parameters
string$triggerOn

Definition at line 282 of file Workflow.php.

setTriggersStructure (   $triggersStructure)
Parameters
string$triggersStructure

Definition at line 292 of file Workflow.php.

getTriggersStructure ( )
Returns
string

Definition at line 301 of file Workflow.php.

getId ( )
Returns
int

Definition at line 309 of file Workflow.php.

setId (   $id)
Parameters
integer$id

Definition at line 317 of file Workflow.php.

getName ( )
Returns
string

Definition at line 326 of file Workflow.php.

setName (   $name)
Parameters
$name

Definition at line 334 of file Workflow.php.

getType ( )
Returns
string

Definition at line 343 of file Workflow.php.

setType (   $type)
Parameters
$type

Definition at line 351 of file Workflow.php.

isNew ( )
Returns
bool

Definition at line 360 of file Workflow.php.

setTimeTriggerAttribute (   $timeTriggerAttribute)
Parameters
string$timeTriggerAttribute

Definition at line 372 of file Workflow.php.

getTimeTriggerAttribute ( )
Returns
string

Definition at line 381 of file Workflow.php.

getTimeTrigger ( )
Returns
TimeTriggerForWorkflowForm

Definition at line 389 of file Workflow.php.

setTimeTrigger ( TimeTriggerForWorkflowForm  $timeTrigger)
Parameters
TimeTriggerForWorkflowForm$timeTrigger

Definition at line 397 of file Workflow.php.

removeTimeTrigger ( )

Resets timeTrigger to null

Definition at line 405 of file Workflow.php.

getTriggers ( )
Returns
array

Definition at line 413 of file Workflow.php.

addTrigger ( TriggerForWorkflowForm  $trigger)
Parameters
TriggerForWorkflowForm$trigger

Definition at line 421 of file Workflow.php.

removeAllTriggers ( )

Resets triggers to an empty array

Definition at line 429 of file Workflow.php.

getActions ( )
Returns
array

Definition at line 437 of file Workflow.php.

addAction ( ActionForWorkflowForm  $action)
Parameters
ActionForWorkflowForm$action

Definition at line 445 of file Workflow.php.

removeAllActions ( )

Resets actions to an empty array

Definition at line 453 of file Workflow.php.

getEmailMessages ( )
Returns
array

Definition at line 461 of file Workflow.php.

addEmailMessage ( EmailMessageForWorkflowForm  $emailMessage)
Parameters
EmailMessageForWorkflowForm$emailMessage

Definition at line 469 of file Workflow.php.

removeAllEmailMessages ( )

Resets emailMessages to an empty array

Definition at line 477 of file Workflow.php.

doesTimeTriggerRequireChangeToProcess ( )
Returns
bool

Definition at line 485 of file Workflow.php.

setTimeTriggerRequireChangeToProcessToFalse ( )

When processing ByTime workflow in

See Also
ByTimeWorkflowInQueueJob this should be changed to false so the time trigger can be evaluated correctly.

Definition at line 494 of file Workflow.php.


The documentation for this class was generated from the following file:
Generated on Wed Apr 8 2020 07:11:23