Bitrix API

DuplicateCommunicationCriterion extends DuplicateCriterion

Table of Contents

Methods

__construct()  : mixed
bulkRegister()  : mixed
checkIndex()  : mixed
createDuplicate()  : Duplicate
createFromMatches()  : mixed
equals()  : mixed
extractMultifieldsValues()  : mixed
find()  : mixed
getActualCount()  : mixed
getAllSupportedDedupeTypes()  : array<string|int, mixed>
getCategoryId()  : int|null
getCommunicationType()  : mixed
getEntityIDs()  : mixed
getHiddenSupportedDedupeTypes()  : mixed
getIndexTypeID()  : mixed
getMatchDescription()  : mixed
getMatches()  : mixed
getMatchHash()  : mixed
getMultifieldsValues()  : mixed
getRegisteredCodes()  : mixed
getRegisteredEntityMatches()  : mixed
getRegisteredTypes()  : mixed
getScope()  : mixed
getSummary()  : mixed
getSupportedDedupeTypes()  : array<string|int, mixed>
Get types supported by deduplication system.
getTextTotals()  : mixed
getTypeName()  : mixed
getValue()  : mixed
isEmpty()  : bool
isStrictComparison()  : mixed
limitByAssignedUser()  : bool
loadEntitiesMatches()  : mixed
loadEntityMatches()  : mixed
normalizePhone()  : mixed
prepareBatchEntityMultifieldValues()  : mixed
prepareBulkData()  : mixed
prepareCode()  : mixed
prepareCodes()  : mixed
prepareEntityMultifieldValues()  : mixed
prepareMatchHash()  : mixed
prepareSearchQuery()  : Query
Prepare duplicate search query
prepareSortParams()  : mixed
processMultifieldsChange()  : mixed
register()  : mixed
resolveTypeByIndexTypeID()  : mixed
sanitizePhone()  : mixed
setCategoryId()  : void
setCommunicationType()  : mixed
setLimitByAssignedUser()  : void
setStrictComparison()  : mixed
setValue()  : mixed
sortDescendingByEntityTypeId()  : $this
Sort descending by entity ID.
unregister()  : mixed

Methods

__construct()

public __construct(mixed $communicationType, mixed $value) : mixed
Parameters
$communicationType : mixed
$value : mixed

bulkRegister()

public static bulkRegister(mixed $entityTypeID, mixed $entityID, array<string|int, mixed> $data[, mixed $isRaw = true ]) : mixed
Parameters
$entityTypeID : mixed
$entityID : mixed
$data : array<string|int, mixed>
$isRaw : mixed = true

createDuplicate()

public createDuplicate(mixed $entityTypeID, mixed $rootEntityID, mixed $userID, mixed $enablePermissionCheck, mixed $enableRanking[, mixed $limit = 0 ]) : Duplicate
Parameters
$entityTypeID : mixed
$rootEntityID : mixed
$userID : mixed
$enablePermissionCheck : mixed
$enableRanking : mixed
$limit : mixed = 0
Return values
Duplicate

createFromMatches()

public static createFromMatches(array<string|int, mixed> $matches) : mixed
Parameters
$matches : array<string|int, mixed>

extractMultifieldsValues()

public static extractMultifieldsValues(array<string|int, mixed> $multifields, mixed $type[, mixed $valueType = '' ]) : mixed
Parameters
$multifields : array<string|int, mixed>
$type : mixed
$valueType : mixed = ''

find()

public find([mixed $entityTypeID = CCrmOwnerType::Undefined ][, mixed $limit = 50 ]) : mixed
Parameters
$entityTypeID : mixed = CCrmOwnerType::Undefined
$limit : mixed = 50

getActualCount()

public getActualCount(mixed $entityTypeID, mixed $rootEntityID, mixed $userID[, mixed $enablePermissionCheck = false ][, mixed $limit = 0 ]) : mixed
Parameters
$entityTypeID : mixed
$rootEntityID : mixed
$userID : mixed
$enablePermissionCheck : mixed = false
$limit : mixed = 0

getAllSupportedDedupeTypes()

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

getEntityIDs()

public getEntityIDs(mixed $entityTypeID, mixed $rootEntityID, mixed $userID, mixed $enablePermissionCheck[, array<string|int, mixed> $options = null ]) : mixed
Parameters
$entityTypeID : mixed
$rootEntityID : mixed
$userID : mixed
$enablePermissionCheck : mixed
$options : array<string|int, mixed> = null

getMultifieldsValues()

public static getMultifieldsValues(array<string|int, mixed> $multifields, mixed $communicationType) : mixed
Parameters
$multifields : array<string|int, mixed>
$communicationType : mixed

getRegisteredCodes()

public static getRegisteredCodes(mixed $entityTypeID, mixed $entityID[, mixed $enablePermissionCheck = false ][, mixed $userID = 0 ][, mixed $limit = 50 ]) : mixed
Parameters
$entityTypeID : mixed
$entityID : mixed
$enablePermissionCheck : mixed = false
$userID : mixed = 0
$limit : mixed = 50

