ValidAddress Class Reference

Public Member Functions
	getAddressCode ()
	getLine1 ()
	getLine2 ()
	getLine3 ()
	getCity ()
	getRegion ()
	getPostalCode ()
	getCountry ()
	getTaxRegionId ()
	equals (&$other)
	getLine4 ()
	getCounty ()
	getFipsCode ()
	getCarrierRoute ()
	getPostNet ()
	getAddressType ()
	getLatitude ()
	getLongitude ()
	setAddressCode ($value)
	setLine1 ($value)
	setLine2 ($value)
	setLine3 ($value)
	setCity ($value)
	setRegion ($value)
	setPostalCode ($value)
	setCountry ($value)
	setTaxRegionId ($value)
	setLine4 ($value)
	setCounty ($value)
	setFipsCode ($value)
	setCarrierRoute ($value)
	setPostNet ($value)
	setAddressType ($value)
	setLatitude ($value)
	setLongitude ($value)

Private Attributes
	$AddressCode
	$Line1
	$Line2
	$Line3
	$City
	$Region
	$PostalCode
	$Country = 'USA'
	$Line4
	$County
	$FipsCode
	$CarrierRoute
	$PostNet
	$AddressType
	$Latitude
	$Longitude
	$TaxRegionId = 0

Member Function Documentation

ValidAddress::equals

(

&

$other

)

Compare Addresses public

Parameters

Address

Returns

boolean

ValidAddress::getAddressCode

(

)

#+ Accessor public

Returns

string

ValidAddress::getAddressType

(

)

Address Type - The type of address that was coded (PO Box, Rural Route, and so on), using the input address.

Code	Type
F		Firm or company address
G		General Delivery address
H		High-rise or business complexs
P		PO Box address
R		Rural route address
S		Street or residential address

See also

AddressType

Returns

string

ValidAddress::getCarrierRoute

(

)

The carrier route associated with the input address (USA).

The CarrierRoute Property is a 4 character string set after a successful return from the VerifyAddress Method.

The first character of this property is always alphabetic, and the last three characters are numeric. For example, "R001" or "C027" would be typical carrier routes. The alphabetic letter indicates the type of delivery associated with this address.

Term	Description
B	PO Box
C	City Delivery
G	General Delivery
H	Highway Contract
R	Rural Route

Returns

carrierRoute

ValidAddress::getCity

(

)

ValidAddress::getCountry

(

)

ValidAddress::getCounty

(

)

County Name.

Returns

county - County Name

ValidAddress::getFipsCode

(

)

Federal Information Processing Standards Code (USA).

This is a unique code representing each geographic combination of state, county, and city. The code is made up of the Federal Information Processing Code (FIPS) that uniquely identifies each state, county, and city in the U.S. See Federal Information Processing Standards (FIPS) Codes for more details.

Digits	Description
1-2	State code
3-5	County code
6-10	City code

Returns

fipsCode

ValidAddress::getLatitude

(

)

Gets the latitude value for this ValidAddress.

Returns

latitude

ValidAddress::getLine1

(

)

ValidAddress::getLine2

(

)

ValidAddress::getLine3

(

)

ValidAddress::getLine4

(

)

Address line 4.

Returns

line4 - Address line 4

ValidAddress::getLongitude

(

)

Gets the longitude value for this ValidAddress.

Returns

longitude

ValidAddress::getPostalCode

(

)

ValidAddress::getPostNet

(

)

A 12-digit POSTNet barcode (USA).

Digits	Description
1-5		ZIP Code
6-9		Plus4 code
10-11		Delivery point
12		Check digit

Returns

postNet

ValidAddress::getRegion

(

)

ValidAddress::getTaxRegionId

(

)

#- Accessor public

Returns

integer

ValidAddress::setAddressCode

(

$value

)

ValidAddress::setAddressType

(

$value

)

ValidAddress::setCarrierRoute

(

$value

)

ValidAddress::setCity

(

$value

)

ValidAddress::setCountry

(

$value

)

ValidAddress::setCounty

(

$value

)

ValidAddress::setFipsCode

(

$value

)

ValidAddress::setLatitude

(

$value

)

Sets the latitude value for this ValidAddress.

Parameters

latitude

ValidAddress::setLine1

(

$value

)

ValidAddress::setLine2

(

$value

)

ValidAddress::setLine3

(

$value

)

ValidAddress::setLine4

(

$value

)

ValidAddress::setLongitude

(

$value

)

Sets the longitude value for this ValidAddress.

Parameters

longitude

ValidAddress::setPostalCode

(

$value

)

ValidAddress::setPostNet

(

$value

)

ValidAddress::setRegion

(

$value

)

ValidAddress::setTaxRegionId

(

$value

)

#- Mutator public

Parameters

integer

Returns

Address

Member Data Documentation

ValidAddress::$AddressCode

private

ValidAddress::$AddressType

private

ValidAddress::$CarrierRoute

private

ValidAddress::$City

private

ValidAddress::$Country = 'USA'

private

ValidAddress::$County

private

ValidAddress::$FipsCode

private

ValidAddress::$Latitude

private

ValidAddress::$Line1

private

ValidAddress::$Line2

private

ValidAddress::$Line3

private

ValidAddress::$Line4

private

ValidAddress::$Longitude

private

ValidAddress::$PostalCode

private

ValidAddress::$PostNet

private

ValidAddress::$Region

private

ValidAddress::$TaxRegionId = 0

private

---

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

• plugins/vmcalculation/avalara/classes/ValidAddress.class.php