Bitrix API

EntityLink

Class EntityLink

Table of Contents

Constants

ENTITY_OPERATION_ADD  = 1
ENTITY_OPERATION_FIRST  = 1
ENTITY_OPERATION_LAST  = 2
ENTITY_OPERATION_UPDATE  = 2
ERR_BANK_DETAIL_NOT_ASSIGNED  = 213
ERR_BANK_DETAIL_NOT_ASSIGNED_WO_REQUISITE  = 212
ERR_BANK_DETAIL_NOT_FOUND  = 211
ERR_ENTITY_CHECK_N_BUT_CLIENT_NOT_SPECIFIED  = 220
ERR_ENTITY_NOT_FOUND  = 203
ERR_INVALID_BANK_DETAIL_ID  = 205
ERR_INVALID_ENTITY_ID  = 202
ERR_INVALID_ENTITY_TYPE  = 201
ERR_INVALID_MC_BANK_DETAIL_ID  = 207
ERR_INVALID_MC_REQUSIITE_ID  = 206
ERR_INVALID_REQUSIITE_ID  = 204
ERR_MC_BANK_DETAIL_NOT_ASSIGNED  = 219
ERR_MC_BANK_DETAIL_NOT_ASSIGNED_WO_MC_REQUISITE  = 217
ERR_MC_BANK_DETAIL_NOT_FOUND  = 218
ERR_MC_REQUISITE_NOT_ASSIGNED  = 216
ERR_MC_REQUISITE_NOT_FOUND  = 215
ERR_MC_REQUISITE_TIED_TO_ENTITY_WITHOUT_MYCOMPANY  = 214
ERR_REQUISITE_NOT_ASSIGNED  = 210
ERR_REQUISITE_NOT_FOUND  = 208
ERR_REQUISITE_TIED_TO_ENTITY_WITHOUT_CLIENT  = 209

Methods

checkConsistence()  : mixed
checkReadPermissionOwnerEntity()  : bool
checkUpdatePermissionOwnerEntity()  : bool
clearMyCompanyCache()  : void
copyRequisiteLink()  : void
determineRequisiteLinkBeforeSave()  : mixed
getAvailableEntityTypeIds()  : array<string|int, mixed>
getByEntity()  : array<string|int, mixed>|null
getDefaultEntityRequisiteLink()  : mixed
getDefaultMyCompanyId()  : int
getDefaultMyCompanyRequisiteLink()  : array<string|int, mixed>
getEntityClientSellerInfo()  : mixed
getFieldCaption()  : mixed
getFieldsInfo()  : array<string|int, mixed>
getList()  : Result
getParentEntityFieldMap()  : mixed
getSelectedRequisiteLink()  : array<string|int, mixed>
isMyCompany()  : mixed
moveDependencies()  : mixed
prepareClientSellerParamsByEntityFields()  : mixed
prepareParrentEntityMap()  : mixed
register()  : mixed
setDefaultMyCompanyId()  : mixed
unregister()  : mixed
unregisterByRequisite()  : mixed

Constants

ENTITY_OPERATION_ADD

public mixed ENTITY_OPERATION_ADD = 1

ENTITY_OPERATION_FIRST

public mixed ENTITY_OPERATION_FIRST = 1

ENTITY_OPERATION_LAST

public mixed ENTITY_OPERATION_LAST = 2

ENTITY_OPERATION_UPDATE

public mixed ENTITY_OPERATION_UPDATE = 2

ERR_BANK_DETAIL_NOT_ASSIGNED

public mixed ERR_BANK_DETAIL_NOT_ASSIGNED = 213

ERR_BANK_DETAIL_NOT_ASSIGNED_WO_REQUISITE

public mixed ERR_BANK_DETAIL_NOT_ASSIGNED_WO_REQUISITE = 212

ERR_BANK_DETAIL_NOT_FOUND

public mixed ERR_BANK_DETAIL_NOT_FOUND = 211

ERR_ENTITY_CHECK_N_BUT_CLIENT_NOT_SPECIFIED

