Bitrix API

CCrmLead extends CAllCrmLead

Table of Contents

Constants

CACHE_TTL  = 3600
DB_TYPE  = 'MYSQL'
DEFAULT_FORM_ID  = 'CRM_LEAD_SHOW_V12'
SUSPENDED_USER_FIELD_ENTITY_ID  = 'CRM_LEAD_SPD'
TABLE_ALIAS  = 'L'
TABLE_NAME  = 'b_crm_lead'
TOTAL_COUNT_CACHE_ID  = 'crm_lead_total_count'
USER_FIELD_ENTITY_ID  = 'CRM_LEAD'

Properties

$LAST_ERROR  : mixed
$sUFEntityID  : mixed

Methods

__AfterPrepareSql()  : mixed
__construct()  : mixed
Add()  : mixed
AddObserverIDs()  : mixed
BuildEntityAttr()  : mixed
BuildPermSql()  : mixed
CheckCreatePermission()  : mixed
CheckDeletePermission()  : mixed
CheckFields()  : mixed
CheckImportPermission()  : mixed
CheckReadPermission()  : mixed
CheckUpdatePermission()  : mixed
CompareFields()  : mixed
CreateListBuilder()  : mixed
Delete()  : mixed
EnsureStatusesLoaded()  : mixed
Exists()  : mixed
existsEntityWithStatus()  : mixed
GetAssociatedIDs()  : mixed
GetByID()  : mixed
GetCheckExceptions()  : mixed
getCustomerFields()  : mixed
GetCustomerType()  : mixed
GetDefaultTitle()  : mixed
GetDefaultTitleTemplate()  : mixed
GetFieldCaption()  : mixed
GetFields()  : mixed
GetFieldsInfo()  : mixed
GetFinalStatusSort()  : mixed
getLastError()  : string
GetLeftSiblingID()  : mixed
GetList()  : CDBResult
GetListEx()  : mixed
GetRightSiblingID()  : mixed
GetSemanticID()  : mixed
GetStatuses()  : mixed
GetStatusNames()  : mixed
GetStatusSemantics()  : mixed
GetStatusSort()  : mixed
GetSubsidiaryEntities()  : mixed
GetTopIDs()  : mixed
GetTotalCount()  : mixed
GetUserFieldEntityID()  : mixed
GetUserFields()  : mixed
isManualOpportunity()  : mixed
IsStatusExists()  : mixed
IsStatusFinished()  : mixed
isUseOperation()  : bool
Returns true if this class should invoke Service\Operation instead old API.
LoadProductRows()  : mixed
OnAccountCurrencyChange()  : mixed
PrepareConversionPermissionFlags()  : mixed
PrepareFilter()  : mixed
PrepareFormattedName()  : mixed
ProcessCompanyDeletion()  : mixed
ProcessContactDeletion()  : mixed
ProcessStatusDeletion()  : mixed
ProcessStatusModification()  : mixed
Rebind()  : mixed
RebuildDuplicateIndex()  : mixed
RebuildEntityAccessAttrs()  : mixed
RebuildSemantics()  : mixed
RebuildStatistics()  : mixed
RefreshAccountingData()  : mixed
RemoveObserverIDs()  : mixed
ReplaceObserverIDs()  : mixed
ResolveCustomerType()  : mixed
SaveProductRows()  : mixed
SynchronizeMultifieldMarkers()  : mixed
SynchronizeProductRows()  : mixed
Update()  : mixed

Constants

DEFAULT_FORM_ID

public mixed DEFAULT_FORM_ID = 'CRM_LEAD_SHOW_V12'

SUSPENDED_USER_FIELD_ENTITY_ID

public mixed SUSPENDED_USER_FIELD_ENTITY_ID = 'CRM_LEAD_SPD'

TABLE_ALIAS

public mixed TABLE_ALIAS = 'L'

TABLE_NAME

public mixed TABLE_NAME = 'b_crm_lead'

TOTAL_COUNT_CACHE_ID

public mixed TOTAL_COUNT_CACHE_ID = 'crm_lead_total_count'

USER_FIELD_ENTITY_ID

public mixed USER_FIELD_ENTITY_ID = 'CRM_LEAD'

Properties

$LAST_ERROR

public mixed $LAST_ERROR = ''

$sUFEntityID

public static mixed $sUFEntityID = 'CRM_LEAD'

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()

AddObserverIDs()

public static AddObserverIDs(mixed $ID, array<string|int, mixed> $userIDs) : mixed
Parameters
$ID : mixed
$userIDs : array<string|int, mixed>

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 ]) : mixed
Parameters
$userPermissions : mixed = null
Tags
see

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

CheckDeletePermission()

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

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

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 ]) : mixed
Parameters
$userPermissions : mixed = null
Tags
see

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

