LeadConverter extends EntityConverter
Table of Contents
Methods
- __construct() : mixed
- enableActivityCompletion() : mixed
- Enable/disable completion of lead activities.
- executePhase() : bool
- Try to execute current conversion phase.
- getAnalytics() : ConvertEvent|null
- getEntityTypeID() : int
- Get converter entity type ID.
- getMap() : EntityConversionMap
- Get conversion map for for specified entity type.
- getMapper() : LeadConversionMapper|null
- Get conversion mapper
- getSupportedDestinationTypeIDs() : array<string|int, mixed>
- Get Supported Destination Types
- initialize() : void
- Initialize converter.
- isActivityCompletionEnabled() : bool
- Check if completion of lead activities is enabled.
- isFinished() : bool
- Check if current phase is final.
- mapEntityFields() : array<string|int, mixed>
- Map entity fields to specified type.
- moveToNextPhase() : bool
- Try to move converter to next phase
- unbindChildEntities() : void
- Remove all lead's bindings from all child entities (bound to current Lead).
Methods
__construct()
public
__construct([EntityConversionConfig $config = null ][, ConvertEventsContainer|null $convertEventsContainer = null ]) : mixed
Parameters
- $config : EntityConversionConfig = null
- $convertEventsContainer : ConvertEventsContainer|null = null
enableActivityCompletion()
Enable/disable completion of lead activities.
public
enableActivityCompletion(bool $enable) : mixed
Completion of activities is performed then lead goes into final status.
Parameters
- $enable : bool
-
Flag of enabling completion of lead activities.
executePhase()
Try to execute current conversion phase.
public
executePhase() : bool
Tags
Return values
boolgetAnalytics()
public
getAnalytics() : ConvertEvent|null
Return values
ConvertEvent|nullgetEntityTypeID()
Get converter entity type ID.
public
getEntityTypeID() : int
Return values
intgetMap()
Get conversion map for for specified entity type.
public
static getMap(int $entityTypeID) : EntityConversionMap
Try to load saved map. If map is not found then default map will be created.
Parameters
- $entityTypeID : int
-
Entity Type ID.
Tags
Return values
EntityConversionMapgetMapper()
Get conversion mapper
public
getMapper() : LeadConversionMapper|null
Return values
LeadConversionMapper|nullgetSupportedDestinationTypeIDs()
Get Supported Destination Types
public
getSupportedDestinationTypeIDs() : array<string|int, mixed>
Return values
array<string|int, mixed>initialize()
Initialize converter.
public
initialize() : void
Tags
isActivityCompletionEnabled()
Check if completion of lead activities is enabled.
public
isActivityCompletionEnabled() : bool
Completion of activities is performed then lead goes into final status. It is enabled by default.
Return values
boolisFinished()
Check if current phase is final.
public
isFinished() : bool
Return values
boolmapEntityFields()
Map entity fields to specified type.
public
mapEntityFields(int $entityTypeID[, array<string|int, mixed>|null $options = null ]) : array<string|int, mixed>
Parameters
- $entityTypeID : int
-
Entity type ID.
- $options : array<string|int, mixed>|null = null
-
Mapping options.
Tags
Return values
array<string|int, mixed>moveToNextPhase()
Try to move converter to next phase
public
moveToNextPhase() : bool
Return values
boolunbindChildEntities()
Remove all lead's bindings from all child entities (bound to current Lead).
public
unbindChildEntities() : void
Following child entity types will be processed: Contact, Company and Deal.