Bitrix API

CAllCrmContact uses UserFieldPreparer, EntityFieldsNormalizer

Table of Contents

Constants

CACHE_TTL  = 3600
DEFAULT_FORM_ID  = 'CRM_CONTACT_SHOW_V12'
SUSPENDED_USER_FIELD_ENTITY_ID  = 'CRM_CONTACT_SPD'
TABLE_ALIAS  = 'L'
TOTAL_COUNT_CACHE_ID  = 'crm_contact_total_count'
USER_FIELD_ENTITY_ID  = 'CRM_CONTACT'

Properties

$LAST_ERROR  : mixed
$sUFEntityID  : mixed

Methods

__AfterPrepareSql()  : mixed
__construct()  : mixed
Add()  : mixed
BuildEntityAttr()  : mixed
BuildPermSql()  : mixed
CheckCreatePermission()  : mixed
CheckDeletePermission()  : mixed
CheckExportPermission()  : mixed
CheckFields()  : mixed
CheckImportPermission()  : mixed
CheckReadPermission()  : mixed
CheckUpdatePermission()  : mixed
CompareFields()  : mixed
CreateListBuilder()  : mixed
CreateRequisite()  : mixed
Delete()  : mixed
Exists()  : mixed
GetByID()  : mixed
GetCheckExceptions()  : mixed
GetContactByCompanyID()  : CDBResult
GetCount()  : mixed
GetDefaultName()  : mixed
GetDefaultTitle()  : mixed
GetDefaultTitleTemplate()  : mixed
GetFieldCaption()  : mixed
GetFields()  : mixed
GetFieldsInfo()  : mixed
GetFullName()  : mixed
getLastError()  : string
GetLeftSiblingID()  : mixed
GetList()  : CDBResult
GetListEx()  : mixed
GetRightSiblingID()  : mixed
GetTopIDs()  : mixed
GetTopIDsInCategory()  : mixed
GetTotalCount()  : mixed
GetUserFieldEntityID()  : mixed
GetUserFields()  : mixed
isDefaultName()  : bool
Indicates if a contact has default name
isUseOperation()  : bool
Returns true if this class should invoke Service\Operation instead old API.
PrepareFilter()  : mixed
PrepareFormattedName()  : mixed
ProcessCompanyDeletion()  : mixed
ProcessLeadDeletion()  : mixed
Rebind()  : mixed
RebuildDuplicateIndex()  : mixed
RebuildEntityAccessAttrs()  : mixed
ReleaseExternalResources()  : mixed
SynchronizeMultifieldMarkers()  : mixed
Update()  : mixed
UpdateCompanyID()  : bool

Constants

DEFAULT_FORM_ID

public mixed DEFAULT_FORM_ID = 'CRM_CONTACT_SHOW_V12'

SUSPENDED_USER_FIELD_ENTITY_ID

public mixed SUSPENDED_USER_FIELD_ENTITY_ID = 'CRM_CONTACT_SPD'

TOTAL_COUNT_CACHE_ID

public mixed TOTAL_COUNT_CACHE_ID = 'crm_contact_total_count'

USER_FIELD_ENTITY_ID

public mixed USER_FIELD_ENTITY_ID = 'CRM_CONTACT'

Properties

$sUFEntityID

public static mixed $sUFEntityID = 'CRM_CONTACT'

Methods

__AfterPrepareSql()

public static __AfterPrepareSql(mixed $sender, mixed $arOrder, mixed $arFilter, mixed $arGroupBy, mixed $arSelectFields) : mixed
Parameters
$sender : mixed
$arOrder : mixed
$arFilter : mixed
$arGroupBy : mixed
$arSelectFields : mixed

__construct()

public __construct([mixed $bCheckPermission = true ]) : mixed
Parameters
$bCheckPermission : mixed = true

Add()

public Add(array<string|int, mixed> &$arFields[, mixed $bUpdateSearch = true ][, mixed $options = array() ]) : mixed
Parameters
$arFields : array<string|int, mixed>
$bUpdateSearch : mixed = true
$options : mixed = array()

BuildEntityAttr()

public static BuildEntityAttr(mixed $userID[, mixed $arAttr = array() ]) : mixed
Parameters
$userID : mixed
$arAttr : mixed = array()

BuildPermSql()

public static BuildPermSql([mixed $sAliasPrefix = 'L' ][, mixed $mPermType = 'READ' ][, mixed $arOptions = [] ]) : mixed
Parameters
$sAliasPrefix : mixed = 'L'
$mPermType : mixed = 'READ'
$arOptions : mixed = []

CheckCreatePermission()

