LeadConversionWizard extends EntityConversionWizard
Table of Contents
Methods
- __construct() : mixed
- enableActivityCompletion() : mixed
- Enable/disable completion of lead activities.
- execute() : bool
- Execute wizard.
- isActivityCompletionEnabled() : bool
- Check if completion of lead activities is enabled.
- isNewApi() : bool
- load() : LeadConversionWizard|null
- Load wizard related to entity from session.
- prepareDataForEdit() : void
- Prepare entity fields for edit.
- prepareDataForSave() : void
- Prepare entity fields for save.
- remove() : mixed
- undo() : mixed
Methods
__construct()
public
__construct([int $entityID = 0 ][, LeadConversionConfig|null $config = null ][, ConvertEventsContainer|null $convertEventsContainer = null ]) : mixed
Parameters
- $entityID : int = 0
-
Entity ID.
- $config : LeadConversionConfig|null = null
-
Configuration parameters.
- $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.
execute()
Execute wizard.
public
execute([array<string|int, mixed>|null $contextData = null ]) : bool
Parameters
- $contextData : array<string|int, mixed>|null = null
-
Conversion context data.
Return values
boolisActivityCompletionEnabled()
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
boolisNewApi()
public
isNewApi() : bool
Return values
boolload()
Load wizard related to entity from session.
public
static load(int $entityID) : LeadConversionWizard|null
Parameters
- $entityID : int
-
Entity ID.
Return values
LeadConversionWizard|nullprepareDataForEdit()
Prepare entity fields for edit.
public
prepareDataForEdit(int $entityTypeID, array<string|int, mixed> &$fields[, bool|true $encode = true ]) : void
Parameters
- $entityTypeID : int
-
Entity type ID.
- $fields : array<string|int, mixed>
-
Entity fields.
- $encode : bool|true = true
-
Encode fields flag.
prepareDataForSave()
Prepare entity fields for save.
public
prepareDataForSave(int $entityTypeID, array<string|int, mixed> &$fields) : void
Parameters
- $entityTypeID : int
-
Entity type ID.
- $fields : array<string|int, mixed>
-
Entity fields.
remove()
public
static remove(mixed $entityID) : mixed
Parameters
- $entityID : mixed
Tags
undo()
public
undo() : mixed