Bitrix API

DuplicateVolatileCriterion extends DuplicateCriterion

Table of Contents

Methods

__construct()  : mixed
checkIndex()  : bool
createDuplicate()  : Duplicate
createFromMatches()  : DuplicateVolatileCriterion
equals()  : bool
find()  : Duplicate|null
getActualCount()  : mixed
getAllSupportedDedupeTypes()  : array<string|int, mixed>
getCategoryId()  : int|null
getEntityIDs()  : mixed
getEntityTypeId()  : int
getHiddenSupportedDedupeTypes()  : mixed
getIndexTypeID()  : int
getMatchDescription()  : string
getMatches()  : array<string|int, mixed>
getMatchHash()  : string
getMatchName()  : string
getRegisteredEntityMatches()  : array<string|int, mixed>
getScope()  : mixed
getSummary()  : string|null
getSupportedDedupeTypes()  : array<string|int, mixed>
getSupportedEntityTypes()  : array<string|int, mixed>
getTextTotals()  : string|null
getTypeName()  : string
getValue()  : string
getVolatileTypeId()  : int
isEmpty()  : bool
isNull()  : bool
isStrictComparison()  : mixed
isSupportedType()  : bool
limitByAssignedUser()  : bool
loadEntityMatches()  : array<string|int, mixed>
prepareCode()  : string
prepareCodes()  : array<string|int, mixed>
prepareMatchHash()  : mixed
prepareSearchQuery()  : Query
Prepare duplicate search query
prepareSortParams()  : array<string|int, mixed>
register()  : mixed
setCategoryId()  : void
setLimitByAssignedUser()  : void
setStrictComparison()  : mixed
setValue()  : mixed
sortDescendingByEntityTypeId()  : $this
Sort descending by entity ID.
unregister()  : mixed

Methods

__construct()

public __construct(int $volatileTypeId[, string $value = '' ]) : mixed
Parameters
$volatileTypeId : int
$value : string = ''

checkIndex()

public static checkIndex(array<string|int, mixed> $params) : bool
Parameters
$params : array<string|int, mixed>
Return values
bool

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

find()

public find([mixed $entityTypeID = CCrmOwnerType::Undefined ][, mixed $limit = 50 ]) : Duplicate|null
Parameters
$entityTypeID : mixed = CCrmOwnerType::Undefined
$limit : mixed = 50
Return values
Duplicate|null

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

getHiddenSupportedDedupeTypes()

public static getHiddenSupportedDedupeTypes() : mixed

getRegisteredEntityMatches()

public static getRegisteredEntityMatches(int $entityTypeID, int $entityID[, int $volatileTypeId = DuplicateIndexType::UNDEFINED ]) : array<string|int, mixed>
Parameters
$entityTypeID : int
$entityID : int
$volatileTypeId : int = DuplicateIndexType::UNDEFINED
Return values
array<string|int, mixed>

getSupportedDedupeTypes()

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

getSupportedEntityTypes()

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

getTextTotals()

public getTextTotals(mixed $count[, mixed $limit = 0 ]) : string|null
Parameters
$count : mixed
$limit : mixed = 0
Return values
string|null

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

isSupportedType()

public static isSupportedType(int $volatileTypeId) : bool
Parameters
$volatileTypeId : int
Return values
bool

loadEntityMatches()

public static loadEntityMatches(mixed $entityTypeId, mixed $entityId, mixed $volatileTypeId) : array<string|int, mixed>
Parameters
$entityTypeId : mixed
$entityId : mixed
$volatileTypeId : mixed
Return values
array<string|int, mixed>

prepareCode()

public static prepareCode(int $volatileTypeId, string $value) : string
Parameters
$volatileTypeId : int
$value : string
Return values
string

prepareCodes()

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

prepareMatchHash()

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

prepareSearchQuery()

Prepare duplicate search query

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

Target Entity Type ID

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

Limit of result query

Return values
Query

prepareSortParams()

public static prepareSortParams(int $entityTypeID, array<string|int, mixed> $entityIDs[, int $volatileTypeId = DuplicateIndexType::UNDEFINED ]) : array<string|int, mixed>
Parameters
$entityTypeID : int
$entityIDs : array<string|int, mixed>
$volatileTypeId : int = DuplicateIndexType::UNDEFINED
Return values
array<string|int, mixed>

register()

public static register(int $entityTypeId, int $entityId[, array<string|int, mixed> $fieldCategoryIds = [] ][, array<string|int, mixed> $volatileTypes = [] ]) : mixed
Parameters
$entityTypeId : int
$entityId : int
$fieldCategoryIds : array<string|int, mixed> = []
$volatileTypes : array<string|int, mixed> = []

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(int $entityTypeId, int $entityId[, int $volatileTypeId = DuplicateIndexType::UNDEFINED ]) : mixed
Parameters
$entityTypeId : int
$entityId : int
$volatileTypeId : int = DuplicateIndexType::UNDEFINED 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results