Public Member Functions | |
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 () | |
![]() | |
isAttribute ($attributeName) | |
Static Public Member Functions | |
static | getType () |
Data Fields | |
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 | |
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) | |
Protected Attributes | |
$moduleClassName | |
$modelClassName | |
$attributeAndRelationData | |
$workflowType | |
Base class for managing workflow components. Time Trigger, triggers and actions all extend this class
Definition at line 40 of file ComponentForWorkflowForm.php.
__construct | ( | $moduleClassName, | |
$modelClassName, | |||
$workflowType, | |||
$rowKey = 0 |
|||
) |
string | $moduleClassName | |
string | $modelClassName | |
string | $workflowType | |
int | $rowKey |
Definition at line 176 of file ComponentForWorkflowForm.php.
|
static |
Override in children class to
NotImplementedException |
Definition at line 106 of file ComponentForWorkflowForm.php.
getRowKey | ( | ) |
attributeNames | ( | ) |
Definition at line 122 of file ComponentForWorkflowForm.php.
__set | ( | $name, | |
$value | |||
) |
Special override to handle setting attributeIndexOrDerivedType
string | $name | |
mixed | $value |
Definition at line 133 of file ComponentForWorkflowForm.php.
getAttribute | ( | ) |
Definition at line 149 of file ComponentForWorkflowForm.php.
rules | ( | ) |
Definition at line 157 of file ComponentForWorkflowForm.php.
attributeLabels | ( | ) |
Definition at line 165 of file ComponentForWorkflowForm.php.
getModelClassName | ( | ) |
Definition at line 191 of file ComponentForWorkflowForm.php.
getModuleClassName | ( | ) |
Definition at line 199 of file ComponentForWorkflowForm.php.
getWorkflowType | ( | ) |
Definition at line 207 of file ComponentForWorkflowForm.php.
getAttributeIndexOrDerivedType | ( | ) |
Definition at line 215 of file ComponentForWorkflowForm.php.
getAttributeAndRelationData | ( | ) |
If the attribute is on a relation then attributeAndRelationData should be populated otherwise it will return the $this->attribute
Definition at line 225 of file ComponentForWorkflowForm.php.
hasRelatedData | ( | ) |
An attribute on a relation such as from an Account, opportunities name would return true. whereas just from an Account, name would return false.
Definition at line 239 of file ComponentForWorkflowForm.php.
getResolvedAttribute | ( | ) |
Resolves the attribute name for the relation. Both account name and account's opportunities name would resolve as just 'name'
Definition at line 253 of file ComponentForWorkflowForm.php.
getResolvedAttributeModuleClassName | ( | ) |
In the case of account's opportunities name, the returned ModuleClassName would be OpportunitiesModule
Definition at line 266 of file ComponentForWorkflowForm.php.
getResolvedAttributeModelClassName | ( | ) |
In the case of account's opportunities name, the returned ModelClassName would be Opportunity
Definition at line 280 of file ComponentForWorkflowForm.php.
getResolvedAttributeRealAttributeName | ( | ) |
An example where the attribute is not the real attribute would be a trigger owner__User In this case the real attribute returned would be 'owner'
Definition at line 294 of file ComponentForWorkflowForm.php.
getResolvedRealAttributeNameForFirstRelation | ( | ) |
Definition at line 302 of file ComponentForWorkflowForm.php.
getResolvedRealAttributeNameForPenultimateRelation | ( | ) |
Definition at line 310 of file ComponentForWorkflowForm.php.
getPenultimateModelClassName | ( | ) |
An example of coming from Account -> opportunities name, the penultimate model would be Account
NotSupportedException |
Definition at line 320 of file ComponentForWorkflowForm.php.
getPenultimateRelation | ( | ) |
An example of coming from Account -> opportunities name, the penultimate relation would be opportunities
NotSupportedException |
Definition at line 334 of file ComponentForWorkflowForm.php.
getDisplayLabel | ( | ) |
Builds the display label based on either the attribute or attributeAndRelationData and returns the string content.
Definition at line 348 of file ComponentForWorkflowForm.php.
makeResolvedAttributeModelRelationsAndAttributesToWorkflowAdapter | ( | ) |
Definition at line 400 of file ComponentForWorkflowForm.php.
getDisplayElementType | ( | ) |
Based on the attribute, what kind of display element should be utilized to render the attribute's value.
NotSupportedException |
Definition at line 412 of file ComponentForWorkflowForm.php.
isATypeOfCurrencyValue | ( | ) |
Based on the attribute's displayElementType, is the displayElementType a currency type of display
Definition at line 426 of file ComponentForWorkflowForm.php.
|
protected |
Passing in attributeIndexOrDerivedType, return an array representing the attribute and relation data or if there is just a single attribute, then return a string representing the attribute
string | $indexType |
Definition at line 442 of file ComponentForWorkflowForm.php.
|
protected |
array | $attributeAndRelationData |
Definition at line 456 of file ComponentForWorkflowForm.php.
|
protected |
array | $attributeAndRelationData | |
$moduleClassName | ||
$modelClassName |
Definition at line 468 of file ComponentForWorkflowForm.php.
|
protected |
array | $attributeAndRelationData | |
$moduleClassName | ||
$modelClassName |
Definition at line 491 of file ComponentForWorkflowForm.php.
|
protected |
array | $attributeAndRelationData | |
$modelClassName |
Definition at line 513 of file ComponentForWorkflowForm.php.
|
protected |
array | $attributeAndRelationData |
Definition at line 534 of file ComponentForWorkflowForm.php.
|
protected |
array | $attributeAndRelationData |
Definition at line 545 of file ComponentForWorkflowForm.php.
const DISPLAY_LABEL_RELATION_DIVIDER = '>>' |
Divider used for displaying labels that cross relations. An example is Account's >> Opportunities
Definition at line 45 of file ComponentForWorkflowForm.php.
const TYPE_TIME_TRIGGER = 'TimeTrigger' |
Component type for time trigger
Definition at line 50 of file ComponentForWorkflowForm.php.
const TYPE_TRIGGERS = 'Triggers' |
Component type for display attributes
Definition at line 55 of file ComponentForWorkflowForm.php.
const TYPE_ACTIONS = 'Actions' |
Component type for actions
Definition at line 60 of file ComponentForWorkflowForm.php.
const TYPE_EMAIL_MESSAGES = 'EmailMessages' |
Component type for email messages
Definition at line 65 of file ComponentForWorkflowForm.php.