Class Mage_Usa_Model_Shipping_Carrier_Usps

Description
Description | Vars (details) | Methods (details) Constants

Implements interfaces:

USPS shipping rates estimation

Located in /Usa/Model/Shipping/Carrier/Usps.php (line 36) 

Varien_Object
   |
   --Mage_Shipping_Model_Carrier_Abstract
      |
      --Mage_Usa_Model_Shipping_Carrier_Abstract
         |
         --Mage_Usa_Model_Shipping_Carrier_Usps
Variable Summary
Description | Vars (details) | Methods (details) Constants
mixed $_code
mixed $_defaultGatewayUrl
boolean $_isZipCodeRequired
mixed $_request
mixed $_result
Method Summary
Description | Constants Vars (details) | Methods (details)
void collectRates ( $request)
array getAllowedMethods ()
void getCode ( $type, [ $code = ''])
void getResponse ()
void getResult ()
void getTracking ( $trackings)
boolean isZipCodeRequired ()
Mage_Shipping_Model_Carrier_Abstract|Mage_Shipping_Model_Rate_Result_Error|boolean proccessAdditionalValidation ( $request)
void setRequest ( $request)
void setTrackingReqeust ()
string _filterServiceName (string $name)
string|false _getCountryName (string $countryId)
void _getQuotes ()
Mage_Shipping_Model_Rate_Result _getXmlQuotes ()
void _getXmlTracking ( $trackings)
boolean _isUSCountry (string $countyId)
Mage_Shipping_Model_Rate_Result _parseXmlResponse (string $response)
void _parseXmlTrackingResponse ( $trackingvalue,  $response)
void _setFreeMethodRequest ( $freeMethod)
Variables
Description | Vars (details) Constants | Methods (details)
mixed $_code = 'usps' (line 47)
  • access: protected
Redefinition of:
Mage_Shipping_Model_Carrier_Abstract::$_code
mixed $_defaultGatewayUrl = 'http://production.shippingapis.com/ShippingAPI.dll' (line 53)
  • access: protected
boolean $_isZipCodeRequired (line 45)

Destination Zip Code required flag

  • access: protected
mixed $_request = null (line 49)
  • access: protected
mixed $_result = null (line 51)
  • access: protected

Inherited Variables

Inherited from Mage_Usa_Model_Shipping_Carrier_Abstract

Mage_Usa_Model_Shipping_Carrier_Abstract::$_quotesCache

Inherited from Mage_Shipping_Model_Carrier_Abstract

Mage_Shipping_Model_Carrier_Abstract::$_debugReplacePrivateDataKeys
 Mage_Shipping_Model_Carrier_Abstract::$_isFixed
 Mage_Shipping_Model_Carrier_Abstract::$_numBoxes
 Mage_Shipping_Model_Carrier_Abstract::$_rates
Methods
Description | Vars (details) Constants Methods (details)
collectRates (line 83)
  • access: public
void collectRates ( $request)
Redefinition of:
Mage_Shipping_Model_Carrier_Abstract::collectRates()
getAllowedMethods (line 625)

Get allowed shipping methods

  • access: public
array getAllowedMethods ()
getCode (line 364)
  • access: public
void getCode ( $type, [ $code = ''])
  • $type
  • $code
getResponse (line 598)
  • access: public
void getResponse ()
getResult (line 175)
  • access: public
void getResult ()
getTracking (line 488)
  • access: public
void getTracking ( $trackings)
  • $trackings
isZipCodeRequired (line 60)

Check is Zip Code Required

  • access: public
boolean isZipCodeRequired ()
Redefinition of:
Mage_Usa_Model_Shipping_Carrier_Abstract::isZipCodeRequired()
proccessAdditionalValidation (line 75)

Processing additional validation to check is carrier applicable.

  • access: public
Mage_Shipping_Model_Carrier_Abstract|Mage_Shipping_Model_Rate_Result_Error|boolean proccessAdditionalValidation ( $request)
Redefinition of:
Mage_Usa_Model_Shipping_Carrier_Abstract::proccessAdditionalValidation()
Processing additional validation to check is carrier applicable.
setRequest (line 98)
  • access: public
void setRequest ( $request)
setTrackingReqeust (line 501)
  • access: protected
void setTrackingReqeust ()
_filterServiceName (line 903)

Clean service name from unsupported strings and characters

  • access: protected
string _filterServiceName (string $name)
  • string $name
_getCountryName (line 664)

Return USPS county name by country ISO 3166-1-alpha-2 code Return false for unknown countries

  • access: protected
string|false _getCountryName (string $countryId)
  • string $countryId
_getQuotes (line 180)
  • access: protected
void _getQuotes ()
_getXmlQuotes (line 201)

