Bitrix API

Address

Class Address

Table of Contents

Methods

__construct()  : mixed
Address constructor.
get()  : null|string
Get address.
getEmail()  : null|string
Get email.
getEncoded()  : null|string
Get encoded address.
getName()  : null|string
Get name.
isValid()  : bool
Return true if is valid.
set()  : $this
Set address.
setCheckingPunycode()  : mixed
setEmail()  : $this
Set email.
setName()  : $this
Set name.
validate()  : mixed
Validate address.

Methods

__construct()

Address constructor.

public __construct([null $address = null ][, array<string|int, mixed> $options = [] ]) : mixed
Parameters
$address : null = null
$options : array<string|int, mixed> = []
  • possible keys are: checkingPunycode - converting domain with non-latin symbols into punycode before validation

get()

Get address.

public get() : null|string
Return values
null|string

getEmail()

Get email.

public getEmail() : null|string
Return values
null|string

getEncoded()

Get encoded address.

public getEncoded() : null|string
Return values
null|string

getName()

Get name.

public getName() : null|string
Return values
null|string

isValid()

Return true if is valid.

public static isValid(string $address) : bool
Parameters
$address : string

Address.

Return values
bool

set()

Set address.

public set(null|string $address) : $this
Parameters
$address : null|string
Return values
$this

setCheckingPunycode()

public setCheckingPunycode(mixed $checkingPunycode) : mixed
Parameters
$checkingPunycode : mixed

setEmail()

Set email.

public setEmail(null|string $email) : $this
Parameters
$email : null|string
Return values
$this

setName()

Set name.

public setName(null|string $name) : $this
Parameters
$name : null|string
Return values
$this

validate()

Validate address.

public validate() : mixed
Tags
@return

bool.


        
On this page

Search results