Account Suspended
Account Suspended
This Account has been suspended.
Contact your hosting provider for more information.
 All Data Structures Functions Variables Pages
Public Member Functions | Data Fields | Protected Member Functions
DropDownWorkflowActionAttributeForm Class Reference
Inheritance diagram for DropDownWorkflowActionAttributeForm:
CustomFieldWorkflowActionAttributeForm WorkflowActionAttributeForm ConfigurableMetadataModel RadioDropDownWorkflowActionAttributeForm

Public Member Functions

 getValueElementType ()
 
 validateValue ()
 
 resolveValueAndSetToModel (WorkflowActionProcessingModelAdapter $adapter, $attribute)
 
- Public Member Functions inherited from CustomFieldWorkflowActionAttributeForm
 getCustomFieldDataAndLabels ()
 
- Public Member Functions inherited from WorkflowActionAttributeForm
 getValueElementType ()
 
 __construct ($modelClassName, $modelAttributeName)
 
 getAlternateValue ()
 
 getDisplayLabel ()
 
 getStringifiedModelForValue ()
 
 setDisplayLabel ($displayLabel)
 
 getModelClassName ()
 
 getModelAttributeName ()
 
 rules ()
 
 attributeLabels ()
 
 validateValue ()
 
 getTypeValuesAndLabels ($isCreatingNewModel, $isRequired)
 
 resolveValueAndSetToModel (WorkflowActionProcessingModelAdapter $adapter, $attribute)
 
 shouldSetNullAlternativeValue ()
 
 resolveNullAlternativeValueAndSetToModel (WorkflowActionProcessingModelAdapter $adapter, $attribute)
 

Data Fields

const TYPE_DYNAMIC_STEP_FORWARD_OR_BACKWARDS = 'DynamicStepForwardOrBackwards'
 
- Data Fields inherited from WorkflowActionAttributeForm
const TYPE_STATIC = 'Static'
 
const TYPE_STATIC_NULL = 'StaticNull'
 
 $type
 
 $value
 
 $shouldSetValue
 

Protected Member Functions

 makeTypeValuesAndLabels ($isCreatingNewModel, $isRequired)
 
- Protected Member Functions inherited from WorkflowActionAttributeForm
 makeTypeValuesAndLabels ($isCreatingNewModel, $isRequired)
 
 resolveValueForMergeTags ($value, WorkflowActionProcessingModelAdapter $adapter)
 

Additional Inherited Members

- Static Public Member Functions inherited from WorkflowActionAttributeForm
static getFormType ()
 
static resolveValueBeforeSave ()
 
- Protected Attributes inherited from WorkflowActionAttributeForm
 $stringifiedModelForValue
 
 $modelClassName
 
 $modelAttributeName
 
 $displayLabel
 
 $shouldResolveValueForMergeTags = false
 

Detailed Description

Form to work with dropDown attributes

Definition at line 40 of file DropDownWorkflowActionAttributeForm.php.

Member Function Documentation

getValueElementType ( )
Returns
string

Definition at line 51 of file DropDownWorkflowActionAttributeForm.php.

validateValue ( )

Value can either be a string or if dynamic step, then it is an integer

Returns
bool

Definition at line 60 of file DropDownWorkflowActionAttributeForm.php.

resolveValueAndSetToModel ( WorkflowActionProcessingModelAdapter  $adapter,
  $attribute 
)

Utilized to create or update model attribute values after a workflow's triggers are fired as true. If the current value is null and the type is TYPE_DYNAMIC_STEP_FORWARD_OR_BACKWARDS then something is wrong so this should not be processed. the step forward/backwards should only be processed on existing models

Parameters
WorkflowActionProcessingModelAdapter$adapter
$attribute
Exceptions
NotSupportedException

Definition at line 89 of file DropDownWorkflowActionAttributeForm.php.

makeTypeValuesAndLabels (   $isCreatingNewModel,
  $isRequired 
)
protected
Parameters
bool$isCreatingNewModel
bool$isRequired
Returns
array

Definition at line 122 of file DropDownWorkflowActionAttributeForm.php.

Field Documentation

const TYPE_DYNAMIC_STEP_FORWARD_OR_BACKWARDS = 'DynamicStepForwardOrBackwards'

DropDowns can be dynamically set based on a distance from the existing value. If the existing value is the first item in the drop down, and the step is 2, then it will set as the 3rd value in the drop down list.

Definition at line 46 of file DropDownWorkflowActionAttributeForm.php.


The documentation for this class was generated from the following file:
Generated on Fri Nov 27 2020 07:10:40
Account Suspended
Account Suspended
This Account has been suspended.
Contact your hosting provider for more information.