oxAddress Class Reference

Inheritance diagram for oxAddress:

Collaboration diagram for oxAddress:

Public Member Functions
	__construct ()
	__toString ()
	toString ()
	getEncodedDeliveryAddress ()
	getState ()
	getStateId ()
	getStateTitle ($sId=null)
	isSelected ()
	setSelected ()
Public Member Functions inherited from oxBase
	getUseSkipSaveFields ()
	setUseSkipSaveFields ($blUseSkipSaveFields)
	__set ($sName, $sValue)
	__get ($sName)
	__isset ($mVar)
	__clone ()
	oxClone ($oObject)
	getUpdateSeo ()
	setUpdateSeo ($blUpdateSeo)
	init ($sTableName=null, $blForceAllFields=false)
	assign ($dbRecord)
	getClassName ()
	getCoreTableName ()
	getId ()
	setId ($sOXID=null)
	setShopId ($iShopId)
	getShopId ()
	getViewName ($blForceCoreTableUsage=null)
	modifyCacheKey ($sCacheKey, $blOverride=false)
	disableLazyLoading ()
	isDerived ()
	setIsDerived ($blVal)
	isMultilang ()
	load ($sOXID)
	isLoaded ()
	buildSelectString ($aWhere=null)
	assignRecord ($sSelect)
	getFieldData ($sFieldName)
	getSelectFields ($blForceCoreTableUsage=null)
	delete ($sOxId=null)
	save ()
	allowDerivedUpdate ()
	allowDerivedDelete ()
	exists ($sOXID=null)
	getSqlActiveSnippet ($blForceCoreTable=null)
	beforeUpdate ($sOXID=null)
	onChange ($iAction=null, $sOXID=null)
	setInList ()
	isOx ()
	isReadOnly ()
	setReadOnly ($blReadOnly)
	getFieldNames ()
	addFieldName ($sName)
	getLanguage ()
Public Member Functions inherited from oxSuperCfg
	__call ($sMethod, $aArgs)
	getConfig ()
	setConfig ($oConfig)
	getSession ()
	setSession ($oSession)
	getUser ()
	setUser ($oUser)
	isAdmin ()
	setAdminMode ($blAdmin)

Protected Member Functions
	_getStateObject ()
	_getMergedAddressFields ()
Protected Member Functions inherited from oxBase
	_setUpdateSeoOnFieldChange ($sField)
	_removeElement2ShopRelations ($sOxId)
	_isInList ()
	_getObjectViewName ($sTable, $sShopID=null)
	_getTableFields ($sTable, $blReturnSimple=false)
	_getAllFields ($blReturnSimple=false)
	_initDataStructure ($blForceFullStructure=false)
	_getNonCachedFieldNames ($blForceFullStructure=false)
	_getFieldStatus ($sFieldName)
	_addField ($sName, $iStatus, $sType=null, $sLength=null)
	_getFieldLongName ($sFieldName)
	_setFieldData ($sFieldName, $sValue, $iDataType=oxField::T_TEXT)
	_canFieldBeNull ($sFieldName)
	_getFieldDefaultValue ($sFieldName)
	_getUpdateFieldValue ($sFieldName, $oField)
	_getUpdateFields ($blUseSkipSaveFields=true)
	_insert ()
	_isDisabledFieldCache ()
	_addSkippedSaveFieldsForMapping ()
	_disableLazyLoadingForCaching ()

Protected Attributes
	$_sClassName = 'oxaddress'
	$_blSelected = false
	$_oStateObject = null
Protected Attributes inherited from oxBase
	$_sOXID = null
	$_iShopId = null
	$_blIsSimplyClonable = true
	$_sClassName = 'oxbase'
	$_sCoreTable = null
	$_sViewTable = null
	$_aFieldNames = array('oxid' => 0)
	$_sCacheKey = null
	$_blUseLazyLoading = false
	$_aSkipSaveFields = array('oxtimestamp')
	$_blUseSkipSaveFields = true
	$_sExistKey = 'oxid'
	$_blIsDerived = null
	$_blIsSeoObject = false
	$_blUpdateSeo = true
	$_blReadOnly = false
	$_blIsInList = false
	$_isLoaded = false
	$_aInnerLazyCache = null
	$_blEmployMultilanguage = false

Additional Inherited Members
Static Protected Attributes inherited from oxBase
static	$_blDisableFieldCaching = array()

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

Definition at line 14 of file oxaddress.php.

---

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

• application/models/oxaddress.php