Inheritance diagram for ComponentForWorkflowForm:

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 ()

Public Member Functions inherited from ConfigurableMetadataModel
	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

Detailed Description

Base class for managing workflow components. Time Trigger, triggers and actions all extend this class

Definition at line 40 of file ComponentForWorkflowForm.php.

Constructor & Destructor Documentation

__construct	(	$moduleClassName,
		$modelClassName,
		$workflowType,
		$rowKey = `0`
	)

Parameters

string	$moduleClassName
string	$modelClassName
string	$workflowType
int	$rowKey

Definition at line 176 of file ComponentForWorkflowForm.php.

Member Function Documentation

static getType ( )

static

Override in children class to

Returns: the correct component type

Exceptions

NotImplementedException

Definition at line 106 of file ComponentForWorkflowForm.php.

getRowKey ( )

Returns: int

Implements RowKeyInterface.

Definition at line 114 of file ComponentForWorkflowForm.php.

attributeNames ( )

Returns: array

Definition at line 122 of file ComponentForWorkflowForm.php.

__set	(	$name,
		$value
	)

Special override to handle setting attributeIndexOrDerivedType

Parameters

string	$name
mixed	$value

Returns: mixed|void

Definition at line 133 of file ComponentForWorkflowForm.php.

getAttribute ( )

Returns: string

Definition at line 149 of file ComponentForWorkflowForm.php.

rules ( )

Returns: array

Definition at line 157 of file ComponentForWorkflowForm.php.

attributeLabels ( )

Returns: array

Definition at line 165 of file ComponentForWorkflowForm.php.

getModelClassName ( )

Returns: string

Definition at line 191 of file ComponentForWorkflowForm.php.

getModuleClassName ( )

Returns: string

Definition at line 199 of file ComponentForWorkflowForm.php.

getWorkflowType ( )

Returns: string

Definition at line 207 of file ComponentForWorkflowForm.php.

getAttributeIndexOrDerivedType ( )

Returns: string

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

Returns: array|string

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.

Returns: bool

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'

Returns: mixed|string

Definition at line 253 of file ComponentForWorkflowForm.php.

getResolvedAttributeModuleClassName ( )

In the case of account's opportunities name, the returned ModuleClassName would be OpportunitiesModule

Returns: string

Definition at line 266 of file ComponentForWorkflowForm.php.

getResolvedAttributeModelClassName ( )

In the case of account's opportunities name, the returned ModelClassName would be Opportunity

Returns: string

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'

Returns: string

Definition at line 294 of file ComponentForWorkflowForm.php.

getResolvedRealAttributeNameForFirstRelation ( )

Returns: string real attribute name. For example owner__User would resolve as owner

Definition at line 302 of file ComponentForWorkflowForm.php.

getResolvedRealAttributeNameForPenultimateRelation ( )

Returns: string real attribute name. For example owner__User would resolve as owner

Definition at line 310 of file ComponentForWorkflowForm.php.

getPenultimateModelClassName ( )

An example of coming from Account -> opportunities name, the penultimate model would be Account

Returns: mixed

Exceptions

NotSupportedException

Definition at line 320 of file ComponentForWorkflowForm.php.

getPenultimateRelation ( )

An example of coming from Account -> opportunities name, the penultimate relation would be opportunities

Returns: mixed

Exceptions

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.

Returns: string.

Definition at line 348 of file ComponentForWorkflowForm.php.

makeResolvedAttributeModelRelationsAndAttributesToWorkflowAdapter ( )

Returns: ModelRelationsAndAttributesToWorkflowAdapter based object

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.

Returns: string

Exceptions

NotSupportedException

Definition at line 412 of file ComponentForWorkflowForm.php.

isATypeOfCurrencyValue ( )

Based on the attribute's displayElementType, is the displayElementType a currency type of display

Returns: bool

Definition at line 426 of file ComponentForWorkflowForm.php.

resolveAttributeOrRelationAndAttributeDataByIndexType ( $indexType )

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

Parameters

string $indexType