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

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

Class X2FlowApiCall

X2FlowAction that calls a remote API

CComponent
Extended by X2FlowItem
Extended by X2FlowAction
Extended by X2FlowApiCall
Package: application\components\x2flow\actions
Located at x2engine/protected/components/x2flow/actions/X2FlowApiCall.php
Methods summary
public
# getMakeRequest( )

Allows request behavior of this class to be toggled during unit tests

Allows request behavior of this class to be toggled during unit tests

public array
# paramRules( )

Returns

array
the param rules.

Overrides

X2FlowAction::paramRules()
public array
# getHeaders( array $headerRows, mixed $params )

Parameters

$headerRows
array
$headerRows
$params

Returns

array
public string
# formatHeaders( array $headers )

Parameters

$headers
array
$headers

Returns

string
public
# validateOptions( boolean & $paramRules, mixed $params = null, mixed $staticValidation = false )

Override parent method to add url validation. Present warning to user on flow save if specified url points to same server as the one X2Engine is hosted on.

Override parent method to add url validation. Present warning to user on flow save if specified url points to same server as the one X2Engine is hosted on.

Parameters

$paramRules
boolean
$staticValidation If true, validation will include checks for warnings
$params
$staticValidation

Overrides

X2FlowItem::validateOptions()
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
Methods inherited from X2FlowAction
getActionInstances(), getActionTypes(), getEventType(), getNotifType(), setModelAttributes(), validate()
Methods inherited from X2FlowItem
calculateTimeOffset(), create(), getInstances(), getParamRules(), getTitle(), parseOption(), validateDropdown(), validateEmail()
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 string $title 'Remote API Call'
#
public string $info 'Call a remote API by requesting the specified URL. You can specify the request type, HTTP headers, and any variables to be passed with the request.'
#

$var string the description of this action

$var string the description of this action

Properties inherited from X2FlowAction
$trigger
Properties inherited from X2FlowItem
$_instances, $config, $label, $requiresCron
X2CRM Documentation API documentation generated by ApiGen 2.8.0