Bitrix API

EntityBankDetail

Table of Contents

Constants

ERR_FIELD_LENGTH_MAX  = 206
ERR_FIELD_LENGTH_MIN  = 205
ERR_FIELD_REQUIRED  = 207
ERR_INVALID_ENTITY_ID  = 202
ERR_INVALID_ENTITY_TYPE  = 201
ERR_NOTHING_TO_DELETE  = 204
ERR_ON_DELETE  = 203

Methods

add()  : mixed
checkBeforeAdd()  : mixed
checkBeforeUpdate()  : mixed
checkCountryId()  : bool
checkCreatePermissionOwnerEntity()  : mixed
checkDeletePermissionOwnerEntity()  : mixed
checkEntityType()  : mixed
checkReadPermissionOwnerEntity()  : mixed
checkRequiredFieldsBeforeSave()  : Result
checkRqFieldsBeforeSave()  : mixed
checkUpdatePermissionOwnerEntity()  : mixed
delete()  : mixed
deleteByEntity()  : mixed
exists()  : bool
formatDuplicateCriterionScope()  : mixed
getAllowedRqFieldCountries()  : mixed
getBasicExportFieldsInfo()  : mixed
getBasicFieldsInfo()  : mixed
getById()  : mixed
getByOwners()  : array<string|int, mixed>
Returns the bank detail of the specified owner entities.
getCountByFilter()  : mixed
getCountryCodeByDuplicateCriterionScope()  : mixed
getCountryIdByDuplicateCriterionScope()  : mixed
getCountryIdByFields()  : int
getCountryIdByOwnerEntity()  : int
getDefaultSectionTitle()  : string
getDuplicateCriterionFieldsDescriptions()  : mixed
getDuplicateCriterionFieldsMap()  : mixed
getFieldsInfo()  : mixed
getFieldsTitles()  : mixed
getFormFieldsInfo()  : mixed
getFormFieldsInfoByCountry()  : mixed
getFormFieldsTypes()  : mixed
getList()  : mixed
getOwnerEntityById()  : mixed
getPresetIdByFields()  : int
getPresetIdByOwnerEntity()  : int
getRqFieldByCountry()  : mixed
getRqFields()  : mixed
getRqFieldsCountryMap()  : mixed
getRqFieldTitleMap()  : mixed
getRqFieldValidationMap()  : mixed
getRqFiltrableFields()  : mixed
getSingleInstance()  : mixed
parseFormData()  : array<string|int, mixed>
Parse form data from specified source
prepareEntityInfoBatch()  : mixed
prepareViewData()  : mixed
rebindBankDetail()  : void
Unbind from seed entity and bind to target.
transferOwnership()  : mixed
Unbind banking detail from old entity of one type and bind them to new entity of another type.
update()  : mixed
validateEntityExists()  : mixed
validateEntityReadPermission()  : mixed
validateEntityUpdatePermission()  : mixed

Constants

Methods

add()

public add(mixed $fields[, mixed $options = array() ]) : mixed
Parameters
$fields : mixed
$options : mixed = array()

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 static checkCountryId(int $countryId) : bool
Parameters
$countryId : int
Return values
bool

checkCreatePermissionOwnerEntity()

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

checkDeletePermissionOwnerEntity()

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

checkEntityType()

public static checkEntityType(mixed $entityTypeId) : mixed
Parameters
$entityTypeId : mixed

checkReadPermissionOwnerEntity()

public static checkReadPermissionOwnerEntity([mixed $entityTypeID = 0 ][, mixed $entityID = 0 ]) : mixed
Parameters
$entityTypeID : mixed = 0
$entityID : mixed = 0

checkRequiredFieldsBeforeSave()

public checkRequiredFieldsBeforeSave(int $bankDetailId, array<string|int, mixed> $fields[, array<string|int, mixed> $options = [] ]) : Result
Parameters
$bankDetailId : int
$fields : array<string|int, mixed>
$options : array<string|int, mixed> = []
Return values
Result

checkRqFieldsBeforeSave()

public checkRqFieldsBeforeSave(mixed $bankDetailId, mixed $fields) : mixed
Parameters
$bankDetailId : mixed
$fields : 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()

exists()

public exists(int $id[, int $entityTypeId = 0 ][, int $entityId = 0 ]) : bool
Parameters
$id : int
$entityTypeId : int = 0
$entityId : int = 0
Return values
bool

