Bitrix-D7 23.9
 
Загрузка...
Поиск...
Не найдено
Класс Address

Открытые члены

 __construct (string $languageId)
 
 getId ()
 
 setId (int $id)
 
 getLatitude ()
 
 setLatitude (string $latitude)
 
 getLongitude ()
 
 setLongitude (string $longitude)
 
 getLanguageId ()
 
 getFieldCollection ()
 
 setFieldCollection (FieldCollection $fieldCollection)
 
 getLocation ()
 
 setLocation (?Location $location)
 
 setFieldValue (int $type, string $value)
 
 getAllFieldsValues ()
 
 getFieldValue (int $type)
 
 isFieldExist (int $type)
 
 save ()
 
 delete ()
 
 toJson ()
 
 toArray ()
 
 setLinks (AddressLinkCollection $collection)
 
 getLinks ()
 
 clearLinks ()
 
 addLink (string $entityId, string $entityType)
 
 hasLinks ()
 
 toString (Format $format, string $strategyType=StringConverter::STRATEGY_TYPE_TEMPLATE, string $contentType=StringConverter::CONTENT_TYPE_HTML)
 

Открытые статические члены

static load (int $id)
 
static fromJson (string $jsonData)
 
static fromArray (array $arrayData)
 

Защищенные данные

 $latitude = ''
 
 $longitude = ''
 

Подробное описание

См. определение в файле address.php строка 21

Конструктор(ы)

◆ __construct()

__construct ( string $languageId)

Address constructor.

Аргументы
string$languageId

См. определение в файле address.php строка 42

Методы

◆ addLink()

addLink ( string $entityId,
string $entityType )

Link entity to address

Аргументы
string$entityId
string$entityType
Исключения
ArgumentNullException

См. определение в файле address.php строка 334

◆ clearLinks()

clearLinks ( )

Removes all links

См. определение в файле address.php строка 322

◆ delete()

delete ( )

Delete the address

Возвращает
\Bitrix\Main\ORM\Data\DeleteResult
Исключения

Exception

См. определение в файле address.php строка 254

◆ fromArray()

static fromArray ( array $arrayData)
static

Create the Address from Array

Аргументы
array$arrayData
Возвращает
Address

См. определение в файле address.php строка 298

◆ fromJson()

static fromJson ( string $jsonData)
static

Create the Address from JSON

Аргументы
string$jsonData
Возвращает
Address
Исключения

Bitrix\Main\ArgumentException

См. определение в файле address.php строка 287

◆ getAllFieldsValues()

getAllFieldsValues ( )

Get all fields values from the address

Возвращает
array

См. определение в файле address.php строка 179

◆ getFieldCollection()

getFieldCollection ( )
Возвращает
FieldCollection

См. определение в файле address.php строка 115

◆ getFieldValue()

getFieldValue ( int $type)

Get address field value

Аргументы
int$typeField type. See \Bitrix\Location\Entity\Address\FieldType
Возвращает
string|null

См. определение в файле address.php строка 197

◆ getId()

getId ( )
Возвращает
int

См. определение в файле address.php строка 52

◆ getLanguageId()

getLanguageId ( )
Возвращает
string

См. определение в файле address.php строка 106

◆ getLatitude()

getLatitude ( )
Возвращает
string

См. определение в файле address.php строка 70

◆ getLinks()

getLinks ( )
Возвращает
AddressLinkCollection

См. определение в файле address.php строка 314

◆ getLocation()

getLocation ( )
Возвращает
Location

См. определение в файле address.php строка 135

◆ getLongitude()

getLongitude ( )
Возвращает
string

См. определение в файле address.php строка 88

◆ hasLinks()

hasLinks ( )

Check if Address has links or not

Возвращает
bool

См. определение в файле address.php строка 356

◆ isFieldExist()

isFieldExist ( int $type)

Check if field exist

Аргументы
int$typeField type. See \Bitrix\Location\Entity\Address\FieldType
Возвращает
bool

См. определение в файле address.php строка 215

◆ load()

static load ( int $id)
static

Load the Address

Аргументы
int$id
Возвращает
Address|bool|null
Исключения
SystemException

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\ObjectPropertyException

См. определение в файле address.php строка 229

◆ save()

save ( )

Save the Address

Возвращает
\Bitrix\Main\ORM\Data\AddResult|\Bitrix\Main\ORM\Data\Result|\Bitrix\Main\ORM\Data\UpdateResult
Исключения
SystemException

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\LoaderException

Исключения

Bitrix\Main\ObjectPropertyException

См. определение в файле address.php строка 243

◆ setFieldCollection()

setFieldCollection ( FieldCollection $fieldCollection)
Аргументы
FieldCollection$fieldCollection
Возвращает
Address

См. определение в файле address.php строка 125

◆ setFieldValue()

setFieldValue ( int $type,
string $value )

Set address field value

Аргументы
int$typeField type. See \Bitrix\Location\Entity\Address\FieldType
string$valueField value
Возвращает
$this
Исключения
SystemException

См. определение в файле address.php строка 157

◆ setId()

setId ( int $id)
Аргументы
int$id
Возвращает
$this

См. определение в файле address.php строка 61

◆ setLatitude()

setLatitude ( string $latitude)
Аргументы
string$latitude
Возвращает
Address

См. определение в файле address.php строка 79

◆ setLinks()

setLinks ( AddressLinkCollection $collection)
Аргументы
AddressLinkCollection$collection

См. определение в файле address.php строка 306

◆ setLocation()

setLocation ( ?Location $location)
Аргументы
Location | null$location
Возвращает
self

См. определение в файле address.php строка 144

◆ setLongitude()

setLongitude ( string $longitude)
Аргументы
string$longitude
Возвращает
Address

См. определение в файле address.php строка 97

◆ toArray()

toArray ( )

Convert the Address to Array

Возвращает
array

См. определение в файле address.php строка 275

◆ toJson()

toJson ( )

Convert the Address to JSON

Возвращает
string Json
Исключения

Bitrix\Main\ArgumentException

См. определение в файле address.php строка 265

◆ toString()

toString ( Format $format,
string $strategyType = StringConverter::STRATEGY_TYPE_TEMPLATE,
string $contentType = StringConverter::CONTENT_TYPE_HTML )

Convert Address to String

Аргументы
Format$formatAddress format
string$strategyTypeSee StringConverter::STRATEGY_*
string$contentTypeSee StringConverter::CONTENT_TYPE_*
Возвращает
string
Исключения

Bitrix\Main\ArgumentOutOfRangeException

См. определение в файле address.php строка 370

Данные класса

◆ $latitude

$latitude = ''
protected

См. определение в файле address.php строка 28

◆ $longitude

$longitude = ''
protected

См. определение в файле address.php строка 30