public static CheckCreatePermission([mixed $userPermissions = null ][, int $categoryId = 0 ]) : mixed
Parameters
$userPermissions : mixed = null
$categoryId : int = 0
Tags
see

\Bitrix\Crm\Service\Container::getInstance()->getUserPermissions()->entityType()->canAddItems()

CheckDeletePermission()

public static CheckDeletePermission(mixed $id[, mixed $userPermissions = null ][, int|null $categoryId = null ]) : mixed
Parameters
$id : mixed
$userPermissions : mixed = null
$categoryId : int|null = null
Tags
see

\Bitrix\Crm\Service\Container::getInstance()->getUserPermissions()->item()->canDelete()

CheckExportPermission()

public static CheckExportPermission([mixed $userPermissions = null ][, int $categoryId = 0 ]) : mixed
Parameters
$userPermissions : mixed = null
$categoryId : int = 0
Tags
see

\Bitrix\Crm\Service\Container::getInstance()->getUserPermissions()->entityType()->canExportItems()

CheckFields()

public CheckFields(mixed &$arFields[, mixed $ID = false ][, mixed $options = array() ]) : mixed
Parameters
$arFields : mixed
$ID : mixed = false
$options : mixed = array()

CheckImportPermission()

public static CheckImportPermission([mixed $userPermissions = null ][, int $categoryId = 0 ]) : mixed
Parameters
$userPermissions : mixed = null
$categoryId : int = 0
Tags
see

\Bitrix\Crm\Service\Container::getInstance()->getUserPermissions()->entityType()->canImportItems()

CheckReadPermission()

public static CheckReadPermission([mixed $id = 0 ][, mixed $userPermissions = null ][, int|null $categoryId = null ]) : mixed
Parameters
$id : mixed = 0
$userPermissions : mixed = null
$categoryId : int|null = null
Tags
see

\Bitrix\Crm\Service\Container::getInstance()->getUserPermissions()->item()->canRead()

CheckUpdatePermission()

public static CheckUpdatePermission(mixed $id[, mixed $userPermissions = null ][, int|null $categoryId = null ]) : mixed
Parameters
$id : mixed
$userPermissions : mixed = null
$categoryId : int|null = null
Tags
see

\Bitrix\Crm\Service\Container::getInstance()->getUserPermissions()->item()->canUpdate()

CompareFields()

public static CompareFields(array<string|int, mixed> $arFieldsOrig, array<string|int, mixed> $arFieldsModif[, array<string|int, mixed> $arOptions = null ]) : mixed
Parameters
$arFieldsOrig : array<string|int, mixed>
$arFieldsModif : array<string|int, mixed>
$arOptions : array<string|int, mixed> = null

CreateListBuilder()

public static CreateListBuilder([array<string|int, mixed> $arFieldOptions = null ]) : mixed
Parameters
$arFieldOptions : array<string|int, mixed> = null

CreateRequisite()

public static CreateRequisite(mixed $ID, mixed $presetID) : mixed
Parameters
$ID : mixed
$presetID : mixed

Delete()

public Delete(mixed $ID[, mixed $arOptions = array() ]) : mixed
Parameters
$ID : mixed
$arOptions : mixed = array()

Exists()

public static Exists(mixed $ID) : mixed
Parameters
$ID : mixed

GetByID()

public static GetByID(mixed $ID[, mixed $bCheckPerms = true ]) : mixed
Parameters
$ID : mixed
$bCheckPerms : mixed = true

GetCheckExceptions()

public GetCheckExceptions() : mixed

GetContactByCompanyID()

public static GetContactByCompanyID(mixed $companyID) : CDBResult
Parameters
$companyID : mixed
Tags
see
ContactCompanyTable::getCompanyContactIDs
Return values
CDBResult

GetCount()

public static GetCount(mixed $arFilter) : mixed
Parameters
$arFilter : mixed

GetDefaultName()

public static GetDefaultName() : mixed

GetDefaultTitle()

public static GetDefaultTitle([mixed $number = '' ]) : mixed
Parameters
$number : mixed = ''

GetDefaultTitleTemplate()

public static GetDefaultTitleTemplate() : mixed

GetFieldCaption()

public static GetFieldCaption(mixed $fieldName) : mixed
Parameters
$fieldName : mixed

GetFields()

public static GetFields([mixed $arOptions = null ]) : mixed
Parameters
$arOptions : mixed = null

GetFieldsInfo()

public static GetFieldsInfo() : mixed

GetFullName()

public static GetFullName(mixed $arFields) : mixed
Parameters
$arFields : mixed

getLastError()

public getLastError() : string
Return values
string

GetLeftSiblingID()

public static GetLeftSiblingID(mixed $ID) : mixed
Parameters
$ID : mixed

GetList()

