Docs For Class Mage_Usa_Model_Shipping_Carrier

Description

Abstract USA shipping carrier model

author: Magento Core Team <[email protected]>
copyright: Copyright (c) 2010 Magento Inc. (http://www.magentocommerce.com)
abstract:

Located in /Usa/Model/Shipping/Carrier/Abstract.php (line 32)

Varien_Object
   |
   --Mage_Shipping_Model_Carrier_Abstract
      |
      --Mage_Usa_Model_Shipping_Carrier_Abstract

Direct descendents

Class	Description
Mage_Usa_Model_Shipping_Carrier_Usps	USPS shipping rates estimation
Mage_Usa_Model_Shipping_Carrier_Dhl	DHL shipping rates estimation
Mage_Usa_Model_Shipping_Carrier_Ups	UPS shipping rates estimation
Mage_Usa_Model_Shipping_Carrier_Fedex	Fedex shipping rates estimation

Class Constant Summary

GUAM_COUNTRY_ID = 'GU'

GUAM_REGION_CODE = 'GU'

PUERTORICO_COUNTRY_ID = 'PR'

USA_COUNTRY_ID = 'US'

Variable Summary

static mixed $_quotesCache

Method Summary

void getTrackingInfo ( $tracking)

void isCityRequired ()

boolean isTrackingAvailable ()

void isZipCodeRequired ()

Mage_Shipping_Model_Carrier_Abstract|Mage_Shipping_Model_Rate_Result_Error|boolean proccessAdditionalValidation ( $request)

null|string _getCachedQuotes (string|array $requestParams)

string _getQuotesCacheKey (string|array $requestParams)

Mage_Usa_Model_Shipping_Carrier_Abstract _setCachedQuotes (string|array $requestParams, string $response)

Variables

static mixed $_quotesCache = array() (line 40)

access: protected

Inherited Variables

Inherited from Mage_Shipping_Model_Carrier_Abstract

Mage_Shipping_Model_Carrier_Abstract::$_code
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

getTrackingInfo (line 42)

access: public

void getTrackingInfo ( $tracking)

$tracking

isCityRequired (line 71)

access: public

void isCityRequired ()

Redefinition of:

Mage_Shipping_Model_Carrier_Abstract::isCityRequired()

isTrackingAvailable (line 66)

Check if carrier has shipping tracking option available All Mage_Usa carriers have shipping tracking option available

access: public

boolean isTrackingAvailable ()

Redefinition of:

Mage_Shipping_Model_Carrier_Abstract::isTrackingAvailable(): Check if carrier has shipping tracking option available

isZipCodeRequired (line 76)

access: public

void isZipCodeRequired ()

Redefinition of:

Mage_Shipping_Model_Carrier_Abstract::isZipCodeRequired()

Redefined in descendants as:

Mage_Usa_Model_Shipping_Carrier_Usps::isZipCodeRequired() : Check is Zip Code Required

proccessAdditionalValidation (line 87)

Processing additional validation to check is carrier applicable.

access: public

Mage_Shipping_Model_Carrier_Abstract|Mage_Shipping_Model_Rate_Result_Error|boolean proccessAdditionalValidation ( $request)

Mage_Shipping_Model_Rate_Request $request

Redefinition of:

Mage_Shipping_Model_Carrier_Abstract::proccessAdditionalValidation(): Processing additional validation to check is carrier applicable.

Redefined in descendants as:

Mage_Usa_Model_Shipping_Carrier_Usps::proccessAdditionalValidation() : Processing additional validation to check is carrier applicable.

_getCachedQuotes (line 148)

Checks whether some request to rates have already been done, so we have cache for it Used to reduce number of same requests done to carrier service during one session

Returns cached response or null

access: protected

null|string _getCachedQuotes (string|array $requestParams)

string|array $requestParams

_getQuotesCacheKey (line 131)

Returns cache key for some request to carrier quotes service

access: protected

string _getQuotesCacheKey (string|array $requestParams)

string|array $requestParams

_setCachedQuotes (line 161)

Sets received carrier quotes to cache

access: protected

Mage_Usa_Model_Shipping_Carrier_Abstract _setCachedQuotes (string|array $requestParams, string $response)

string|array $requestParams
string $response

Inherited Methods

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

GUAM_COUNTRY_ID = 'GU' (line 37)

GUAM_REGION_CODE = 'GU' (line 38)

PUERTORICO_COUNTRY_ID = 'PR' (line 36)

USA_COUNTRY_ID = 'US' (line 35)

Inherited Constants

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

Class Mage_Usa_Model_Shipping_Carrier_Abstract

Inherited Variables

Inherited Methods

Inherited Constants