DuplicateCriterion
AbstractYes
Table of Contents
Methods
- checkIndex() : mixed
- createDuplicate() : Duplicate
- equals() : mixed
- find() : mixed
- getActualCount() : mixed
- getAllSupportedDedupeTypes() : array<string|int, mixed>
- getCategoryId() : int|null
- getEntityIDs() : mixed
- getHiddenSupportedDedupeTypes() : mixed
- getIndexTypeID() : mixed
- getMatchDescription() : mixed
- getMatches() : mixed
- getMatchHash() : mixed
- getRegisteredEntityMatches() : mixed
- getScope() : mixed
- getSummary() : mixed
- getSupportedDedupeTypes() : mixed
- getTextTotals() : mixed
- getTypeName() : mixed
- isEmpty() : bool
- isStrictComparison() : mixed
- limitByAssignedUser() : bool
- prepareMatchHash() : mixed
- prepareSearchQuery() : Query
- Prepare duplicate search query
- prepareSortParams() : mixed
- setCategoryId() : void
- setLimitByAssignedUser() : void
- setStrictComparison() : mixed
- sortDescendingByEntityTypeId() : $this
- Sort descending by entity ID.
Methods
checkIndex()
public
static checkIndex(array<string|int, mixed> $params) : mixed
Parameters
- $params : array<string|int, mixed>
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
Duplicateequals()
public
abstract equals(DuplicateCriterion $item) : mixed
Parameters
- $item : DuplicateCriterion
find()
public
abstract 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>getCategoryId()
public
getCategoryId() : int|null
Return values
int|nullgetEntityIDs()
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
getIndexTypeID()
public
abstract getIndexTypeID() : mixed
getMatchDescription()
public
abstract getMatchDescription() : mixed
getMatches()
public
abstract getMatches() : mixed
getMatchHash()
public
abstract getMatchHash() : mixed
getRegisteredEntityMatches()
public
static getRegisteredEntityMatches(int $entityTypeID, int $entityID) : mixed
Parameters
- $entityTypeID : int
- $entityID : int
getScope()
public
getScope() : mixed
getSummary()
public
getSummary() : mixed
getSupportedDedupeTypes()
public
static getSupportedDedupeTypes() : mixed
getTextTotals()
public
abstract getTextTotals(mixed $count[, mixed $limit = 0 ]) : mixed
Parameters
- $count : mixed
- $limit : mixed = 0
getTypeName()
public
abstract getTypeName() : 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
boolisStrictComparison()
public
isStrictComparison() : mixed
limitByAssignedUser()
public
limitByAssignedUser() : bool
Return values
boolprepareMatchHash()
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
Return values
QueryprepareSortParams()
public
static prepareSortParams(int $entityTypeID, array<string|int, mixed> $entityIDs) : mixed
Parameters
- $entityTypeID : int
- $entityIDs : 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.