PHP Class Usps\Address

Show file Open project: vinceg/usps-php-api

Protected Properties

Property Type Description
$addressInfo list of all key=>value pairs we added so far for the current address

Public Methods

Method Description
getAddressInfo ( ) : array Returns a list of all the info we gathered so far in the current address object.
setAddress ( string | integer $value ) : object Set the address2 property.
setApt ( string | integer $value ) : object Set the address1 property usually the apt or suit number.
setCity ( string | integer $value ) : object Set the city property.
setField ( string | integer $key, string | integer $value ) : object Add an element to the stack.
setFirmName ( string | integer $value ) : object Set the firmname property.
setState ( string | integer $value ) : object Set the state property.
setZip4 ( string | integer $value ) : object Set the zip4 property - zip code value represented by 4 integers.
setZip5 ( string | integer $value ) : object Set the zip5 property - zip code value represented by 5 integers.

Method Details

getAddressInfo() public method

Returns a list of all the info we gathered so far in the current address object.
public getAddressInfo ( ) : array
return array

setAddress() public method

Set the address2 property.
public setAddress ( string | integer $value ) : object
$value string | integer
return object Address

setApt() public method

Set the address1 property usually the apt or suit number.
public setApt ( string | integer $value ) : object
$value string | integer
return object Address

setCity() public method

Set the city property.
public setCity ( string | integer $value ) : object
$value string | integer
return object Address

setField() public method

Add an element to the stack.
public setField ( string | integer $key, string | integer $value ) : object
$key string | integer
$value string | integer
return object Address

setFirmName() public method

Set the firmname property.
public setFirmName ( string | integer $value ) : object
$value string | integer
return object Address

setState() public method

Set the state property.
public setState ( string | integer $value ) : object
$value string | integer
return object Address

setZip4() public method

Set the zip4 property - zip code value represented by 4 integers.
public setZip4 ( string | integer $value ) : object
$value string | integer
return object Address

setZip5() public method

Set the zip5 property - zip code value represented by 5 integers.
public setZip5 ( string | integer $value ) : object
$value string | integer
return object Address

Property Details

$addressInfo protected property

list of all key=>value pairs we added so far for the current address
protected $addressInfo