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 | Static Public Member Functions | Data Fields | Protected Member Functions | Static Protected Member Functions
TriggerForWorkflowForm Class Reference
Inheritance diagram for TriggerForWorkflowForm:
ComponentForWorkflowForm OperatorInterface ConfigurableMetadataModel RowKeyInterface TimeTriggerForWorkflowForm

Public Member Functions

 attributeNames ()
 
 __set ($name, $value)
 
 setOperator ($value)
 
 getOperator ()
 
 rules ()
 
 validateOperator ()
 
 validateRelationFilter ()
 
 validateValue ()
 
 validateSecondValue ()
 
 validateThirdValue ()
 
 validateValueType ()
 
 hasAvailableOperatorsType ()
 
 getOperatorValuesAndLabels ()
 
 getValueElementType ()
 
 getValueEvaluationType ()
 
 getCustomFieldDataAndLabels ()
 
 isTrueByModel (RedBeanModel $model)
 
 resolveNewTimeStampForThirdValueDuration ($initialTimeStamp)
 
- Public Member Functions inherited from ComponentForWorkflowForm
 getRowKey ()
 
 attributeNames ()
 
 __set ($name, $value)
 
 getAttribute ()
 
 rules ()
 
 attributeLabels ()
 
 __construct ($moduleClassName, $modelClassName, $workflowType, $rowKey=0)
 
 getModelClassName ()
 
 getModuleClassName ()
 
 getWorkflowType ()
 
 getAttributeIndexOrDerivedType ()
 
 getAttributeAndRelationData ()
 
 hasRelatedData ()
 
 getResolvedAttribute ()
 
 getResolvedAttributeModuleClassName ()
 
 getResolvedAttributeModelClassName ()
 
 getResolvedAttributeRealAttributeName ()
 
 getResolvedRealAttributeNameForFirstRelation ()
 
 getResolvedRealAttributeNameForPenultimateRelation ()
 
 getPenultimateModelClassName ()
 
 getPenultimateRelation ()
 
 getDisplayLabel ()
 
 makeResolvedAttributeModelRelationsAndAttributesToWorkflowAdapter ()
 
 getDisplayElementType ()
 
 isATypeOfCurrencyValue ()
 

Static Public Member Functions

static getType ()
 
- Static Public Member Functions inherited from ComponentForWorkflowForm
static getType ()
 

Data Fields

const RELATION_FILTER_ANY = 'RelationFilterAny'
 
 $currencyIdForValue
 
 $value
 
 $secondValue
 
 $thirdValueDurationInterval
 
 $thirdValueDurationType
 
 $stringifiedModelForValue
 
 $valueType
 
 $relationFilter = self::RELATION_FILTER_ANY
 
- Data Fields inherited from ComponentForWorkflowForm
const DISPLAY_LABEL_RELATION_DIVIDER = '>>'
 
const TYPE_TIME_TRIGGER = 'TimeTrigger'
 
const TYPE_TRIGGERS = 'Triggers'
 
const TYPE_ACTIONS = 'Actions'
 
const TYPE_EMAIL_MESSAGES = 'EmailMessages'
 

Protected Member Functions

 getAvailableOperatorsType ()
 
 resolveShouldAddSpecialOnSaveNonRelatedOperators ()
 
 resolveShouldAddSpecialByTimeNonRelatedOperators ()
 
- Protected Member Functions inherited from ComponentForWorkflowForm
 resolveAttributeOrRelationAndAttributeDataByIndexType ($indexType)
 
 resolveAttributeFromData (Array $attributeAndRelationData)
 
 resolveAttributeModuleClassNameFromData (Array $attributeAndRelationData, $moduleClassName, $modelClassName)
 
 resolveAttributeModelClassNameFromData (Array $attributeAndRelationData, $moduleClassName, $modelClassName)
 
 resolvePenultimateModelClassNameFromData (Array $attributeAndRelationData, $modelClassName)
 
 resolvePenultimateRelationFromData (Array $attributeAndRelationData)
 
 resolveRealAttributeNameForPenultimateRelation (Array $attributeAndRelationData)
 

Static Protected Member Functions

static getValueTypesWhereValueIsRequired ()
 
static getValueTypesWhereSecondValueIsRequired ()
 
static getOperatorsWhereValueIsRequired ()
 
static getOperatorsWhereSecondValueIsRequired ()
 
static getValueTypesWhereThirdValueIsRequired ()
 

Additional Inherited Members

- Protected Attributes inherited from ComponentForWorkflowForm
 $moduleClassName
 
 $modelClassName
 
 $attributeAndRelationData
 
 $workflowType
 

Detailed Description

Component form for trigger definitions

Definition at line 40 of file TriggerForWorkflowForm.php.

Member Function Documentation

static getType ( )
static
Returns
string component type

Definition at line 120 of file TriggerForWorkflowForm.php.

attributeNames ( )
Returns
array

Definition at line 128 of file TriggerForWorkflowForm.php.

__set (   $name,
  $value 
)

Reset availableOperatorsType cache whenever a new attribute is set (non-PHPdoc)

See Also
ComponentForWorkflowForm::__set()

Definition at line 138 of file TriggerForWorkflowForm.php.