getRegisteredEntityMatches()

public static getRegisteredEntityMatches(mixed $entityTypeID, mixed $entityID[, mixed $type = '' ]) : mixed
Parameters
$entityTypeID : mixed
$entityID : mixed
$type : mixed = ''

getRegisteredTypes()

public static getRegisteredTypes(mixed $entityTypeID, mixed $entityID) : mixed
Parameters
$entityTypeID : mixed
$entityID : mixed

getSupportedDedupeTypes()

Get types supported by deduplication system.

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

isEmpty()

public isEmpty(int $entityTypeId, int $rootEntityId, mixed $userId[, bool $enablePermissionCheck = false ]) : bool
Parameters
$entityTypeId : int
$rootEntityId : int
$userId : mixed
$enablePermissionCheck : bool = false
Return values
bool

loadEntitiesMatches()

public static loadEntitiesMatches(mixed $entityTypeID, array<string|int, mixed> $entityIDs, mixed $communicationType) : mixed
Parameters
$entityTypeID : mixed
$entityIDs : array<string|int, mixed>
$communicationType : mixed

loadEntityMatches()

public static loadEntityMatches(mixed $entityTypeID, mixed $entityID, mixed $communicationType) : mixed
Parameters
$entityTypeID : mixed
$entityID : mixed
$communicationType : mixed

prepareBatchEntityMultifieldValues()

public static prepareBatchEntityMultifieldValues(mixed $entityTypeID, array<string|int, mixed> $entityIDs) : mixed
Parameters
$entityTypeID : mixed
$entityIDs : array<string|int, mixed>

prepareBulkData()

public static prepareBulkData(array<string|int, mixed> $multifields) : mixed
Parameters
$multifields : array<string|int, mixed>

prepareCode()

public static prepareCode(mixed $communicationType, mixed $value) : mixed
Parameters
$communicationType : mixed
$value : mixed

prepareCodes()

public static prepareCodes(mixed $communicationType, array<string|int, mixed> $values) : mixed
Parameters
$communicationType : mixed
$values : array<string|int, mixed>

prepareEntityMultifieldValues()

public static prepareEntityMultifieldValues(mixed $entityTypeID, mixed $entityID[, array<string|int, mixed> $options = null ]) : mixed
Parameters
$entityTypeID : mixed
$entityID : mixed
$options : array<string|int, mixed> = null

prepareMatchHash()

public static prepareMatchHash(array<string|int, mixed> $matches) : mixed
Parameters
$matches : array<string|int, mixed>

prepareSearchQuery()

Prepare duplicate search query

public prepareSearchQuery([CCrmOwnerType $entityTypeID = CCrmOwnerType::Undefined ][, array<string|int, mixed> $select = null ][, array<string|int, mixed> $order = null ][, int $limit = 0 ]) : Query
Parameters
$entityTypeID : CCrmOwnerType = CCrmOwnerType::Undefined

Target Entity Type ID

$select : array<string|int, mixed> = null
$order : array<string|int, mixed> = null
$limit : int = 0

Limit of result query

Tags
throws
ArgumentTypeException
throws
InvalidOperationException
Return values
Query

prepareSortParams()

public static prepareSortParams(mixed $entityTypeID, array<string|int, mixed> $entityIDs[, mixed $type = '' ]) : mixed
Parameters
$entityTypeID : mixed
$entityIDs : array<string|int, mixed>
$type : mixed = ''

processMultifieldsChange()

public static processMultifieldsChange(mixed $entityTypeID, mixed $entityID) : mixed
Parameters
$entityTypeID : mixed
$entityID : mixed

register()

public static register(mixed $entityTypeID, mixed $entityID, mixed $type, array<string|int, mixed> $values[, mixed $isRaw = true ]) : mixed
Parameters
$entityTypeID : mixed
$entityID : mixed
$type : mixed
$values : array<string|int, mixed>
$isRaw : mixed = true

setCategoryId()

public setCategoryId(int|null $categoryId) : void
Parameters
$categoryId : int|null

setLimitByAssignedUser()

public setLimitByAssignedUser(bool $limitByAssignedUser) : void
Parameters
$limitByAssignedUser : bool

setStrictComparison()

public setStrictComparison(mixed $useStrictComparison) : mixed
Parameters
$useStrictComparison : mixed

sortDescendingByEntityTypeId()

Sort descending by entity ID.

public sortDescendingByEntityTypeId([bool $mode = true ]) : $this
Parameters
$mode : bool = true

Mode.

Return values
$this

unregister()

public static unregister(mixed $entityTypeID, mixed $entityID[, mixed $type = '' ]) : mixed
Parameters
$entityTypeID : mixed
$entityID : mixed
$type : mixed = '' 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results