public mixed ERR_ENTITY_CHECK_N_BUT_CLIENT_NOT_SPECIFIED = 220

ERR_ENTITY_NOT_FOUND

public mixed ERR_ENTITY_NOT_FOUND = 203

ERR_INVALID_BANK_DETAIL_ID

public mixed ERR_INVALID_BANK_DETAIL_ID = 205

ERR_INVALID_ENTITY_ID

public mixed ERR_INVALID_ENTITY_ID = 202

ERR_INVALID_ENTITY_TYPE

public mixed ERR_INVALID_ENTITY_TYPE = 201

ERR_INVALID_MC_BANK_DETAIL_ID

public mixed ERR_INVALID_MC_BANK_DETAIL_ID = 207

ERR_INVALID_MC_REQUSIITE_ID

public mixed ERR_INVALID_MC_REQUSIITE_ID = 206

ERR_INVALID_REQUSIITE_ID

public mixed ERR_INVALID_REQUSIITE_ID = 204

ERR_MC_BANK_DETAIL_NOT_ASSIGNED

public mixed ERR_MC_BANK_DETAIL_NOT_ASSIGNED = 219

ERR_MC_BANK_DETAIL_NOT_ASSIGNED_WO_MC_REQUISITE

public mixed ERR_MC_BANK_DETAIL_NOT_ASSIGNED_WO_MC_REQUISITE = 217

ERR_MC_BANK_DETAIL_NOT_FOUND

public mixed ERR_MC_BANK_DETAIL_NOT_FOUND = 218

ERR_MC_REQUISITE_NOT_ASSIGNED

public mixed ERR_MC_REQUISITE_NOT_ASSIGNED = 216

ERR_MC_REQUISITE_NOT_FOUND

public mixed ERR_MC_REQUISITE_NOT_FOUND = 215

ERR_MC_REQUISITE_TIED_TO_ENTITY_WITHOUT_MYCOMPANY

public mixed ERR_MC_REQUISITE_TIED_TO_ENTITY_WITHOUT_MYCOMPANY = 214

ERR_REQUISITE_NOT_ASSIGNED

public mixed ERR_REQUISITE_NOT_ASSIGNED = 210

ERR_REQUISITE_NOT_FOUND

public mixed ERR_REQUISITE_NOT_FOUND = 208

ERR_REQUISITE_TIED_TO_ENTITY_WITHOUT_CLIENT

public mixed ERR_REQUISITE_TIED_TO_ENTITY_WITHOUT_CLIENT = 209

Methods

checkConsistence()

public static checkConsistence(mixed $entityTypeId, mixed $entityId, mixed $requisiteId, mixed $bankDetailId, mixed $mcRequisiteId, mixed $mcBankDetailId[, mixed $options = null ]) : mixed
Parameters
$entityTypeId : mixed
$entityId : mixed
$requisiteId : mixed
$bankDetailId : mixed
$mcRequisiteId : mixed
$mcBankDetailId : mixed
$options : mixed = null

checkReadPermissionOwnerEntity()

public static checkReadPermissionOwnerEntity([int $entityTypeID = 0 ][, int $entityID = 0 ]) : bool
Parameters
$entityTypeID : int = 0
$entityID : int = 0
Return values
bool

checkUpdatePermissionOwnerEntity()

public static checkUpdatePermissionOwnerEntity([int $entityTypeID = 0 ][, int $entityID = 0 ]) : bool
Parameters
$entityTypeID : int = 0
$entityID : int = 0
Return values
bool

clearMyCompanyCache()

public static clearMyCompanyCache() : void
public static copyRequisiteLink(Item $source, Item $destination) : void
Parameters
$source : Item
$destination : Item

determineRequisiteLinkBeforeSave()

public static determineRequisiteLinkBeforeSave(mixed $entityTypeId, mixed $entityId, mixed $operation, mixed &$entityFields[, mixed $modifyFields = true ][, mixed $requisiteId = null ][, mixed $bankDetailId = null ][, mixed $mcRequisiteId = null ][, mixed $mcBankDetailId = null ]) : mixed
Parameters
$entityTypeId : mixed
$entityId : mixed
$operation : mixed
$entityFields : mixed
$modifyFields : mixed = true
$requisiteId : mixed = null
$bankDetailId : mixed = null
$mcRequisiteId : mixed = null
$mcBankDetailId : mixed = null