Build RateV3 request, send it to USPS gateway and retrieve quotes in XML format

Mage_Shipping_Model_Rate_Result _getXmlQuotes ()
_getXmlTracking (line 512)
  • access: protected
void _getXmlTracking ( $trackings)
  • $trackings
_isUSCountry (line 641)

Check is Сoutry U.S. Possessions and Trust Territories

  • access: protected
boolean _isUSCountry (string $countyId)
  • string $countyId
_parseXmlResponse (line 291)

Parse calculated rates

Mage_Shipping_Model_Rate_Result _parseXmlResponse (string $response)
  • string $response
_parseXmlTrackingResponse (line 552)
  • access: protected
void _parseXmlTrackingResponse ( $trackingvalue,  $response)
  • $trackingvalue
  • $response
_setFreeMethodRequest (line 185)
  • access: protected
void _setFreeMethodRequest ( $freeMethod)
  • $freeMethod

Inherited Methods

Inherited From Mage_Usa_Model_Shipping_Carrier_Abstract

Mage_Usa_Model_Shipping_Carrier_Abstract::getTrackingInfo()
Mage_Usa_Model_Shipping_Carrier_Abstract::isCityRequired()
Mage_Usa_Model_Shipping_Carrier_Abstract::isTrackingAvailable()
Mage_Usa_Model_Shipping_Carrier_Abstract::isZipCodeRequired()
Mage_Usa_Model_Shipping_Carrier_Abstract::proccessAdditionalValidation()
Mage_Usa_Model_Shipping_Carrier_Abstract::_getCachedQuotes()
Mage_Usa_Model_Shipping_Carrier_Abstract::_getQuotesCacheKey()
Mage_Usa_Model_Shipping_Carrier_Abstract::_setCachedQuotes()

Inherited From Mage_Shipping_Model_Carrier_Abstract

Mage_Shipping_Model_Carrier_Abstract::__construct()
Mage_Shipping_Model_Carrier_Abstract::checkAvailableShipCountries()
Mage_Shipping_Model_Carrier_Abstract::collectRates()
Mage_Shipping_Model_Carrier_Abstract::convertWeightToLbs()
Mage_Shipping_Model_Carrier_Abstract::debugData()
Mage_Shipping_Model_Carrier_Abstract::getCarrierCode()
Mage_Shipping_Model_Carrier_Abstract::getConfigData()
Mage_Shipping_Model_Carrier_Abstract::getConfigFlag()
Mage_Shipping_Model_Carrier_Abstract::getDebugFlag()
Mage_Shipping_Model_Carrier_Abstract::getFinalPriceWithHandlingFee()
Mage_Shipping_Model_Carrier_Abstract::getMethodPrice()
Mage_Shipping_Model_Carrier_Abstract::getSortOrder()
Mage_Shipping_Model_Carrier_Abstract::getTotalNumOfBoxes()
Mage_Shipping_Model_Carrier_Abstract::isActive()
Mage_Shipping_Model_Carrier_Abstract::isCityRequired()
Mage_Shipping_Model_Carrier_Abstract::isFixed()
Mage_Shipping_Model_Carrier_Abstract::isStateProvinceRequired()
Mage_Shipping_Model_Carrier_Abstract::isTrackingAvailable()
Mage_Shipping_Model_Carrier_Abstract::isZipCodeRequired()
Mage_Shipping_Model_Carrier_Abstract::proccessAdditionalValidation()
Mage_Shipping_Model_Carrier_Abstract::_debug()
Mage_Shipping_Model_Carrier_Abstract::_updateFreeMethodQuote()
Class Constants
Description | Constants (details) Vars (details) | Methods (details)

Inherited Constants

Inherited from Mage_Usa_Model_Shipping_Carrier_Abstract

Mage_Usa_Model_Shipping_Carrier_Abstract::GUAM_COUNTRY_ID
 Mage_Usa_Model_Shipping_Carrier_Abstract::GUAM_REGION_CODE
 Mage_Usa_Model_Shipping_Carrier_Abstract::PUERTORICO_COUNTRY_ID
 Mage_Usa_Model_Shipping_Carrier_Abstract::USA_COUNTRY_ID

Inherited from Mage_Shipping_Model_Carrier_Abstract

Mage_Shipping_Model_Carrier_Abstract::HANDLING_ACTION_PERORDER
 Mage_Shipping_Model_Carrier_Abstract::HANDLING_ACTION_PERPACKAGE
 Mage_Shipping_Model_Carrier_Abstract::HANDLING_TYPE_FIXED
 Mage_Shipping_Model_Carrier_Abstract::HANDLING_TYPE_PERCENT

Documentation generated on Fri, 11 Feb 2011 17:15:44 +0200 by phpDocumentor 1.4.3