setOperator (   $value)
Parameters
$value
Exceptions
NotSupportedException

Definition at line 151 of file TriggerForWorkflowForm.php.

getOperator ( )
Returns
string

Implements OperatorInterface.

Definition at line 163 of file TriggerForWorkflowForm.php.

rules ( )
Returns
array

Definition at line 171 of file TriggerForWorkflowForm.php.

validateOperator ( )
Returns
bool

Definition at line 195 of file TriggerForWorkflowForm.php.

validateRelationFilter ( )
Returns
bool

Definition at line 207 of file TriggerForWorkflowForm.php.

validateValue ( )
Returns
bool

Definition at line 221 of file TriggerForWorkflowForm.php.

validateSecondValue ( )

When the operator type is Between the secondValue is required. Also if the valueType, which is used by date/datetime attributes is set to Between than the secondValue is required.

Returns
bool
Exceptions
NotSupportedException

Definition at line 257 of file TriggerForWorkflowForm.php.

validateThirdValue ( )

When the value type is MixedDateTypesTriggerForWorkflowFormAttributeMappingRules::TYPE_AT_LEAST_X_AFTER_TRIGGERED_DATE or MixedDateTypesTriggerForWorkflowFormAttributeMappingRules::TYPE_AT_LEAST_X_BEFORE_TRIGGERED_DATE then the thirdValueDurationInterval and thirdValueDurationType are required

Returns
bool
Exceptions
NotSupportedException

Definition at line 286 of file TriggerForWorkflowForm.php.

validateValueType ( )
Returns
bool

Definition at line 307 of file TriggerForWorkflowForm.php.

hasAvailableOperatorsType ( )
Returns
bool

Definition at line 319 of file TriggerForWorkflowForm.php.

getOperatorValuesAndLabels ( )
Returns
array
Exceptions
NotSupportedExceptionif the attributeIndexOrDerivedType has not been populated yet

Definition at line 332 of file TriggerForWorkflowForm.php.

getValueElementType ( )
Returns
null|string
Exceptions
NotSupportedExceptionif the attributeIndexOrDerivedType has not been populated yet

Definition at line 372 of file TriggerForWorkflowForm.php.

getValueEvaluationType ( )

Utilized during evaluating a trigger against a model value whether it is true or false

Returns
null|string
Exceptions
NotSupportedExceptionif the attributeIndexOrDerivedType has not been populated yet

Definition at line 387 of file TriggerForWorkflowForm.php.

getCustomFieldDataAndLabels ( )
Returns
array
Exceptions
NotSupportedExceptionif the resolved attribute is invalid and not on the resolved model

Definition at line 401 of file TriggerForWorkflowForm.php.

isTrueByModel ( RedBeanModel  $model)

Given a model, does the trigger evaluate true or false for the value against the trigger's attribute

Parameters
RedBeanModel$model
Returns
boolean

Definition at line 423 of file TriggerForWorkflowForm.php.

resolveNewTimeStampForThirdValueDuration (   $initialTimeStamp)

Resolve durationSign based on value type MixedDateTypesTriggerForWorkflowFormAttributeMappingRules::TYPE_AT_LEAST_X_AFTER_TRIGGERED_DATE or MixedDateTypesTriggerForWorkflowFormAttributeMappingRules::TYPE_AT_LEAST_X_BEFORE_TRIGGERED_DATE

Parameters
integer$initialTimeStamp
Returns
integer timestamp based on thirdValueDurationInterval, valueType, and thirdValueDurationType

Definition at line 436 of file TriggerForWorkflowForm.php.

getAvailableOperatorsType ( )
protected
Returns
array|null|string
Exceptions
NotSupportedExceptionif the attributeIndexOrDerivedType has not been populated yet

Definition at line 458 of file TriggerForWorkflowForm.php.

static getValueTypesWhereValueIsRequired ( )
staticprotected
Returns
array

Definition at line 477 of file TriggerForWorkflowForm.php.

static getValueTypesWhereSecondValueIsRequired ( )
staticprotected
Returns
array

Definition at line 485 of file TriggerForWorkflowForm.php.

static getOperatorsWhereValueIsRequired ( )
staticprotected
Returns
array

Definition at line 493 of file TriggerForWorkflowForm.php.

static getOperatorsWhereSecondValueIsRequired ( )
staticprotected
Returns
array

Definition at line 501 of file TriggerForWorkflowForm.php.

static getValueTypesWhereThirdValueIsRequired ( )
staticprotected
Returns
array

Definition at line 509 of file TriggerForWorkflowForm.php.

resolveShouldAddSpecialOnSaveNonRelatedOperators ( )
protected
Returns
bool

Definition at line 570 of file TriggerForWorkflowForm.php.

resolveShouldAddSpecialByTimeNonRelatedOperators ( )
protected
Returns
bool

Definition at line 587 of file TriggerForWorkflowForm.php.

Field Documentation

const RELATION_FILTER_ANY = 'RelationFilterAny'

When performing actions on related models, if there are MANY related models RELATION_FILTER_ALL means the action will be performed on all related models

Definition at line 46 of file TriggerForWorkflowForm.php.


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