EntityRequisite
Table of Contents
Constants
- ADDRESS = 'RQ_ADDR'
- COMPANY_ACCOUNTANT = 'RQ_ACCOUNTANT'
- COMPANY_DIRECTOR = 'RQ_DIRECTOR'
- COMPANY_FULL_NAME = 'RQ_COMPANY_FULL_NAME'
- COMPANY_NAME = 'RQ_COMPANY_NAME'
- COMPANY_REG_DATE = 'RQ_COMPANY_REG_DATE'
- CONFIG_TABLE_NAME = 'b_crm_requisite_cfg'
- EDRPOU = 'RQ_EDRPOU'
- ERR_ACCESS_DENIED_COMPANY_UPDATE = 210
- ERR_ACCESS_DENIED_CONTACT_UPDATE = 211
- ERR_COMPANY_NOT_EXISTS = 205
- ERR_CONTACT_NOT_EXISTS = 206
- ERR_CREATE_REQUISITE = 215
- ERR_DEF_IMP_PRESET_NOT_DEFINED = 209
- ERR_DUP_CTRL_MODE_SKIP = 214
- ERR_FIELD_LENGTH_MAX = 217
- ERR_FIELD_LENGTH_MIN = 216
- ERR_FIELD_REQUIRED = 218
- ERR_IMP_PRESET_HAS_NO_ADDR_FIELD = 213
- ERR_IMP_PRESET_NOT_EXISTS = 208
- ERR_INVALID_ENTITY_ID = 202
- ERR_INVALID_ENTITY_TYPE = 201
- ERR_INVALID_IMP_PRESET_ID = 207
- ERR_NO_ADDRESSES_TO_IMPORT = 212
- ERR_NOTHING_TO_DELETE = 204
- ERR_ON_DELETE = 203
- IFNS = 'RQ_IFNS'
- IIN = 'RQ_IIN'
- INN = 'RQ_INN'
- KPP = 'RQ_KPP'
- OGRN = 'RQ_OGRN'
- OGRNIP = 'RQ_OGRNIP'
- OKVED = 'RQ_OKVED'
- PERSON_FIRST_NAME = 'RQ_FIRST_NAME'
- PERSON_FULL_NAME = 'RQ_NAME'
- PERSON_LAST_NAME = 'RQ_LAST_NAME'
- PERSON_SECOND_NAME = 'RQ_SECOND_NAME'
- VAT_ID = 'RQ_VAT_ID'
- XML_ID_DEFAULT_PRESET_RU_COMPANY = '#CRM_REQUISITE_PRESET_DEF_RU_COMPANY#'
- XML_ID_DEFAULT_PRESET_RU_INDIVIDUAL = '#CRM_REQUISITE_PRESET_DEF_RU_INDIVIDUAL#'
- XML_ID_DEFAULT_PRESET_RU_PERSON = '#CRM_REQUISITE_PRESET_DEF_RU_PERSON#'
Properties
- $sUFEntityID : mixed
Methods
- add() : mixed
- addFromData() : mixed
- checkBeforeAdd() : mixed
- checkBeforeUpdate() : mixed
- checkCountryId() : bool
- checkCreatePermissionOwnerEntity() : mixed
- checkDeletePermissionOwnerEntity() : mixed
- checkEntityType() : mixed
- checkReadPermission() : mixed
- checkReadPermissionOwnerEntity() : mixed
- checkRequiredFieldsBeforeSave() : Result
- checkRqFieldCountryId() : bool
- checkRqFieldsBeforeSave() : mixed
- checkUpdatePermission() : mixed
- checkUpdatePermissionOwnerEntity() : mixed
- delete() : mixed
- deleteByEntity() : mixed
- deleteUserField() : mixed
- entityListRequisiteExportDataFormatMultiline() : array<string|int, mixed>
- Converts export data to flat format.
- exists() : mixed
- formatDuplicateCriterionScope() : mixed
- getAddresses() : array<string|int, mixed>
- Load entity addresses
- getAddressFieldMap() : mixed
- getAddressFieldPostfixes() : mixed
- getAddressFields() : mixed
- getAddressFiltrableFields() : mixed
- getAddressZoneByCountry() : string
- getAllowedRqFieldCountries() : mixed
- getAllowedRqListFieldsStatusEntitities() : array<string|int, mixed>
- getBasicExportFieldsInfo() : mixed
- getBasicFieldsInfo() : mixed
- getByExternalId() : mixed
- getById() : mixed
- getCountByFilter() : mixed
- getCountryAddressZoneMap() : mixed
- getCountryCodeByDuplicateCriterionScope() : mixed
- getCountryIdByDuplicateCriterionScope() : mixed
- getCountryIdByFields() : int
- getCountryIdByPresetId() : int
- getCountryIdByRequisiteId() : int
- getDefaultMyCompanyEntityRequisiteBindings() : array<string|int, mixed>
- getDefaultMyCompanyRequisiteInfoLinked() : mixed
- getDefaultPresetId() : int
- Try to find default preset ID for specified entity type.
- getDefaultPresetIdFromOption() : int
- Try to get default preset ID for specified entity type from the option.
- getDefaultRequisiteInfoLinked() : mixed
- getDuplicateCriterionFieldsDescriptions() : mixed
- getDuplicateCriterionFieldsMap() : mixed
- getEntityRequisiteBindings() : array<string|int, mixed>
- getEntityRequisiteIDs() : mixed
- getFieldsInfo() : mixed
- getFieldsOfFixedPresets() : mixed
- getFieldsOfFixedPresetsByCountry() : mixed
- getFieldsTitles() : mixed
- getFileFields() : array<string|int, mixed>
- getFixedPresetList() : mixed
- getFormattedTitleParts() : mixed
- getFormFieldsInfo() : mixed
- getFormFieldsTypes() : mixed
- getFormUserFieldsInfo() : mixed
- getLinks() : mixed
- getLinksByOwner() : mixed
- getList() : mixed
- getOwnerEntityById() : mixed
- getPresetIdByFields() : int
- getPresetIdByRequisiteId() : int
- getPresetIdFromFields() : int
- getPresetsByEntities() : array<string|int, mixed>
- Returns the identifiers of the presets used in the requisites of the specified entities.
- getPresetsByEntityType() : array<string|int, mixed>
- Returns the identifiers of the presets used in the requisites of the specified entity type.
- getPresetWithAddressMap() : mixed
- getRequisiteFeedbackFormParams() : mixed
- getRqFields() : mixed
- getRqFieldsCountryMap() : mixed
- getRqFieldTitleMap() : mixed
- getRqFieldValidationMap() : mixed
- getRqFiltrableFields() : mixed
- getRqListFieldFormData() : array<string|int, mixed>
- getRqListFieldItems() : array<string|int, mixed>
- getRqListFields() : array<string|int, mixed>
- getRqListFieldValueTitle() : string
- getRqListFieldValueTitles() : array<string|int, mixed>
- getSingleInstance() : mixed
- getUfId() : mixed
- getUsedCountries() : array<string|int, mixed>
- getUserFields() : mixed
- getUserFieldsTitles() : mixed
- importEntityRequisite() : Result
- Imports requisites for the company or contact. Now supports only import for addresses.
- installDefaultListFieldItems() : void
- installDefaultPresets() : mixed
- internalizeAddresses() : mixed
- intertalizeFormData() : mixed
- isRqListField() : bool
- loadSettings() : mixed
- normalizeEntityListFields() : mixed
- onAfterPresetAdd() : void
- onAfterPresetDelete() : void
- onAfterPresetUpdate() : void
- parseFormData() : array<string|int, mixed>
- Parse form data from specified source
- prepareEntityInfoBatch() : mixed
- prepareEntityListExternalFilter() : mixed
- prepareEntityListFieldsValues() : mixed
- prepareEntityListFilter() : mixed
- prepareEntityListFilterFields() : mixed
- prepareEntityListHeaderFields() : mixed
- prepareEntityListRequisiteExportData() : array<string|int, mixed>
- Preparing the details of the company or contact for export.
- prepareFormattedAddress() : mixed
- prepareViewData() : mixed
- prepareViewDataFormatted() : mixed
- rebind() : void
- Unbind all requisites from seed entity and bind to target.
- rebindRequisite() : void
- Unbind requisite from seed entity and bind to target.
- resetPresetWithAddressMap() : mixed
- resolveAddressTypeByFieldName() : mixed
- resolveFieldNameByAddressType() : mixed
- saveFormData() : Result
- saveSettings() : mixed
- separateAddressFields() : mixed
- separateEntityListRqFields() : mixed
- setDef() : mixed
- setDefaultPresetId() : mixed
- setLinks() : mixed
- transferOwnership() : mixed
- Unbind requisites from old entity of one type and bind them to new entity of another type.
- update() : mixed
- updateUserFieldTitle() : mixed
- validateEntityExists() : mixed
- validateEntityReadPermission() : mixed
- validateEntityUpdatePermission() : mixed
Constants
ADDRESS
public
mixed
ADDRESS
= 'RQ_ADDR'
COMPANY_ACCOUNTANT
public
mixed
COMPANY_ACCOUNTANT
= 'RQ_ACCOUNTANT'
COMPANY_DIRECTOR
public
mixed
COMPANY_DIRECTOR
= 'RQ_DIRECTOR'
COMPANY_FULL_NAME
public
mixed
COMPANY_FULL_NAME
= 'RQ_COMPANY_FULL_NAME'
COMPANY_NAME
public
mixed
COMPANY_NAME
= 'RQ_COMPANY_NAME'
COMPANY_REG_DATE
public
mixed
COMPANY_REG_DATE
= 'RQ_COMPANY_REG_DATE'
CONFIG_TABLE_NAME
public
mixed
CONFIG_TABLE_NAME
= 'b_crm_requisite_cfg'
EDRPOU
public
mixed
EDRPOU
= 'RQ_EDRPOU'
ERR_ACCESS_DENIED_COMPANY_UPDATE
public
mixed
ERR_ACCESS_DENIED_COMPANY_UPDATE
= 210
ERR_ACCESS_DENIED_CONTACT_UPDATE
public
mixed
ERR_ACCESS_DENIED_CONTACT_UPDATE
= 211
ERR_COMPANY_NOT_EXISTS
public
mixed
ERR_COMPANY_NOT_EXISTS
= 205
ERR_CONTACT_NOT_EXISTS
public
mixed
ERR_CONTACT_NOT_EXISTS
= 206
ERR_CREATE_REQUISITE
public
mixed
ERR_CREATE_REQUISITE
= 215
ERR_DEF_IMP_PRESET_NOT_DEFINED
public
mixed
ERR_DEF_IMP_PRESET_NOT_DEFINED
= 209
ERR_DUP_CTRL_MODE_SKIP
public
mixed
ERR_DUP_CTRL_MODE_SKIP
= 214
ERR_FIELD_LENGTH_MAX
public
mixed
ERR_FIELD_LENGTH_MAX
= 217
ERR_FIELD_LENGTH_MIN
public
mixed
ERR_FIELD_LENGTH_MIN
= 216
ERR_FIELD_REQUIRED
public
mixed
ERR_FIELD_REQUIRED
= 218
ERR_IMP_PRESET_HAS_NO_ADDR_FIELD
public
mixed
ERR_IMP_PRESET_HAS_NO_ADDR_FIELD
= 213
ERR_IMP_PRESET_NOT_EXISTS
public
mixed
ERR_IMP_PRESET_NOT_EXISTS
= 208
ERR_INVALID_ENTITY_ID
public
mixed
ERR_INVALID_ENTITY_ID
= 202
ERR_INVALID_ENTITY_TYPE
public
mixed
ERR_INVALID_ENTITY_TYPE
= 201
ERR_INVALID_IMP_PRESET_ID
public
mixed
ERR_INVALID_IMP_PRESET_ID
= 207
ERR_NO_ADDRESSES_TO_IMPORT
public
mixed
ERR_NO_ADDRESSES_TO_IMPORT
= 212
ERR_NOTHING_TO_DELETE
public
mixed
ERR_NOTHING_TO_DELETE
= 204
ERR_ON_DELETE
public
mixed
ERR_ON_DELETE
= 203
IFNS
public
mixed
IFNS
= 'RQ_IFNS'
IIN
public
mixed
IIN
= 'RQ_IIN'
INN
public
mixed
INN
= 'RQ_INN'
KPP
public
mixed
KPP
= 'RQ_KPP'
OGRN
public
mixed
OGRN
= 'RQ_OGRN'
OGRNIP
public
mixed
OGRNIP
= 'RQ_OGRNIP'
OKVED
public
mixed
OKVED
= 'RQ_OKVED'
PERSON_FIRST_NAME
public
mixed
PERSON_FIRST_NAME
= 'RQ_FIRST_NAME'
PERSON_FULL_NAME
public
mixed
PERSON_FULL_NAME
= 'RQ_NAME'
PERSON_LAST_NAME
public
mixed
PERSON_LAST_NAME
= 'RQ_LAST_NAME'
PERSON_SECOND_NAME
public
mixed
PERSON_SECOND_NAME
= 'RQ_SECOND_NAME'
VAT_ID
public
mixed
VAT_ID
= 'RQ_VAT_ID'
XML_ID_DEFAULT_PRESET_RU_COMPANY
public
mixed
XML_ID_DEFAULT_PRESET_RU_COMPANY
= '#CRM_REQUISITE_PRESET_DEF_RU_COMPANY#'
XML_ID_DEFAULT_PRESET_RU_INDIVIDUAL
public
mixed
XML_ID_DEFAULT_PRESET_RU_INDIVIDUAL
= '#CRM_REQUISITE_PRESET_DEF_RU_INDIVIDUAL#'
XML_ID_DEFAULT_PRESET_RU_PERSON
public
mixed
XML_ID_DEFAULT_PRESET_RU_PERSON
= '#CRM_REQUISITE_PRESET_DEF_RU_PERSON#'
Properties
$sUFEntityID
public
static mixed
$sUFEntityID
= 'CRM_REQUISITE'
Methods
add()
public
add(mixed $fields[, mixed $options = [] ]) : mixed
Parameters
- $fields : mixed
- $options : mixed = []
addFromData()
public
addFromData(mixed $entityTypeId, mixed $entityId, mixed $requisiteData) : mixed
Parameters
- $entityTypeId : mixed
- $entityId : mixed
- $requisiteData : mixed
checkBeforeAdd()
public
checkBeforeAdd(mixed $fields[, mixed $options = [] ]) : mixed
Parameters
- $fields : mixed
- $options : mixed = []
checkBeforeUpdate()
public
checkBeforeUpdate(mixed $id, mixed $fields[, array<string|int, mixed> $options = [] ]) : mixed
Parameters
- $id : mixed
- $fields : mixed
- $options : array<string|int, mixed> = []
checkCountryId()
public
checkCountryId(int $countryId) : bool
Parameters
- $countryId : int
Return values
boolcheckCreatePermissionOwnerEntity()
public
static checkCreatePermissionOwnerEntity(mixed $entityTypeID[, int $categoryId = 0 ]) : mixed
Parameters
- $entityTypeID : mixed
- $categoryId : int = 0
checkDeletePermissionOwnerEntity()
public
static checkDeletePermissionOwnerEntity(mixed $entityTypeID, mixed $entityID) : mixed
Parameters
- $entityTypeID : mixed
- $entityID : mixed
checkEntityType()
public
static checkEntityType(mixed $entityTypeId) : mixed
Parameters
- $entityTypeId : mixed
checkReadPermission()
public
checkReadPermission([mixed $id = 0 ]) : mixed
Parameters
- $id : mixed = 0
checkReadPermissionOwnerEntity()
public
static checkReadPermissionOwnerEntity([mixed $entityTypeID = 0 ][, mixed $entityID = 0 ][, mixed $categoryId = null ]) : mixed
Parameters
- $entityTypeID : mixed = 0
- $entityID : mixed = 0
- $categoryId : mixed = null
checkRequiredFieldsBeforeSave()
public
checkRequiredFieldsBeforeSave(int $requisiteId, array<string|int, mixed> $fields[, array<string|int, mixed> $options = [] ]) : Result
Parameters
- $requisiteId : int
- $fields : array<string|int, mixed>
- $options : array<string|int, mixed> = []
Return values
ResultcheckRqFieldCountryId()
public
checkRqFieldCountryId(string $fieldName, int $countryId) : bool
Parameters
- $fieldName : string
- $countryId : int
Return values
boolcheckRqFieldsBeforeSave()
public
checkRqFieldsBeforeSave(mixed $requisiteId, mixed $fields) : mixed
Parameters
- $requisiteId : mixed
- $fields : mixed
checkUpdatePermission()
public
checkUpdatePermission(mixed $id) : mixed
Parameters
- $id : mixed
checkUpdatePermissionOwnerEntity()
public
static checkUpdatePermissionOwnerEntity(mixed $entityTypeID, mixed $entityID) : mixed
Parameters
- $entityTypeID : mixed
- $entityID : mixed
delete()
public
delete(mixed $id[, mixed $options = array() ]) : mixed
Parameters
- $id : mixed
- $options : mixed = array()
deleteByEntity()
public
deleteByEntity(mixed $entityTypeId, mixed $entityId[, mixed $options = array() ]) : mixed
Parameters
- $entityTypeId : mixed
- $entityId : mixed
- $options : mixed = array()
deleteUserField()
public
deleteUserField(mixed $ufId[, mixed $checkExist = true ]) : mixed
Parameters
- $ufId : mixed
- $checkExist : mixed = true
entityListRequisiteExportDataFormatMultiline()
Converts export data to flat format.
public
entityListRequisiteExportDataFormatMultiline(array<string|int, mixed> $requisiteExportData, array<string|int, mixed> $requisiteHeaders[, array<string|int, mixed> $options = array() ]) : array<string|int, mixed>
Parameters
- $requisiteExportData : array<string|int, mixed>
-
Requisite's export data structured as hierarchy $result[$entityId][$requisiteId]...
- $requisiteHeaders : array<string|int, mixed>
-
List of headers for export the requisites, addresses, bank details.
- $options : array<string|int, mixed> = array()
-
Options, such as prefix and others.
Return values
array<string|int, mixed> —Converted data in flat format
exists()
public
exists(mixed $id) : mixed
Parameters
- $id : mixed
formatDuplicateCriterionScope()
public
static formatDuplicateCriterionScope(mixed $countryId) : mixed
Parameters
- $countryId : mixed
getAddresses()
Load entity addresses
public
static getAddresses(int $id) : array<string|int, mixed>
Parameters
- $id : int
-
Entity ID.
Return values
array<string|int, mixed>getAddressFieldMap()
public
getAddressFieldMap(mixed $addressTypeId) : mixed
Parameters
- $addressTypeId : mixed
getAddressFieldPostfixes()
public
getAddressFieldPostfixes() : mixed
getAddressFields()
public
getAddressFields() : mixed
getAddressFiltrableFields()
public
static getAddressFiltrableFields() : mixed
getAddressZoneByCountry()
public
static getAddressZoneByCountry(int $countryId) : string
Parameters
- $countryId : int
Return values
stringgetAllowedRqFieldCountries()
public
static getAllowedRqFieldCountries() : mixed
getAllowedRqListFieldsStatusEntitities()
public
getAllowedRqListFieldsStatusEntitities([string $fieldName = '' ]) : array<string|int, mixed>
Parameters
- $fieldName : string = ''
Return values
array<string|int, mixed>getBasicExportFieldsInfo()
public
static getBasicExportFieldsInfo() : mixed
getBasicFieldsInfo()
public
static getBasicFieldsInfo() : mixed
getByExternalId()
public
static getByExternalId(mixed $externalId[, array<string|int, mixed> $select = null ]) : mixed
Parameters
- $externalId : mixed
- $select : array<string|int, mixed> = null
getById()
public
getById(mixed $id) : mixed
Parameters
- $id : mixed
getCountByFilter()
public
getCountByFilter([mixed $filter = array() ]) : mixed
Parameters
- $filter : mixed = array()
getCountryAddressZoneMap()
public
static getCountryAddressZoneMap() : mixed
getCountryCodeByDuplicateCriterionScope()
public
static getCountryCodeByDuplicateCriterionScope(mixed $scope) : mixed
Parameters
- $scope : mixed
getCountryIdByDuplicateCriterionScope()
public
static getCountryIdByDuplicateCriterionScope(mixed $scope) : mixed
Parameters
- $scope : mixed
getCountryIdByFields()
public
getCountryIdByFields(int $requisiteId, array<string|int, mixed> $fields) : int
Parameters
- $requisiteId : int
- $fields : array<string|int, mixed>
Return values
intgetCountryIdByPresetId()
public
getCountryIdByPresetId(mixed $presetId) : int
Parameters
- $presetId : mixed
Return values
intgetCountryIdByRequisiteId()
public
getCountryIdByRequisiteId(mixed $requisiteId) : int
Parameters
- $requisiteId : mixed
Return values
intgetDefaultMyCompanyEntityRequisiteBindings()
public
getDefaultMyCompanyEntityRequisiteBindings(int $entityTypeId, int $entityId, int|null $myCompanyId) : array<string|int, mixed>
Parameters
- $entityTypeId : int
- $entityId : int
- $myCompanyId : int|null
Return values
array<string|int, mixed>getDefaultMyCompanyRequisiteInfoLinked()
public
getDefaultMyCompanyRequisiteInfoLinked(mixed $entityList) : mixed
Parameters
- $entityList : mixed
getDefaultPresetId()
Try to find default preset ID for specified entity type.
public
static getDefaultPresetId(int $entityTypeId) : int
Parameters
- $entityTypeId : int
-
Entity type ID (Company and Contact are supported only).
Tags
Return values
intgetDefaultPresetIdFromOption()
Try to get default preset ID for specified entity type from the option.
public
static getDefaultPresetIdFromOption(int $entityTypeId) : int
Parameters
- $entityTypeId : int
-
Entity type ID (Company and Contact are supported only).
Tags
Return values
intgetDefaultRequisiteInfoLinked()
public
getDefaultRequisiteInfoLinked(mixed $entityList) : mixed
Parameters
- $entityList : mixed
getDuplicateCriterionFieldsDescriptions()
public
getDuplicateCriterionFieldsDescriptions([mixed $scopeKeys = true ]) : mixed
Parameters
- $scopeKeys : mixed = true
getDuplicateCriterionFieldsMap()
public
static getDuplicateCriterionFieldsMap() : mixed
getEntityRequisiteBindings()
public
getEntityRequisiteBindings(int $entityTypeId, int $entityId, int|null $companyId, int|null $contactId) : array<string|int, mixed>
Parameters
- $entityTypeId : int
- $entityId : int
- $companyId : int|null
- $contactId : int|null
Return values
array<string|int, mixed>getEntityRequisiteIDs()
public
getEntityRequisiteIDs(mixed $entityTypeId, mixed $entityId) : mixed
Parameters
- $entityTypeId : mixed
- $entityId : mixed
getFieldsInfo()
public
static getFieldsInfo() : mixed
getFieldsOfFixedPresets()
public
getFieldsOfFixedPresets() : mixed
getFieldsOfFixedPresetsByCountry()
public
getFieldsOfFixedPresetsByCountry() : mixed
getFieldsTitles()
public
getFieldsTitles([mixed $countryId = 0 ]) : mixed
Parameters
- $countryId : mixed = 0
getFileFields()
public
static getFileFields() : array<string|int, mixed>
Return values
array<string|int, mixed>getFixedPresetList()
public
static getFixedPresetList() : mixed
getFormattedTitleParts()
public
static getFormattedTitleParts() : mixed
getFormFieldsInfo()
public
getFormFieldsInfo([mixed $countryId = 0 ]) : mixed
Parameters
- $countryId : mixed = 0
getFormFieldsTypes()
public
getFormFieldsTypes() : mixed
getFormUserFieldsInfo()
public
getFormUserFieldsInfo() : mixed
getLinks()
public
static getLinks(mixed $entityTypeId, mixed $entityId) : mixed
Parameters
- $entityTypeId : mixed
- $entityId : mixed
getLinksByOwner()
public
static getLinksByOwner(mixed $ownerEntityTypeId, mixed $ownerEntityId) : mixed
Parameters
- $ownerEntityTypeId : mixed
- $ownerEntityId : mixed
getList()
public
getList(mixed $params) : mixed
Parameters
- $params : mixed
getOwnerEntityById()
public
static getOwnerEntityById(mixed $id) : mixed
Parameters
- $id : mixed
getPresetIdByFields()
public
getPresetIdByFields(int $requisiteId, array<string|int, mixed> $fields) : int
Parameters
- $requisiteId : int
- $fields : array<string|int, mixed>
Return values
intgetPresetIdByRequisiteId()
public
getPresetIdByRequisiteId(mixed $requisiteId) : int
Parameters
- $requisiteId : mixed
Return values
intgetPresetIdFromFields()
public
getPresetIdFromFields(array<string|int, mixed> $fields) : int
Parameters
- $fields : array<string|int, mixed>
Return values
intgetPresetsByEntities()
Returns the identifiers of the presets used in the requisites of the specified entities.
public
static getPresetsByEntities(int $entityTypeId, array<string|int, mixed> $entityIds) : array<string|int, mixed>
Parameters
- $entityTypeId : int
-
Entity type ID (Company and Contact are supported only).
- $entityIds : array<string|int, mixed>
-
List of entities IDs.
Return values
array<string|int, mixed>getPresetsByEntityType()
Returns the identifiers of the presets used in the requisites of the specified entity type.
public
static getPresetsByEntityType(int $entityTypeId) : array<string|int, mixed>
Parameters
- $entityTypeId : int
-
Entity type ID (Company and Contact are supported only).
Tags
Return values
array<string|int, mixed>getPresetWithAddressMap()
public
static getPresetWithAddressMap([array<string|int, mixed> $options = [] ]) : mixed
Parameters
- $options : array<string|int, mixed> = []
getRequisiteFeedbackFormParams()
public
static getRequisiteFeedbackFormParams() : mixed
getRqFields()
public
getRqFields() : mixed
getRqFieldsCountryMap()
public
getRqFieldsCountryMap() : mixed
getRqFieldTitleMap()
public
getRqFieldTitleMap() : mixed
getRqFieldValidationMap()
public
getRqFieldValidationMap() : mixed
getRqFiltrableFields()
public
getRqFiltrableFields() : mixed
getRqListFieldFormData()
public
getRqListFieldFormData(string $listFieldName, int $countryId) : array<string|int, mixed>
Parameters
- $listFieldName : string
- $countryId : int
Return values
array<string|int, mixed>getRqListFieldItems()
public
getRqListFieldItems(string $listFieldName, int $countryId) : array<string|int, mixed>
Parameters
- $listFieldName : string
- $countryId : int
Return values
array<string|int, mixed>getRqListFields()
public
getRqListFields() : array<string|int, mixed>
Return values
array<string|int, mixed>getRqListFieldValueTitle()
public
getRqListFieldValueTitle(string $listFieldName, int $countryId, string $listFieldValue) : string
Parameters
- $listFieldName : string
- $countryId : int
- $listFieldValue : string
Return values
stringgetRqListFieldValueTitles()
public
getRqListFieldValueTitles(array<string|int, mixed> $requisiteFields[, int $countryId = 0 ]) : array<string|int, mixed>
Parameters
- $requisiteFields : array<string|int, mixed>
- $countryId : int = 0
Return values
array<string|int, mixed>getSingleInstance()
public
static getSingleInstance() : mixed
getUfId()
public
getUfId() : mixed
getUsedCountries()
public
getUsedCountries() : array<string|int, mixed>
Return values
array<string|int, mixed>getUserFields()
public
getUserFields() : mixed
getUserFieldsTitles()
public
getUserFieldsTitles() : mixed
importEntityRequisite()
Imports requisites for the company or contact. Now supports only import for addresses.
public
importEntityRequisite(int $entityTypeId, int $entityId, string $dupControlType[, int $presetId = 0 ][, array<string|int, mixed> $fields = [] ]) : Result
Moved to Requisite\ImportHelper::importOldRequisiteAddresses.
Parameters
- $entityTypeId : int
-
Entity type ID.
- $entityId : int
-
Entity ID for import
- $dupControlType : string
-
Duplicate control type ("NO_CONTROL", "REPLACE", "MERGE", "SKIP")
- $presetId : int = 0
-
Preset ID for import
- $fields : array<string|int, mixed> = []
-
Fields of the requisite to import
Return values
ResultinstallDefaultListFieldItems()
public
installDefaultListFieldItems(string $statusEntityId) : void
Parameters
- $statusEntityId : string
installDefaultPresets()
public
static installDefaultPresets() : mixed
internalizeAddresses()
public
static internalizeAddresses(mixed &$fields) : mixed
Parameters
- $fields : mixed
intertalizeFormData()
public
static intertalizeFormData(array<string|int, mixed> $formData, mixed $entityTypeID, array<string|int, mixed> &$requisites, array<string|int, mixed> &$bankDetails) : mixed
Parameters
- $formData : array<string|int, mixed>
- $entityTypeID : mixed
- $requisites : array<string|int, mixed>
- $bankDetails : array<string|int, mixed>
isRqListField()
public
isRqListField(string $fieldName) : bool
Parameters
- $fieldName : string
Return values
boolloadSettings()
public
loadSettings(mixed $entityTypeID, mixed $entityId) : mixed
Parameters
- $entityTypeID : mixed
- $entityId : mixed
normalizeEntityListFields()
public
normalizeEntityListFields(mixed &$entityFields, mixed $headers[, mixed $options = array() ]) : mixed
Parameters
- $entityFields : mixed
- $headers : mixed
- $options : mixed = array()
onAfterPresetAdd()
public
static onAfterPresetAdd(Event $event) : void
Parameters
- $event : Event
onAfterPresetDelete()
public
static onAfterPresetDelete(Event $event) : void
Parameters
- $event : Event
onAfterPresetUpdate()
public
static onAfterPresetUpdate(Event $event) : void
Parameters
- $event : Event
parseFormData()
Parse form data from specified source
public
static parseFormData(array<string|int, mixed> $formData) : array<string|int, mixed>
Parameters
- $formData : array<string|int, mixed>
-
Data source.
Return values
array<string|int, mixed>prepareEntityInfoBatch()
public
static prepareEntityInfoBatch(mixed $entityTypeId, mixed &$entityInfos, mixed $scope, mixed $typeName[, mixed $options = null ]) : mixed
Parameters
- $entityTypeId : mixed
- $entityInfos : mixed
- $scope : mixed
- $typeName : mixed
- $options : mixed = null
prepareEntityListExternalFilter()
public
prepareEntityListExternalFilter(mixed &$filter[, mixed $params = array() ]) : mixed
Parameters
- $filter : mixed
- $params : mixed = array()
prepareEntityListFieldsValues()
public
prepareEntityListFieldsValues(mixed &$entityList, mixed $entityTypeId, mixed $entityIds, mixed $select[, mixed $options = array() ]) : mixed
Parameters
- $entityList : mixed
- $entityTypeId : mixed
- $entityIds : mixed
- $select : mixed
- $options : mixed = array()
prepareEntityListFilter()
public
prepareEntityListFilter(array<string|int, mixed> &$filter) : mixed
Parameters
- $filter : array<string|int, mixed>
prepareEntityListFilterFields()
public
prepareEntityListFilterFields(mixed &$filterFields) : mixed
Parameters
- $filterFields : mixed
prepareEntityListHeaderFields()
public
prepareEntityListHeaderFields(mixed &$headers[, mixed $options = array() ]) : mixed
Parameters
- $headers : mixed
- $options : mixed = array()
prepareEntityListRequisiteExportData()
Preparing the details of the company or contact for export.
public
prepareEntityListRequisiteExportData(int $entityTypeId, array<string|int, mixed> $entityIds[, array<string|int, mixed> $options = array() ]) : array<string|int, mixed>
Parameters
- $entityTypeId : int
-
Entity type ID.
- $entityIds : array<string|int, mixed>
-
List of entities IDs.
- $options : array<string|int, mixed> = array()
-
Options, such as prefix and others.
Tags
Return values
array<string|int, mixed> —Array with two elements: 'HEADERS' and 'EXPORT_DATA'. 'HEADERS' - List of headers for export the requisites, addresses, bank details. 'EXPORT_DATA' - Requisite entities structured as hierarchy $result[$entityId][$requisiteId]...
prepareFormattedAddress()
public
prepareFormattedAddress(array<string|int, mixed> $fields[, mixed $typeId = \Bitrix\Crm\RequisiteAddress::Undefined ]) : mixed
Parameters
- $fields : array<string|int, mixed>
- $typeId : mixed = \Bitrix\Crm\RequisiteAddress::Undefined
prepareViewData()
public
prepareViewData(mixed $fields, mixed $fieldsInViewMap[, mixed $options = [] ]) : mixed
Parameters
- $fields : mixed
- $fieldsInViewMap : mixed
- $options : mixed = []
prepareViewDataFormatted()
public
prepareViewDataFormatted(mixed $fields, mixed $fieldsInViewMap[, mixed $options = array() ]) : mixed
Parameters
- $fields : mixed
- $fieldsInViewMap : mixed
- $options : mixed = array()
rebind()
Unbind all requisites from seed entity and bind to target.
public
static rebind(int $entityTypeID, int $seedID, int $targID) : void
Parameters
- $entityTypeID : int
-
Entity type ID.
- $seedID : int
-
Seed entity ID.
- $targID : int
-
Target entity ID.
rebindRequisite()
Unbind requisite from seed entity and bind to target.
public
static rebindRequisite(int $entityTypeID, int $targEntityID, int $seedRequisiteID) : void
Parameters
- $entityTypeID : int
-
Entity type ID.
- $targEntityID : int
-
Target entity ID.
- $seedRequisiteID : int
-
Seed requisite ID.
resetPresetWithAddressMap()
public
resetPresetWithAddressMap() : mixed
resolveAddressTypeByFieldName()
public
resolveAddressTypeByFieldName(mixed $fieldName) : mixed
Parameters
- $fieldName : mixed
resolveFieldNameByAddressType()
public
resolveFieldNameByAddressType(mixed $addrType) : mixed
Parameters
- $addrType : mixed
saveFormData()
public
static saveFormData(mixed $entityTypeId, mixed $entityId, mixed $entityRequisites, mixed $entityBankDetails) : Result
Parameters
- $entityTypeId : mixed
- $entityId : mixed
- $entityRequisites : mixed
- $entityBankDetails : mixed
Return values
ResultsaveSettings()
public
saveSettings(mixed $entityTypeId, mixed $entityId, mixed $settings) : mixed
Parameters
- $entityTypeId : mixed
- $entityId : mixed
- $settings : mixed
separateAddressFields()
public
separateAddressFields(mixed &$fields) : mixed
Parameters
- $fields : mixed
separateEntityListRqFields()
public
separateEntityListRqFields(mixed &$entityFields[, mixed $options = array() ]) : mixed
Parameters
- $entityFields : mixed
- $options : mixed = array()
setDef()
public
static setDef(mixed $entityTypeId, mixed $entityId, mixed $requisiteId[, mixed $bankDetailId = null ][, mixed $ignorePermissions = false ]) : mixed
Parameters
- $entityTypeId : mixed
- $entityId : mixed
- $requisiteId : mixed
- $bankDetailId : mixed = null
- $ignorePermissions : mixed = false
setDefaultPresetId()
public
static setDefaultPresetId(mixed $entityTypeId, mixed $presetId) : mixed
Parameters
- $entityTypeId : mixed
- $presetId : mixed
setLinks()
public
static setLinks(array<string|int, mixed> $links) : mixed
Parameters
- $links : array<string|int, mixed>
transferOwnership()
Unbind requisites from old entity of one type and bind them to new entity of another type.
public
transferOwnership(int $oldEntityTypeID, int $oldEntityID, int $newEntityTypeID, int $newEntityID) : mixed
Parameters
- $oldEntityTypeID : int
-
Old Entity Type ID.
- $oldEntityID : int
-
Old Old Entity ID.
- $newEntityTypeID : int
-
New Entity Type ID.
- $newEntityID : int
-
New Entity ID.
Tags
update()
public
update(mixed $id, mixed $fields[, mixed $options = array() ]) : mixed
Parameters
- $id : mixed
- $fields : mixed
- $options : mixed = array()
updateUserFieldTitle()
public
updateUserFieldTitle(mixed $ufId, mixed $title[, mixed $checkExist = true ]) : mixed
Parameters
- $ufId : mixed
- $title : mixed
- $checkExist : mixed = true
validateEntityExists()
public
validateEntityExists(mixed $entityTypeId, mixed $entityId) : mixed
Parameters
- $entityTypeId : mixed
- $entityId : mixed
validateEntityReadPermission()
public
validateEntityReadPermission(mixed $entityTypeId, mixed $entityId) : mixed
Parameters
- $entityTypeId : mixed
- $entityId : mixed
validateEntityUpdatePermission()
public
validateEntityUpdatePermission(mixed $entityTypeId, mixed $entityId) : mixed
Parameters
- $entityTypeId : mixed
- $entityId : mixed