Bitrix API

RequisiteAddress extends EntityAddress

Table of Contents

Constants

Bank  = 10
Beneficiary  = 9
Custom  = 7
Delivery  = 11
First  = 1
Home  = 4
Last  = 11
Post  = 8
Primary  = 1
Registered  = 6
Secondary  = 2
Third  = 3
Undefined  = 0
Work  = 5

Methods

areEquals()  : bool
Check if addresses are equals
checkCreatePermissionOwnerEntity()  : mixed
checkDeletePermissionOwnerEntity()  : mixed
checkReadPermissionOwnerEntity()  : mixed
checkUpdatePermissionOwnerEntity()  : mixed
cloneLocationAddress()  : Address
deleteByEntity()  : mixed
deleteByEntityId()  : void
Remove entity addresses
getByEntities()  : array<string|int, mixed>
Returns the addresses of the specified entities.
getByOwner()  : mixed
getClientTypeInfos()  : mixed
getCount()  : int
getCountries()  : mixed
getCountryByCode()  : mixed
getDefaultLanguageId()  : mixed
getDefaultTypeId()  : mixed
getEntityList()  : mixed
getFieldsInfo()  : mixed
getFullAddressLabel()  : mixed
getLabel()  : mixed
getLabels()  : mixed
getList()  : mixed
getListByOwner()  : mixed
getLocationAddressByFields()  : Address|null
getShortLabels()  : mixed
getTypeDescription()  : mixed
getTypeInfos()  : mixed
getTypeLabels()  : mixed
getTypesList()  : mixed
getZoneId()  : string
getZoneMap()  : array<string|int, mixed>
isDefined()  : mixed
isEmpty()  : bool
Check if address is empty
isLocationModuleIncluded()  : bool
isSet()  : bool
Check if address fields are set
makeLocationAddressByFields()  : Address|null
mapEntityField()  : string
mapEntityFields()  : mixed
onLocationAddressDelete()  : mixed
onLocationAddressUpdate()  : mixed
prepareChangeEvents()  : mixed
prepareFilterJoinSql()  : mixed
prepareFilterSql()  : mixed
prepareJsonValue()  : mixed
rebind()  : mixed
register()  : mixed
resolveEntityFieldName()  : mixed
resolveEntityFieldTypeID()  : int
resolveFieldNames()  : mixed
setDef()  : mixed
setZoneId()  : mixed
unregister()  : mixed

Constants

Bank

Use constants of EntityAddressType

public mixed Bank = 10

Beneficiary

Use constants of EntityAddressType

public mixed Beneficiary = 9

Custom

Use constants of EntityAddressType

public mixed Custom = 7

Delivery

Use constants of EntityAddressType

public mixed Delivery = 11

First

Use constants of EntityAddressType

public mixed First = 1

Home

Use constants of EntityAddressType

public mixed Home = 4

Last

Use constants of EntityAddressType

public mixed Last = 11

Post

Use constants of EntityAddressType

public mixed Post = 8

Primary

Use constants of EntityAddressType

public mixed Primary = 1

Registered

Use constants of EntityAddressType

public mixed Registered = 6

Secondary

Use constants of EntityAddressType

public mixed Secondary = 2

Third

Use constants of EntityAddressType

public mixed Third = 3

Undefined

Use constants of EntityAddressType

public mixed Undefined = 0

Work

Use constants of EntityAddressType

public mixed Work = 5

Methods

areEquals()

Check if addresses are equals

public static areEquals(array<string|int, mixed> $a, array<string|int, mixed> $b) : bool
Parameters
$a : array<string|int, mixed>

First address.

$b : array<string|int, mixed>

Second address.

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

checkReadPermissionOwnerEntity()

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

checkUpdatePermissionOwnerEntity()

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

cloneLocationAddress()

public static cloneLocationAddress(int $locationAddressId) : Address
Parameters
$locationAddressId : int
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
Address

deleteByEntity()

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

deleteByEntityId()

Remove entity addresses

public static deleteByEntityId(array<string|int, mixed> $entityID) : void
Parameters
$entityID : array<string|int, mixed>

Entity ID.

getByEntities()

Returns the addresses of the specified entities.