public static GetList([array<string|int, mixed> $arOrder = array('DATE_CREATE' => 'DESC') ][, array<string|int, mixed> $arFilter = array() ][, array<string|int, mixed> $arSelect = array() ][, mixed $nPageTop = false ]) : CDBResult
Parameters
$arOrder : array<string|int, mixed> = array('DATE_CREATE' => 'DESC')
$arFilter : array<string|int, mixed> = array()
$arSelect : array<string|int, mixed> = array()
$nPageTop : mixed = false
Return values
CDBResult

GetListEx()

public static GetListEx([mixed $arOrder = array() ][, mixed $arFilter = array() ][, mixed $arGroupBy = false ][, mixed $arNavStartParams = false ][, mixed $arSelectFields = array() ][, mixed $arOptions = array() ]) : mixed
Parameters
$arOrder : mixed = array()
$arFilter : mixed = array()
$arGroupBy : mixed = false
$arNavStartParams : mixed = false
$arSelectFields : mixed = array()
$arOptions : mixed = array()

GetRightSiblingID()

public static GetRightSiblingID(mixed $ID) : mixed
Parameters
$ID : mixed

GetTopIDs()

public static GetTopIDs(mixed $top[, mixed $sortType = 'ASC' ]) : mixed
Parameters
$top : mixed
$sortType : mixed = 'ASC'

GetTopIDsInCategory()

public static GetTopIDsInCategory(mixed $categoryId, mixed $top[, mixed $sortType = 'ASC' ]) : mixed
Parameters
$categoryId : mixed
$top : mixed
$sortType : mixed = 'ASC'

GetTotalCount()

public static GetTotalCount([int|null $categoryId = 0 ]) : mixed
Parameters
$categoryId : int|null = 0

GetUserFieldEntityID()

public static GetUserFieldEntityID() : mixed

GetUserFields()

public static GetUserFields() : mixed

isDefaultName()

Indicates if a contact has default name

public static isDefaultName(string $name) : bool
Parameters
$name : string
Return values
bool

isUseOperation()

Returns true if this class should invoke Service\Operation instead old API.

public isUseOperation() : bool

For a start it will return false by default. Please use this period to test your customization on compatibility with new API. Later it will return true by default. In several months this class will be declared as deprecated and old code will be deleted completely.

Return values
bool

PrepareFilter()

public static PrepareFilter(mixed &$arFilter[, mixed $arFilter2Logic = null ]) : mixed
Parameters
$arFilter : mixed
$arFilter2Logic : mixed = null

PrepareFormattedName()

public static PrepareFormattedName(array<string|int, mixed> $arFields[, mixed $nameTemplate = '' ][, mixed $enabledEmptyNameStub = true ]) : mixed
Parameters
$arFields : array<string|int, mixed>
$nameTemplate : mixed = ''
$enabledEmptyNameStub : mixed = true

ProcessCompanyDeletion()

public static ProcessCompanyDeletion(mixed $companyID) : mixed
Parameters
$companyID : mixed

ProcessLeadDeletion()

public static ProcessLeadDeletion(mixed $leadID) : mixed
Parameters
$leadID : mixed

Rebind()

public static Rebind(mixed $ownerTypeID, mixed $oldID, mixed $newID) : mixed
Parameters
$ownerTypeID : mixed
$oldID : mixed
$newID : mixed

RebuildDuplicateIndex()

public static RebuildDuplicateIndex(mixed $IDs) : mixed
Parameters
$IDs : mixed

RebuildEntityAccessAttrs()

public static RebuildEntityAccessAttrs(mixed $IDs) : mixed
Parameters
$IDs : mixed

ReleaseExternalResources()

public static ReleaseExternalResources(array<string|int, mixed> $arFields) : mixed
Parameters
$arFields : array<string|int, mixed>

SynchronizeMultifieldMarkers()

public static SynchronizeMultifieldMarkers(mixed $sourceID[, array<string|int, mixed> $fields = null ]) : mixed
Parameters
$sourceID : mixed
$fields : array<string|int, mixed> = null

Update()

public Update(mixed $ID, array<string|int, mixed> &$arFields[, mixed $bCompare = true ][, mixed $bUpdateSearch = true ][, mixed $arOptions = array() ]) : mixed
Parameters
$ID : mixed
$arFields : array<string|int, mixed>
$bCompare : mixed = true
$bUpdateSearch : mixed = true
$arOptions : mixed = array()

UpdateCompanyID()

public UpdateCompanyID(array<string|int, mixed> $arIDs, int $companyID) : bool
Parameters
$arIDs : array<string|int, mixed>
$companyID : int
Tags
see
ContactCompanyTable::bindContactIDs
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results