CheckReadPermission()

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

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

CheckUpdatePermission()

public static CheckUpdatePermission(mixed $id[, mixed $userPermissions = null ]) : mixed
Parameters
$id : mixed
$userPermissions : mixed = 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[, mixed $bCheckPerms = true ][, array<string|int, mixed> $arOptions = null ]) : mixed
Parameters
$arFieldsOrig : array<string|int, mixed>
$arFieldsModif : array<string|int, mixed>
$bCheckPerms : mixed = true
$arOptions : array<string|int, mixed> = null

CreateListBuilder()

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

Delete()

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

EnsureStatusesLoaded()

public static EnsureStatusesLoaded() : mixed

Exists()

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

existsEntityWithStatus()

public static existsEntityWithStatus(mixed $statusId) : mixed
Parameters
$statusId : mixed

GetAssociatedIDs()

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

GetByID()

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

GetCheckExceptions()

public GetCheckExceptions() : mixed

getCustomerFields()

public static getCustomerFields() : mixed

GetCustomerType()

public static GetCustomerType(mixed $ID) : mixed
Parameters
$ID : 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

GetFinalStatusSort()

public static GetFinalStatusSort() : 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

GetSemanticID()

public static GetSemanticID(mixed $statusID) : mixed
Parameters
$statusID : mixed

GetStatuses()

public static GetStatuses() : mixed

GetStatusNames()

public static GetStatusNames() : mixed

GetStatusSemantics()

public static GetStatusSemantics(mixed $statusID) : mixed
Parameters
$statusID : mixed

GetStatusSort()

public static GetStatusSort(mixed $statusID) : mixed
Parameters
$statusID : mixed

GetSubsidiaryEntities()

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

GetTopIDs()

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

GetTotalCount()

public static GetTotalCount() : mixed

GetUserFieldEntityID()

public static GetUserFieldEntityID() : mixed

GetUserFields()

public static GetUserFields([mixed $langID = false ]) : mixed
Parameters
$langID : mixed = false

isManualOpportunity()

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

IsStatusExists()

public static IsStatusExists(mixed $statusID) : mixed
Parameters
$statusID : mixed

IsStatusFinished()

public static IsStatusFinished(mixed $statusID) : mixed
Parameters
$statusID : mixed

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

LoadProductRows()

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

OnAccountCurrencyChange()

public static OnAccountCurrencyChange() : mixed

PrepareConversionPermissionFlags()

public static PrepareConversionPermissionFlags(mixed $ID, array<string|int, mixed> &$params) : mixed
Parameters
$ID : mixed
$params : array<string|int, mixed>

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
Parameters
$arFields : array<string|int, mixed>
$nameTemplate : mixed = ''

ProcessCompanyDeletion()

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

ProcessContactDeletion()

public static ProcessContactDeletion(mixed $contactID) : mixed
Parameters
$contactID : mixed

ProcessStatusDeletion()

public static ProcessStatusDeletion(array<string|int, mixed> $fields) : mixed
Parameters
$fields : array<string|int, mixed>

ProcessStatusModification()

public static ProcessStatusModification(array<string|int, mixed> $fields) : mixed
Parameters
$fields : array<string|int, mixed>

Rebind()

public static Rebind(int $ownerTypeId, int $oldId, int $newId) : mixed
Parameters
$ownerTypeId : int
$oldId : int
$newId : int

RebuildDuplicateIndex()

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

RebuildEntityAccessAttrs()

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

RebuildSemantics()

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

RebuildStatistics()

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

RefreshAccountingData()

public static RefreshAccountingData(array<string|int, mixed> $IDs) : mixed
Parameters
$IDs : array<string|int, mixed>

RemoveObserverIDs()

public static RemoveObserverIDs(mixed $ID, array<string|int, mixed> $userIDs) : mixed
Parameters
$ID : mixed
$userIDs : array<string|int, mixed>

ReplaceObserverIDs()

public static ReplaceObserverIDs(mixed $ID, array<string|int, mixed> $userIDs) : mixed
Parameters
$ID : mixed
$userIDs : array<string|int, mixed>

ResolveCustomerType()

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

SaveProductRows()

public static SaveProductRows(mixed $ID, mixed $arRows[, mixed $checkPerms = true ][, mixed $regEvent = true ][, mixed $syncOwner = true ]) : mixed
Parameters
$ID : mixed
$arRows : mixed
$checkPerms : mixed = true
$regEvent : mixed = true
$syncOwner : mixed = true

SynchronizeMultifieldMarkers()

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

SynchronizeProductRows()

public static SynchronizeProductRows(mixed $ID[, mixed $checkPerms = true ]) : mixed
Parameters
$ID : mixed
$checkPerms : mixed = true

Update()

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results