Bitrix API

LeadConversionWizard extends EntityConversionWizard

Table of Contents

Constants

QUERY_PARAM_SOURCE_ID  = 'conv_source_id'
QUERY_PARAM_SOURCE_TYPE_ID  = 'conv_source_type_id'

Properties

$converter  : EntityConverter|null

Methods

__construct()  : mixed
attachNewlyCreatedEntity()  : mixed
createFromExternalized()  : self|null
enableActivityCompletion()  : mixed
Enable/disable completion of lead activities.
enableBizProcCheck()  : mixed
Enable/disable checking for parametrized business process.
enableUserFieldCheck()  : mixed
Enable/disable User Field check.
execute()  : bool
Execute wizard.
externalize()  : mixed
fillDestinationItemWithDataFromSourceItem()  : void
getClientEventParams()  : array<string|int, mixed>|null
Get event params that must be risen on the client
getCurrentPhase()  : int
Get current converter phase.
getEditFormLegend()  : mixed
getEntityConfig()  : EntityConversionConfigItem|null
getEntityID()  : mixed
getEntityTypeID()  : mixed
getErrorText()  : mixed
getOriginUrl()  : mixed
getQueryParamSource()  : array<string|int, mixed>
getRedirectUrl()  : mixed
getResultData()  : array<string|int, mixed>
Get converter result data.
hasOriginUrl()  : mixed
internalize()  : mixed
isActivityCompletionEnabled()  : bool
Check if completion of lead activities is enabled.
isBizProcCheckEnabled()  : bool
Check if checking for parametrized business process is enabled.
isConvertingTo()  : bool
Returns true if the wizard with current configuration converts source item to the provided $dstEntityTypeId
isFinished()  : bool
Check if process is completed (converter is in final phase).
isNewApi()  : bool
isRedirectToShowEnabled()  : bool
Check if redirect to entity show page is enabled.
isSliderEnabled()  : bool
Check if slider mode is enabled.
isUserFieldCheckEnabled()  : bool
Check if User Field check is enabled.
load()  : LeadConversionWizard|null
Load wizard related to entity from session.
loadByIdentifier()  : self|null
mapEntityFields()  : mixed
prepareDataForEdit()  : void
Prepare entity fields for edit.
prepareDataForSave()  : void
Prepare entity fields for save.
prepareEditorContextParams()  : mixed
remove()  : mixed
removeByIdentifier()  : void
save()  : mixed
setOriginUrl()  : mixed
setRedirectToShowEnabled()  : mixed
Enable or disable redirect to entity show page.
setSkipBizProcAutoStart()  : mixed
Enable/disable auto start BP after update
setSkipMultipleUserFields()  : EntityConversionWizard
setSliderEnabled()  : mixed
Enable or disable slider mode.
shouldSkipBizProcAutoStart()  : bool
Check should auto start BP after update.
undo()  : mixed

Constants

Properties

Methods

attachNewlyCreatedEntity()

public attachNewlyCreatedEntity(mixed $entityTypeName, mixed $entityID) : mixed
Parameters
$entityTypeName : mixed
$entityID : mixed

createFromExternalized()

public static createFromExternalized(array<string|int, mixed> $externalizedParams) : self|null
Parameters
$externalizedParams : array<string|int, mixed>
Return values
self|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.

enableBizProcCheck()

Enable/disable checking for parametrized business process.

public enableBizProcCheck(bool $enable) : mixed

Checking is performed before a creation operation.

Parameters
$enable : bool

Flag of enabling User Field checking.

enableUserFieldCheck()

Enable/disable User Field check.

public enableUserFieldCheck(bool $enable) : mixed

User Field checking is performed during a creation and update operation.

Parameters
$enable : bool

Flag of enabling User Field checking.

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
bool

fillDestinationItemWithDataFromSourceItem()

public fillDestinationItemWithDataFromSourceItem(Item $destinationItem) : void
Parameters
$destinationItem : Item

getClientEventParams()

Get event params that must be risen on the client

public getClientEventParams() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

getCurrentPhase()

Get current converter phase.

public getCurrentPhase() : int
Return values
int

getQueryParamSource()

public static getQueryParamSource() : array<string|int, mixed>
Return values
array<string|int, mixed>

getResultData()

Get converter result data.

public getResultData() : array<string|int, mixed>
Return values
array<string|int, mixed>

internalize()

public internalize(array<string|int, mixed> $params) : mixed
Parameters
$params : array<string|int, mixed>

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
bool

isBizProcCheckEnabled()

Check if checking for parametrized business process is enabled.

public isBizProcCheckEnabled() : bool

Checking is performed before a creation operation. It is enabled by default.

Return values
bool

isConvertingTo()

Returns true if the wizard with current configuration converts source item to the provided $dstEntityTypeId

public isConvertingTo(int $dstEntityTypeId) : bool
Parameters
$dstEntityTypeId : int
Return values
bool

isFinished()

Check if process is completed (converter is in final phase).

public isFinished() : bool
Return values
bool

isRedirectToShowEnabled()

Check if redirect to entity show page is enabled.

public isRedirectToShowEnabled() : bool
Return values
bool

isSliderEnabled()

Check if slider mode is enabled.

public isSliderEnabled() : bool
Return values
bool

isUserFieldCheckEnabled()

Check if User Field check is enabled.

public isUserFieldCheckEnabled() : bool

User Field checking is performed during a creation and update operation.

Return values
bool

loadByIdentifier()

public static loadByIdentifier(ItemIdentifier $source) : self|null
Parameters
$source : ItemIdentifier
Return values
self|null

mapEntityFields()

public mapEntityFields(mixed $entityTypeID, array<string|int, mixed> $options) : mixed
Parameters
$entityTypeID : mixed
$options : array<string|int, mixed>

prepareDataForEdit()

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.

prepareEditorContextParams()

public prepareEditorContextParams(mixed $targetEntityTypeID) : mixed
Parameters
$targetEntityTypeID : mixed

remove()

public static remove(mixed $entityID) : mixed
Parameters
$entityID : mixed
Tags
inheritDoc

removeByIdentifier()

public static removeByIdentifier(ItemIdentifier $source) : void
Parameters
$source : ItemIdentifier

setRedirectToShowEnabled()

Enable or disable redirect to entity show page.

public setRedirectToShowEnabled(bool $enabled) : mixed
Parameters
$enabled : bool

setSkipBizProcAutoStart()

Enable/disable auto start BP after update

public setSkipBizProcAutoStart(bool $enable) : mixed
Parameters
$enable : bool

Flag of enabling User Field checking.

setSliderEnabled()

Enable or disable slider mode.

public setSliderEnabled(bool $enabled) : mixed
Parameters
$enabled : bool

shouldSkipBizProcAutoStart()

Check should auto start BP after update.

public shouldSkipBizProcAutoStart() : bool
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results