getAvailableEntityTypeIds()

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

getByEntity()

public static getByEntity(mixed $entityTypeId, mixed $entityId) : array<string|int, mixed>|null
Parameters
$entityTypeId : mixed
$entityId : mixed
Tags
throws
ArgumentException
throws
Exception
Return values
array<string|int, mixed>|null
public static getDefaultEntityRequisiteLink(mixed $parentEntityList, mixed $entityTypeId, mixed $entityId[, mixed $requisiteId = 0 ][, mixed $isMyCompany = false ]) : mixed
Parameters
$parentEntityList : mixed
$entityTypeId : mixed
$entityId : mixed
$requisiteId : mixed = 0
$isMyCompany : mixed = false

getDefaultMyCompanyId()

public static getDefaultMyCompanyId() : int
Return values
int

ID of default seller company.

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

Array of identifiers by default for seller, requisites and bank details

getEntityClientSellerInfo()

public static getEntityClientSellerInfo(mixed $entityTypeId, mixed $entityId[, mixed $options = [] ]) : mixed
Parameters
$entityTypeId : mixed
$entityId : mixed
$options : mixed = []

getFieldCaption()

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

getFieldsInfo()

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

getList()

public static getList(mixed $parameters) : Result
Parameters
$parameters : mixed
Tags
throws
ArgumentException
Return values
Result

getParentEntityFieldMap()

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

isMyCompany()

public static isMyCompany(mixed $companyId) : mixed
Parameters
$companyId : mixed

moveDependencies()

public static moveDependencies([mixed $targEntityTypeId = 0 ][, mixed $targEntityId = 0 ][, mixed $seedEntityTypeId = 0 ][, mixed $seedEntityId = 0 ][, mixed $targRequisiteId = 0 ][, mixed $seedRequisiteId = 0 ][, mixed $targBankDetailId = 0 ][, mixed $seedBankDetailId = 0 ]) : mixed
Parameters
$targEntityTypeId : mixed = 0
$targEntityId : mixed = 0
$seedEntityTypeId : mixed = 0
$seedEntityId : mixed = 0
$targRequisiteId : mixed = 0
$seedRequisiteId : mixed = 0
$targBankDetailId : mixed = 0
$seedBankDetailId : mixed = 0

prepareClientSellerParamsByEntityFields()

public static prepareClientSellerParamsByEntityFields(mixed $entityTypeId, mixed $entityFields) : mixed
Parameters
$entityTypeId : mixed
$entityFields : mixed

prepareParrentEntityMap()

public static prepareParrentEntityMap(mixed $entityTypeId, mixed $entityFields) : mixed
Parameters
$entityTypeId : mixed
$entityFields : mixed

register()

public static register(mixed $entityTypeId, mixed $entityId[, mixed $requisiteId = 0 ][, int $bankDetailId = 0 ][, int $mcRequisiteId = 0 ][, int $mcBankDetailId = 0 ]) : mixed
Parameters
$entityTypeId : mixed
$entityId : mixed
$requisiteId : mixed = 0
$bankDetailId : int = 0
$mcRequisiteId : int = 0
$mcBankDetailId : int = 0
Tags
throws
ArgumentException
throws
NotSupportedException

setDefaultMyCompanyId()

public static setDefaultMyCompanyId(mixed $defMyCompanyId) : mixed
Parameters
$defMyCompanyId : mixed

unregister()

public static unregister(mixed $entityTypeId, mixed $entityId) : mixed
Parameters
$entityTypeId : mixed
$entityId : mixed
Tags
throws
ArgumentException
throws
Exception

unregisterByRequisite()

public static unregisterByRequisite(mixed $requisiteId) : mixed
Parameters
$requisiteId : mixed
Tags
throws
ArgumentException
throws
NotSupportedException

        
On this page

Search results