Bitrix API

QuoteConverter extends EntityConverter

Table of Contents

Methods

__construct()  : mixed
executePhase()  : bool
Try to execute current conversion phase.
getEntityTypeID()  : int
Get converter entity type ID.
getMap()  : EntityConversionMap
Get conversion map for for specified entity type.
getMapper()  : QuoteConversionMapper|null
Get conversion mapper
getSupportedDestinationTypeIDs()  : array<string|int, mixed>
Get Supported Destination Types.
initialize()  : void
Initialize converter.
isAttachingSourceActivitiesEnabled()  : bool
Returns true if activities from Quote entity should be copied to destination entity
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

Methods

__construct()

public __construct([EntityConversionConfig $config = null ]) : mixed
Parameters
$config : EntityConversionConfig = null

executePhase()

Try to execute current conversion phase.

public executePhase() : bool
Tags
throws
EntityConversionException

If mapper return empty fields.

throws
EntityConversionException

If target entity is not found.

throws
EntityConversionException

If target entity fields are invalid.

throws
EntityConversionException

If target entity has bizproc workflows.

throws
EntityConversionException

If target entity creation is failed.

throws
EntityConversionException

If target entity update permission is denied.

Return values
bool

getEntityTypeID()

Get converter entity type ID.

public getEntityTypeID() : int
Return values
int

getMap()

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.

Return values
EntityConversionMap

getSupportedDestinationTypeIDs()

Get Supported Destination Types.

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

initialize()

Initialize converter.

public initialize() : void
Tags
throws
EntityConversionException

If entity is not exist.

throws
EntityConversionException

If read or update permissions are denied.

isAttachingSourceActivitiesEnabled()

Returns true if activities from Quote entity should be copied to destination entity

public isAttachingSourceActivitiesEnabled() : bool
Return values
bool

isFinished()

Check if current phase is final.

public isFinished() : bool
Return values
bool

mapEntityFields()

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.

Return values
array<string|int, mixed>

moveToNextPhase()

Try to move converter to next phase

public moveToNextPhase() : bool
Return values
bool

        
On this page

Search results