Class X2FlowItem

CComponent

Extended by

X2FlowItem

Direct known subclasses

X2FlowAction, X2FlowTrigger

Indirect known subclasses

ActionCompleteTrigger, ActionOverdueTrigger, CampaignEmailOpenTrigger, CampaignUnsubscribeTrigger, EmailOpenTrigger, InboundEmailTrigger, MacroTrigger, MultiChildNode, OutboundEmailTrigger, RecordCreateTrigger, RecordDeleteTrigger, RecordTagAddTrigger, ActionUncompleteTrigger, RecordTagRemoveTrigger, RecordUpdateTrigger, RecordViewTrigger, UserLoginTrigger, UserLogoutTrigger, WebleadTrigger, WorkflowCompleteStageTrigger, WorkflowCompleteTrigger, WorkflowRevertStageTrigger, WorkflowStartStageTrigger, BaseTagTrigger, WorkflowStartTrigger, X2FlowApiCall, X2FlowCreateAction, X2FlowCreateEvent, X2FlowCreateNotif, X2FlowEmail, X2FlowRecordComment, X2FlowRecordCreate, X2FlowRecordCreateAction, X2FlowRecordDelete, BaseUserTrigger, X2FlowRecordListAdd, X2FlowRecordListRemove, X2FlowRecordReassign, X2FlowRecordTag, X2FlowRecordUpdate, X2FlowSplitter, X2FlowSwitch, X2FlowWorkflowCompleteStage, X2FlowWorkflowRevertStage, X2FlowWorkflowStartStage, BaseWorkflowStageTrigger, BaseWorkflowTrigger, BaseX2FlowEmail, BaseX2FlowWorkflowStageAction, CampaignEmailClickTrigger

Abstract
Package: application\components\x2flow
Located at x2engine/protected/components/x2flow/X2FlowItem.php

Methods summary
`abstract public array`	# `paramRules( )` Returns `array` the param rules.
`abstract public`	# `validate( mixed & $params = array(), mixed $flowId = null )` Checks if all all the params are ship-shape Checks if all all the params are ship-shape
`public`	# `validateOptions( boolean & $paramRules, mixed $params = null, mixed $staticValidation = false )` Checks if all the config variables and runtime params are ship-shape Ignores param requirements if $params isn't provided Checks if all the config variables and runtime params are ship-shape Ignores param requirements if $params isn't provided Parameters `$paramRules` `boolean` $staticValidation If true, validation will include checks for warnings `$params` `$staticValidation`
`public`	# `validateEmail( mixed $option, mixed $optRule )`
`public`	# `validateDropdown( mixed & $option, mixed $optRule )`
`public static mixed`	# `getParamRules( string $type )` Gets the param rules for the specified flow item Gets the param rules for the specified flow item Parameters `$type` `string` $type name of action class Returns `mixed` an array of param rules, or false if the action doesn't exist
`public static string`	# `getTitle( string $type )` Gets the title property of the specified flow item Gets the title property of the specified flow item Parameters `$type` `string` $type name of action class Returns `string` the title property, or '' if the type is invalid of if the class associated with the type doesn't have a title property
`public static mixed`	# `create( mixed $config )` Creates a flow item with the provided config data Creates a flow item with the provided config data Returns `mixed` a class extending X2FlowAction with the specified name
`public static mixed`	# `calculateTimeOffset( integer $time, string $unit )` Calculates a time offset from a number and a unit Calculates a time offset from a number and a unit Parameters `$time` `integer` $time the number of time units to add `$unit` `string` $unit the unit of time Returns `mixed` the calculated timestamp, or false if the $unit is invalid
`public mixed`	# `parseOption( string $name, array & $params )` Parameters `$name` `string` $name the name of the option `$params` `array` $params the parameters passed to trigger () Returns `mixed` null if the option was not set by the user, the parsed value otherwise
`public static type`	# `getInstances( type $type, type $excludeClasses = array() )` Generalized mass-instantiation method. Generalized mass-instantiation method. Loads and instantiates all X2Flow items of a given type (i.e. actions, triggers). Parameters `$type` `type` $type `$excludeClasses` `type` $excludeClasses Returns `type`

Methods inherited from CComponent
`__call(), __get(), __isset(), __set(), __unset(), asa(), attachBehavior(), attachBehaviors(), attachEventHandler(), canGetProperty(), canSetProperty(), detachBehavior(), detachBehaviors(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), getEventHandlers(), hasEvent(), hasEventHandler(), hasProperty(), raiseEvent()`

Constants summary
`integer`	`VALIDATION_WARNING`	`2`	#

Properties summary
`protected static mixed`	`$_instances`		# "Cache" of instantiated triggers, for reference purposes "Cache" of instantiated triggers, for reference purposes
`public string`	`$label`	`''`	# $var string the text label for this action $var string the text label for this action
`public string`	`$info`	`''`	# $var string the description of this action $var string the description of this action
`public string`	`$config`	`''`	# $var array the config parameters for this action $var array the config parameters for this action
`public boolean`	`$requiresCron`	`false`	# $var bool distinguishes whether cron is required for running the action properly $var bool distinguishes whether cron is required for running the action properly