Bitrix API

UserFieldSynchronizer uses VisibilityConfig

Table of Contents

Properties

$existedFieldNameMap  : array<string|int, mixed>|null

Methods

getDifference()  : mixed
getFieldComplianceCode()  : mixed
getFieldLabel()  : mixed
getHistoryItem()  : mixed
getInstance()  : mixed
getIntersection()  : array<string|int, mixed>
Compares source type fields with destination type fields.
getSynchronizationFields()  : array<string|int, mixed>
Prepare synchronization field list.
isUserFieldTypeSupported()  : mixed
markAsSynchronized()  : mixed
needForSynchronization()  : bool
Check if destination type fields need for synchronization with source fields.
prepareEntityFieldVisibilityConfigs()  : array<string|int, mixed>
removeHistoryItem()  : mixed
setHistoryItem()  : mixed
synchronize()  : array<string|int, mixed>
Synchronize source type fields with destination type fields.

Properties

$existedFieldNameMap

public static array<string|int, mixed>|null $existedFieldNameMap = array()

Methods

getDifference()

public static getDifference(mixed $srcEntityTypeID, mixed $dstEntityTypeID[, mixed $languageID = '' ]) : mixed
Parameters
$srcEntityTypeID : mixed
$dstEntityTypeID : mixed
$languageID : mixed = ''

getFieldComplianceCode()

public static getFieldComplianceCode(array<string|int, mixed> $field) : mixed
Parameters
$field : array<string|int, mixed>

getFieldLabel()

public static getFieldLabel(array<string|int, mixed> $field) : mixed
Parameters
$field : array<string|int, mixed>

getHistoryItem()

public static getHistoryItem(mixed $srcEntityTypeID, mixed $dstEntityTypeID) : mixed
Parameters
$srcEntityTypeID : mixed
$dstEntityTypeID : mixed

getIntersection()

Compares source type fields with destination type fields.

public static getIntersection(int $srcEntityTypeID, int $dstEntityTypeID[, string $languageID = '' ]) : array<string|int, mixed>

Matches are searched by comparing field labels.

Parameters
$srcEntityTypeID : int

Source Entity Type ID

$dstEntityTypeID : int

Destination Entity Type ID

$languageID : string = ''

Language

Tags
static
Return values
array<string|int, mixed>

getSynchronizationFields()

Prepare synchronization field list.

public static getSynchronizationFields(int $srcEntityTypeID, int $dstEntityTypeID[, string $languageID = '' ][, mixed $forced = false ][, mixed $isRecycling = false ]) : array<string|int, mixed>
Parameters
$srcEntityTypeID : int

Source Entity Type ID

$dstEntityTypeID : int

Destination Entity Type ID

$languageID : string = ''

Language

$forced : mixed = false
$isRecycling : mixed = false
Tags
static
Return values
array<string|int, mixed>

isUserFieldTypeSupported()

public static isUserFieldTypeSupported(mixed $userFieldTypeID) : mixed
Parameters
$userFieldTypeID : mixed

markAsSynchronized()

public static markAsSynchronized(mixed $srcEntityTypeID, mixed $dstEntityTypeID) : mixed
Parameters
$srcEntityTypeID : mixed
$dstEntityTypeID : mixed

needForSynchronization()

Check if destination type fields need for synchronization with source fields.

public static needForSynchronization(int $srcEntityTypeID, int $dstEntityTypeID[, string $languageID = '' ][, array<string|int, mixed> $options = array() ]) : bool

Matches are searched by comparing field labels.

Parameters
$srcEntityTypeID : int

Source Entity Type ID

$dstEntityTypeID : int

Destination Entity Type ID

$languageID : string = ''

Language

$options : array<string|int, mixed> = array()

Operation options

Tags
static
Return values
bool

prepareEntityFieldVisibilityConfigs()

public prepareEntityFieldVisibilityConfigs(mixed $entityTypeId) : array<string|int, mixed>
Parameters
$entityTypeId : mixed
Tags
throws
ArgumentException
Return values
array<string|int, mixed>

removeHistoryItem()

public static removeHistoryItem(mixed $srcEntityTypeID, mixed $dstEntityTypeID) : mixed
Parameters
$srcEntityTypeID : mixed
$dstEntityTypeID : mixed

setHistoryItem()

public static setHistoryItem(mixed $srcEntityTypeID, mixed $dstEntityTypeID, array<string|int, mixed> $historyItem) : mixed
Parameters
$srcEntityTypeID : mixed
$dstEntityTypeID : mixed
$historyItem : array<string|int, mixed>

synchronize()

Synchronize source type fields with destination type fields.

public static synchronize(int $srcEntityTypeID, int $dstEntityTypeID[, string $languageID = '' ][, array<string|int, mixed> $filter = array() ][, array<string|int, mixed> $options = array() ]) : array<string|int, mixed>

Matches are searched by comparing field labels. If a source field is not found in the destination type, it will be created there.

Parameters
$srcEntityTypeID : int

Source Entity Type ID

$dstEntityTypeID : int

Destination Entity Type ID

$languageID : string = ''

Language

$filter : array<string|int, mixed> = array()

Filter

$options : array<string|int, mixed> = array()

Operation options

Tags
static
throws
ObjectException
throws
UserFieldSynchronizationException
Return values
array<string|int, mixed> —

$synchronizedFieldNameMap


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results