formatDuplicateCriterionScope()

public static formatDuplicateCriterionScope(mixed $countryId) : mixed
Parameters
$countryId : mixed

getAllowedRqFieldCountries()

public static getAllowedRqFieldCountries() : mixed

getBasicExportFieldsInfo()

public static getBasicExportFieldsInfo() : mixed

getByOwners()

Returns the bank detail of the specified owner entities.

public static getByOwners(int $entityTypeId, array<string|int, mixed> $ownerIds[, array<string|int, mixed> $ownerList = array() ]) : array<string|int, mixed>
Parameters
$entityTypeId : int

Entity type ID (Requisite for example).

$ownerIds : array<string|int, mixed>

List of owners IDs.

$ownerList : array<string|int, mixed> = array()

List of owners (It is used to obtain the PRESET_COUNTRY_ID field values as an alternative to the COUNTRY_ID field of bank details).

Return values
array<string|int, mixed> —

Bank details structured as hierarchy $result[$requisiteId][$bankDetailId]...

getCountByFilter()

public getCountByFilter([mixed $filter = array() ]) : mixed
Parameters
$filter : mixed = array()

getCountryCodeByDuplicateCriterionScope()

public static getCountryCodeByDuplicateCriterionScope(mixed $scope) : mixed
Parameters
$scope : mixed

getCountryIdByDuplicateCriterionScope()

public static getCountryIdByDuplicateCriterionScope(mixed $scope) : mixed
Parameters
$scope : mixed

getCountryIdByFields()

public getCountryIdByFields(int $bankDetailId, array<string|int, mixed> $fields) : int
Parameters
$bankDetailId : int
$fields : array<string|int, mixed>
Return values
int

getCountryIdByOwnerEntity()

public getCountryIdByOwnerEntity(mixed $entityTypeId, mixed $entityId) : int
Parameters
$entityTypeId : mixed
$entityId : mixed
Return values
int

getDefaultSectionTitle()

public getDefaultSectionTitle(int $countryId) : string
Parameters
$countryId : int
Return values
string

getDuplicateCriterionFieldsDescriptions()

public getDuplicateCriterionFieldsDescriptions([mixed $scopeKeys = true ]) : mixed
Parameters
$scopeKeys : mixed = true

getDuplicateCriterionFieldsMap()

public static getDuplicateCriterionFieldsMap() : mixed

getFieldsTitles()

public getFieldsTitles([mixed $countryId = 0 ]) : mixed
Parameters
$countryId : mixed = 0

getFormFieldsInfo()

public getFormFieldsInfo([mixed $countryId = 0 ]) : mixed
Parameters
$countryId : mixed = 0

getFormFieldsInfoByCountry()

public getFormFieldsInfoByCountry(mixed $countryId) : mixed
Parameters
$countryId : mixed

getList()

public getList(mixed $params) : mixed
Parameters
$params : mixed

getOwnerEntityById()

public static getOwnerEntityById(mixed $id) : mixed
Parameters
$id : mixed

getPresetIdByFields()

public getPresetIdByFields(int $bankDetailId, array<string|int, mixed> $fields) : int
Parameters
$bankDetailId : int
$fields : array<string|int, mixed>
Return values
int

getPresetIdByOwnerEntity()

public getPresetIdByOwnerEntity(int $entityTypeId, int $entityId) : int
Parameters
$entityTypeId : int
$entityId : int
Return values
int

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

prepareViewData()

public prepareViewData(mixed $fields[, mixed $fieldsInView = array() ][, mixed $options = array() ]) : mixed
Parameters
$fields : mixed
$fieldsInView : mixed = array()
$options : mixed = array()

rebindBankDetail()

Unbind from seed entity and bind to target.

public static rebindBankDetail(int $entityTypeId, int $targEntityId, int $seedBankDetailId) : void
Parameters
$entityTypeId : int

Entity type ID.

$targEntityId : int

Target entity ID.

$seedBankDetailId : int

Seed bank detail ID.

Tags
throws
ArgumentException

transferOwnership()

Unbind banking detail 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
throws
ArgumentException
throws
SqlQueryException

update()

public update(mixed $id, mixed $fields[, mixed $options = array() ]) : mixed
Parameters
$id : mixed
$fields : mixed
$options : mixed = array()

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 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results