oxAddress Class Reference

Inheritance diagram for oxAddress:

Collaboration diagram for oxAddress:

List of all members.

Public Member Functions
	__construct ()
	__toString ()
	toString ()
	getEncodedDeliveryAddress ()
	getState ()
	getStateId ()
	getStateTitle ($sId=null)
	isSelected ()
	setSelected ()
Protected Member Functions
	_getStateObject ()
	_getMergedAddressFields ()
Protected Attributes
	$_sClassName = 'oxaddress'
	$_blSelected = false
	$_oStateObject = null

---

Detailed Description

Address handler

Definition at line 6 of file oxaddress.php.

---

Constructor & Destructor Documentation

oxAddress.__construct

(

)

Class constructor

Returns:

null

Reimplemented from oxBase.

Definition at line 47 of file oxaddress.php.

---

Member Function Documentation

oxAddress.__toString

(

)

Magic getter returns address as a single line string

Returns:

string

Definition at line 58 of file oxaddress.php.

oxAddress._getMergedAddressFields

(

)

[protected]

Returns merged address fields.

Returns:

string

Definition at line 162 of file oxaddress.php.

oxAddress._getStateObject

(

)

[protected]

Returns oxState object

Returns:

oxState

Definition at line 33 of file oxaddress.php.

oxAddress.getEncodedDeliveryAddress

(

)

Returns encoded address.

Returns:

string

Definition at line 93 of file oxaddress.php.

oxAddress.getState

(

)

Return address state id

Deprecated:

since v5.2 (2014-01-10); Naming changed use function getStateId()

Returns:

string

Definition at line 105 of file oxaddress.php.

oxAddress.getStateId

(

)

Get state id for current address

Returns:

mixed

Definition at line 115 of file oxaddress.php.

oxAddress.getStateTitle

(

$

sId = null

)

Get state title

Parameters:

string

$sId state ID

Returns:

string

Definition at line 128 of file oxaddress.php.

oxAddress.isSelected

(

)

Returns TRUE if current address is selected

Returns:

bool

Definition at line 144 of file oxaddress.php.

oxAddress.setSelected

(

)

Sets address state as selected

Definition at line 152 of file oxaddress.php.

oxAddress.toString

(

)

Formats address as a single line string

Returns:

string

Definition at line 68 of file oxaddress.php.

---

Member Data Documentation

oxAddress.$_blSelected = false [protected]

Definition at line 21 of file oxaddress.php.

oxAddress.$_oStateObject = null [protected]

Definition at line 26 of file oxaddress.php.

oxAddress.$_sClassName = 'oxaddress' [protected]

Reimplemented from oxBase.

Definition at line 14 of file oxaddress.php.

---

The documentation for this class was generated from the following file:

• application/models/oxaddress.php