Class VCardAddress - Stefanius67/VCard GitHub Wiki

Full name:     \SKien\VCard\VCardAddress

---

Class representing one address within a contact.

Add an address to a contact for writing:

Create a new instance of a VCardAdress, set its property and add the address to a contact using VCardContact::addAddress()

Retrieve an address within a contact:

Use VCardContact::getAddress() to retrieve existing address within a given contact.

See Also:

• \SKien\VCard\VCardContact::addAddress()
• \SKien\VCard\VCardContact::getAddress()

Overview

Method	Description
getCity	Get city.
getCountry	Get country.
getExtAddress	Get extended address (e.g. apartment or suite number).
getPOBox	Get post office box.
getPostcode	Get postcode.
getRegion	Get region.
getStr	Get street.
getType	Get type.
isPreferred	Get preferred state.
setCity	Set city.
setCountry	Set country.
setExtAddress	Set extended address (e.g. apartment or suite number).
setPOBox	Set post office box.
setPostcode	Set Postcode
setPreferred	Set this address as preferred.
setRegion	Set region.
setStr	Set street.
setType	Set type.

Methods

getCity

Get city.

public VCardAddress::getCity() : string

Return Type: string

$strCity

go to top(#vcardaddress)

---

getCountry

Get country.

public VCardAddress::getCountry() : string

Return Type: string

$strCountry

go to top(#vcardaddress)

---

getExtAddress

Get extended address (e.g. apartment or suite number).

public VCardAddress::getExtAddress() : string

Return Type: string

$strRegion

go to top(#vcardaddress)

---

getPOBox

Get post office box.

public VCardAddress::getPOBox() : string

Return Type: string

$strPOBox

go to top(#vcardaddress)

---

getPostcode

Get postcode.

public VCardAddress::getPostcode() : string

Return Type: string

$strPostcode

go to top(#vcardaddress)

---

getRegion

Get region.

public VCardAddress::getRegion() : string

Return Type: string

$strRegion

go to top(#vcardaddress)

---

getStr

Get street.

public VCardAddress::getStr() : string

Return Type: string

$strStr

go to top(#vcardaddress)

---

getType

Get type.

public VCardAddress::getType() : string

Return Type: string

$strType can b comma separated list of multiple types.

go to top(#vcardaddress)

---

isPreferred

Get preferred state.

public VCardAddress::isPreferred() : bool

Return Type: bool

$bPreferred

go to top(#vcardaddress)

---

setCity

Set city.

public VCardAddress::setCity(string $strCity) : void

Parameters:

Parameter	Type	Description
strCity	string

go to top(#vcardaddress)

---

setCountry

Set country.

public VCardAddress::setCountry(string $strCountry) : void

Parameters:

Parameter	Type	Description
strCountry	string

go to top(#vcardaddress)

---

setExtAddress

Set extended address (e.g. apartment or suite number).

public VCardAddress::setExtAddress(string $strExtAddress) : void

Parameters:

Parameter	Type	Description
strExtAddress	string

go to top(#vcardaddress)

---

setPOBox

Set post office box.

public VCardAddress::setPOBox(string $strPOBox) : void

Parameters:

Parameter	Type	Description
strPOBox	string

go to top(#vcardaddress)

---

setPostcode

Set Postcode

public VCardAddress::setPostcode(string $strPostcode) : void

Parameters:

Parameter	Type	Description
strPostcode	string

go to top(#vcardaddress)

---

setPreferred

Set this address as preferred.

public VCardAddress::setPreferred(bool $bPreferred) : void

Parameters:

Parameter	Type	Description
bPreferred	bool

go to top(#vcardaddress)

---

setRegion

Set region.

public VCardAddress::setRegion(string $strRegion) : void

Parameters:

Parameter	Type	Description
strRegion	string

go to top(#vcardaddress)

---

setStr

Set street.

public VCardAddress::setStr(string $strStr) : void

Parameters:

Parameter	Type	Description
strStr	string

go to top(#vcardaddress)

---

setType

Set type.

public VCardAddress::setType(string|string[] $type) : void

Any combination of the predefined types VCard::PREF, VCard::WORK, VCard::HOME VCard::POSTAL, VCard::PARCEL, VCard::INTER or VCard::DOMESTIC can be set.

Parameters:

Parameter	Type	Description
type	string | string[]	one single type or an array of multiple types

go to top(#vcardaddress)

---