VirtueMart  3.2.14.9808
Public Member Functions | Private Attributes | List of all members
Address Class Reference

Public Member Functions

 __construct ($line1=null, $line2=null, $line3=null, $city=null, $region=null, $postalCode=null, $country='USA', $taxRegionId=0, $latitude=null, $longitude=null)
 
 setAddressCode ($value)
 
 setLine1 ($value)
 
 setLine2 ($value)
 
 setLine3 ($value)
 
 setCity ($value)
 
 setRegion ($value)
 
 setPostalCode ($value)
 
 setCountry ($value)
 
 setTaxRegionId ($value)
 
 setLatitude ($value)
 
 setLongitude ($value)
 
 getAddressCode ()
 
 getLine1 ()
 
 getLine2 ()
 
 getLine3 ()
 
 getCity ()
 
 getRegion ()
 
 getPostalCode ()
 
 getCountry ()
 
 getTaxRegionId ()
 
 getLatitude ()
 
 getLongitude ()
 
 equals (&$other)
 

Private Attributes

 $AddressCode
 
 $Line1
 
 $Line2
 
 $Line3
 
 $City
 
 $Region
 
 $PostalCode
 
 $Country = 'USA'
 
 $TaxRegionId = 0
 
 $Latitude
 
 $Longitude
 

Constructor & Destructor Documentation

Address::__construct (   $line1 = null,
  $line2 = null,
  $line3 = null,
  $city = null,
  $region = null,
  $postalCode = null,
  $country = 'USA',
  $taxRegionId = 0,
  $latitude = null,
  $longitude = null 
)

Construct a new Address.

Constructs a new instance of Address.

$address = new Address();
Parameters
string$line1
string$line2
string$line3
string$city
string$region
string$postalCode
string$country
integer$taxRegionId
String$latitude
String$longitude

Member Function Documentation

Address::equals ( $other)

Compares Addresses public

Parameters
Address
Returns
boolean
Address::getAddressCode ( )

Programmatically determined value used internally by the adapter.

Returns
string $value
Address::getCity ( )

City name

Returns
string $value
Address::getCountry ( )

Country name

Returns
string $value
Address::getLatitude ( )

Latitude Value

Returns
string $value
Address::getLine1 ( )

Address line 1

Returns
string $value
Address::getLine2 ( )

Address line 2

Returns
string $value
Address::getLine3 ( )

Address line 3

Returns
string $value
Address::getLongitude ( )

Longitude Value

Returns
string $value
Address::getPostalCode ( )

Postal or ZIP code

Returns
string $value
Address::getRegion ( )

State or province name or abbreviation

Returns
string $value
Address::getTaxRegionId ( )

TaxRegionId provides the ability to override the tax region assignment for an address.

Returns
string $value
Address::setAddressCode (   $value)

Programmatically determined value used internally by the adapter.

Parameters
string$value
Address::setCity (   $value)

City name

Parameters
string$value
Address::setCountry (   $value)

Country name

Parameters
string$value
Address::setLatitude (   $value)

Set Latitude Value

Parameters
string$value
Address::setLine1 (   $value)

Address line 1

Parameters
string$value
Address::setLine2 (   $value)

Address line 2

Parameters
string$value
Address::setLine3 (   $value)

Address line 3

Parameters
string$value
Address::setLongitude (   $value)

Set Longitude Value

Parameters
string$value
Address::setPostalCode (   $value)

Postal or ZIP code

Parameters
string$value
Address::setRegion (   $value)

State or province name or abbreviation

Parameters
string$value
Address::setTaxRegionId (   $value)

TaxRegionId provides the ability to override the tax region assignment for an address.

Parameters
string$value

Member Data Documentation

Address::$AddressCode
private
Address::$City
private
Address::$Country = 'USA'
private
Address::$Latitude
private
Address::$Line1
private
Address::$Line2
private
Address::$Line3
private
Address::$Longitude
private
Address::$PostalCode
private
Address::$Region
private
Address::$TaxRegionId = 0
private

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