public static getByEntities(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>

getByOwner()

public static getByOwner(mixed $typeID, mixed $ownerTypeID, mixed $ownerID) : mixed
Parameters
$typeID : mixed
$ownerTypeID : mixed
$ownerID : mixed

getClientTypeInfos()

public static getClientTypeInfos() : mixed

Use methods of EntityAddressType and EntityAddress

getCount()

public getCount(mixed $filter) : int
Parameters
$filter : mixed
Return values
int

getCountries()

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

getCountryByCode()

public static getCountryByCode(mixed $code) : mixed
Parameters
$code : mixed

getDefaultLanguageId()

public static getDefaultLanguageId() : mixed

getDefaultTypeId()

public static getDefaultTypeId() : mixed

Use methods of EntityAddressType and EntityAddress

getEntityList()

public static getEntityList(mixed $typeID, array<string|int, mixed> $sort, array<string|int, mixed> $filter[, mixed $navParams = false ][, array<string|int, mixed> $options = null ]) : mixed
Parameters
$typeID : mixed
$sort : array<string|int, mixed>
$filter : array<string|int, mixed>
$navParams : mixed = false
$options : array<string|int, mixed> = null

getFullAddressLabel()

public static getFullAddressLabel([mixed $typeID = 0 ]) : mixed

Use method of EntityAddressType

Parameters
$typeID : mixed = 0

getLabel()

public static getLabel(mixed $fieldName[, mixed $typeID = 0 ]) : mixed
Parameters
$fieldName : mixed
$typeID : mixed = 0

getLabels()

public static getLabels([mixed $typeID = 0 ]) : mixed
Parameters
$typeID : mixed = 0

getList()

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

getListByOwner()

public static getListByOwner(mixed $ownerTypeID, mixed $ownerID) : mixed
Parameters
$ownerTypeID : mixed
$ownerID : mixed

getLocationAddressByFields()

public static getLocationAddressByFields(array<string|int, mixed> $fields, string $languageId) : Address|null
Parameters
$fields : array<string|int, mixed>
$languageId : string
Tags
throws
LoaderException
Return values
Address|null

getShortLabels()

public static getShortLabels([mixed $typeID = 0 ]) : mixed
Parameters
$typeID : mixed = 0

getTypeDescription()

public static getTypeDescription(mixed $typeID) : mixed

Use methods of EntityAddressType and EntityAddress

Parameters
$typeID : mixed

getTypeInfos()

public static getTypeInfos() : mixed

Use methods of EntityAddressType and EntityAddress

getTypeLabels()

public static getTypeLabels() : mixed

Use method of EntityAddressType

getTypesList()

public static getTypesList() : mixed

Use methods of EntityAddressType and EntityAddress

getZoneId()

public static getZoneId() : string
Return values
string

getZoneMap()

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

isDefined()

public static isDefined(mixed $typeID) : mixed

Use method of EntityAddressType

Parameters
$typeID : mixed

isEmpty()

Check if address is empty

public static isEmpty(array<string|int, mixed> $fields) : bool
Parameters
$fields : array<string|int, mixed>
Return values
bool

isSet()

Check if address fields are set

public static isSet(array<string|int, mixed> $fields) : bool
Parameters
$fields : array<string|int, mixed>
Return values
bool

makeLocationAddressByFields()

public static makeLocationAddressByFields(array<string|int, mixed> $fields[, string $languageId = '' ]) : Address|null
Parameters
$fields : array<string|int, mixed>
$languageId : string = ''
Tags
throws
ArgumentException
throws
LoaderException
throws
ObjectPropertyException
throws
SystemException
Return values
Address|null

mapEntityField()

public static mapEntityField(mixed $fieldName, mixed $typeID[, array<string|int, mixed> $aliases = null ]) : string
Parameters
$fieldName : mixed
$typeID : mixed
$aliases : array<string|int, mixed> = null
Return values
string

mapEntityFields()

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

onLocationAddressDelete()

public static onLocationAddressDelete(mixed $event) : mixed
Parameters
$event : mixed

onLocationAddressUpdate()

public static onLocationAddressUpdate(mixed $event) : mixed
Parameters
$event : mixed

prepareChangeEvents()

public static prepareChangeEvents(array<string|int, mixed> $original, array<string|int, mixed> $modified[, mixed $typeID = 0 ][, array<string|int, mixed> $options = null ]) : mixed
Parameters
$original : array<string|int, mixed>
$modified : array<string|int, mixed>
$typeID : mixed = 0
$options : array<string|int, mixed> = null

prepareFilterJoinSql()

public static prepareFilterJoinSql(mixed $entityTypeID, mixed $typeID, array<string|int, mixed> $filter, mixed $tableAlias) : mixed
Parameters
$entityTypeID : mixed
$typeID : mixed
$filter : array<string|int, mixed>
$tableAlias : mixed

prepareFilterSql()

public static prepareFilterSql(mixed $entityTypeID, mixed $typeID, array<string|int, mixed> $filter, mixed $tableAlias) : mixed
Parameters
$entityTypeID : mixed
$typeID : mixed
$filter : array<string|int, mixed>
$tableAlias : mixed

prepareJsonValue()

public static prepareJsonValue(mixed $data) : mixed

Does nothing.

Parameters
$data : mixed

rebind()

public static rebind(mixed $oldEntityTypeID, mixed $oldEntityID, mixed $newEntityTypeID, mixed $newEntityID) : mixed
Parameters
$oldEntityTypeID : mixed
$oldEntityID : mixed
$newEntityTypeID : mixed
$newEntityID : mixed

register()

public static register(mixed $entityTypeID, mixed $entityID, mixed $typeID, array<string|int, mixed> $data[, array<string|int, mixed> $options = [] ]) : mixed
Parameters
$entityTypeID : mixed
$entityID : mixed
$typeID : mixed
$data : array<string|int, mixed>
$options : array<string|int, mixed> = []

resolveEntityFieldName()

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

resolveEntityFieldTypeID()

public static resolveEntityFieldTypeID(mixed $fieldName[, array<string|int, mixed>|null $aliases = null ]) : int

Use methods of EntityAddressType and EntityAddress

Parameters
$fieldName : mixed
$aliases : array<string|int, mixed>|null = null
Return values
int

resolveFieldNames()

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

setDef()

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

setZoneId()

public static setZoneId(string $addressZoneId) : mixed
Parameters
$addressZoneId : string

unregister()

public static unregister(mixed $entityTypeID, mixed $entityID, mixed $typeID) : mixed
Parameters
$entityTypeID : mixed
$entityID : mixed
$typeID : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results