Overview

Packages

  • application
    • commands
    • components
      • actions
      • filters
      • leftWidget
      • permissions
      • sortableWidget
      • util
      • webupdater
      • x2flow
        • actions
        • triggers
      • X2GridView
      • X2Settings
    • controllers
    • models
      • embedded
    • modules
      • accounts
        • controllers
        • models
      • actions
        • controllers
        • models
      • calendar
        • controllers
        • models
      • charts
        • models
      • contacts
        • controllers
        • models
      • docs
        • components
        • controllers
        • models
      • groups
        • controllers
        • models
      • marketing
        • components
        • controllers
        • models
      • media
        • controllers
        • models
      • mobile
        • components
      • opportunities
        • controllers
        • models
      • products
        • controllers
        • models
      • quotes
        • controllers
        • models
      • services
        • controllers
        • models
      • template
        • models
      • users
        • controllers
        • models
      • workflow
        • controllers
        • models
      • x2Leads
        • controllers
        • models
  • None
  • system
    • base
    • caching
    • console
    • db
      • ar
      • schema
    • validators
    • web
      • actions
      • auth
      • helpers
      • widgets
        • captcha
        • pagers
  • zii
    • widgets
      • grid

Classes

  • X2FlowAction
  • X2FlowItem
  • X2FlowTrigger
  • X2FlowTriggerBehavior
  • Overview
  • Package
  • Class
  • Tree

Class X2FlowAction

CComponent
Extended by X2FlowItem
Extended by X2FlowAction

Direct known subclasses

BaseX2FlowEmail, BaseX2FlowWorkflowStageAction, X2FlowRecordListAdd, X2FlowRecordListRemove, X2FlowRecordReassign, X2FlowRecordTag, X2FlowRecordUpdate, X2FlowApiCall, X2FlowCreateAction, X2FlowCreateEvent, X2FlowCreateNotif, X2FlowRecordComment, X2FlowRecordCreate, X2FlowRecordCreateAction, X2FlowRecordDelete

Indirect known subclasses

X2FlowEmail, X2FlowWorkflowCompleteStage, X2FlowWorkflowRevertStage, X2FlowWorkflowStartStage
Abstract
Package: application\components\x2flow
Located at x2engine/protected/components/x2flow/actions/X2FlowAction.php
Methods summary
abstract public boolean
# execute( mixed & $params )

Runs the automation action with provided params.

Runs the automation action with provided params.

Returns

boolean
the result of the execution
public array
# paramRules( )

Returns

array
the param rules.
public
# validate( mixed & $params = array(), mixed $flowId = null )

Checks if all the config variables and runtime params are ship-shape Ignores param requirements if $params isn't provided Returns an array with two elements. The first element indicates whether an error occured, the second contains a log message.

Checks if all the config variables and runtime params are ship-shape Ignores param requirements if $params isn't provided Returns an array with two elements. The first element indicates whether an error occured, the second contains a log message.

public mixed
# getNotifType( )

Returns

mixed
either a string containing the notification type for this flow's trigger, or null
public mixed
# getEventType( )

Returns

mixed
either a string containing the notification type for this flow's trigger, or null
public boolean
# setModelAttributes( CActiveRecord & $model, array & $attributeList, array & $params )

Sets model fields using the provided attributes and values.

Sets model fields using the provided attributes and values.

Parameters

$model
CActiveRecord
$model the model to set fields on
$attributeList
array
$attributes an associative array of attributes
$params
array
$params the params array passed to X2Flow::trigger()

Returns

boolean
whether or not the attributes were valid and set successfully
public static
# getActionTypes( string $queryProperty = False, mixed $queryValue = False )

Gets all action types.

Gets all action types.

Optionally limits actions to a list with a property matching a value.

Parameters

$queryProperty
string
$queryProperty The property of each action to test
$queryValue
mixed
$queryValue The value to match actions against
public static
# getActionInstances( )
Methods inherited from X2FlowItem
calculateTimeOffset(), create(), getInstances(), getParamRules(), getTitle(), parseOption(), validateDropdown(), validateEmail(), validateOptions()
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 inherited from X2FlowItem
VALIDATION_WARNING
Properties summary
public mixed $trigger null
#
Properties inherited from X2FlowItem
$_instances, $config, $info, $label, $requiresCron
X2CRM Documentation API documentation generated by ApiGen 2.8.0