Class Mage_Usa_Model_Shipping_Carrier_Abstract

Abstract USA shipping carrier model

Varien_Object

Mage_Usa_Model_Shipping_Carrier_Abstract

Direct known subclasses

Mage_Usa_Model_Shipping_Carrier_Dhl, Mage_Usa_Model_Shipping_Carrier_Dhl_International, Mage_Usa_Model_Shipping_Carrier_Fedex, Mage_Usa_Model_Shipping_Carrier_Ups, Mage_Usa_Model_Shipping_Carrier_Usps

Abstract
Package: Mage\Usa
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Author: Magento Core Team <core@magentocommerce.com>
Located at code/core/Mage/Usa/Model/Shipping/Carrier/Abstract.php

Methods summary
`public Mage_Usa_Model_Shipping_Carrier_Abstract`	# `setActiveFlag( string $code = 'active' )` Set flag for check carriers for activity Set flag for check carriers for activity Parameters `$code` `string` $code Returns `Mage_Usa_Model_Shipping_Carrier_Abstract`
`public string`	# `getCarrierCode( )` Return code of carrier Return code of carrier Returns `string` Overrides `Mage_Shipping_Model_Carrier_Abstract::getCarrierCode()`
`public`	# `getTrackingInfo( mixed $tracking )`
`public boolean`	# `isTrackingAvailable( )` Check if carrier has shipping tracking option available All Mage_Usa carriers have shipping tracking option available Check if carrier has shipping tracking option available All Mage_Usa carriers have shipping tracking option available Returns `boolean` Overrides `Mage_Shipping_Model_Carrier_Abstract::isTrackingAvailable()`
`public boolean`	# `isCityRequired( )` Check if city option required Check if city option required Returns `boolean` Overrides `Mage_Shipping_Model_Carrier_Abstract::isCityRequired()`
`public boolean`	# `isZipCodeRequired( string\|null $countryId = null )` Determine whether zip-code is required for the country of destination Determine whether zip-code is required for the country of destination Parameters `$countryId` `string\|null` $countryId Returns `boolean` Overrides `Mage_Shipping_Model_Carrier_Abstract::isZipCodeRequired()`
`public boolean`	# `isShippingLabelsAvailable( )` Check if carrier has shipping label option available Check if carrier has shipping label option available Returns `boolean` Overrides `Mage_Shipping_Model_Carrier_Abstract::isShippingLabelsAvailable()`
`public array`	# `getAllItems( Mage_Shipping_Model_Rate_Request $request )` Return items for further shipment rate evaluation. We need to pass children of a bundle instead passing the bundle itself, otherwise we may not get a rate at all (e.g. when total weight of a bundle exceeds max weight despite each item by itself is not) Return items for further shipment rate evaluation. We need to pass children of a bundle instead passing the bundle itself, otherwise we may not get a rate at all (e.g. when total weight of a bundle exceeds max weight despite each item by itself is not) Parameters `$request` `Mage_Shipping_Model_Rate_Request` $request Returns `array`
`public Mage_Shipping_Model_Carrier_Abstract\|Mage_Shipping_Model_Rate_Result_Error\|boolean`	# `proccessAdditionalValidation( Mage_Shipping_Model_Rate_Request $request )` Processing additional validation to check if carrier applicable. Processing additional validation to check if carrier applicable. Parameters `$request` `Mage_Shipping_Model_Rate_Request` $request Returns `Mage_Shipping_Model_Carrier_Abstract\|Mage_Shipping_Model_Rate_Result_Error\|boolean` Overrides `Mage_Shipping_Model_Carrier_Abstract::proccessAdditionalValidation()`
`protected string`	# `_getQuotesCacheKey( string\|array $requestParams )` Returns cache key for some request to carrier quotes service Returns cache key for some request to carrier quotes service Parameters `$requestParams` `string\|array` $requestParams Returns `string`
`protected null\|string`	# `_getCachedQuotes( string\|array $requestParams )` 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 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 Parameters `$requestParams` `string\|array` $requestParams Returns `null\|string`
`protected Mage_Usa_Model_Shipping_Carrier_Abstract`	# `_setCachedQuotes( string\|array $requestParams, string $response )` Sets received carrier quotes to cache Sets received carrier quotes to cache Parameters `$requestParams` `string\|array` $requestParams `$response` `string` $response Returns `Mage_Usa_Model_Shipping_Carrier_Abstract`
`protected string`	# `_prepareServiceName( string\|object $name )` Prepare service name. Strip tags and entities from name Prepare service name. Strip tags and entities from name Parameters `$name` `string\|object` $name service name or object with implemented __toString() method Returns `string` prepared service name
`protected`	# `_prepareShipmentRequest( Varien_Object $request )` Prepare shipment request. Validate and correct request information Prepare shipment request. Validate and correct request information Parameters `$request` `Varien_Object` $request
`public array`	# `requestToShipment( Mage_Shipping_Model_Shipment_Request $request )` Do request to shipment Do request to shipment Parameters `$request` `Mage_Shipping_Model_Shipment_Request` $request Returns `array` Overrides `Mage_Shipping_Model_Carrier_Abstract::requestToShipment()`
`public array`	# `returnOfShipment( mixed $request )` Do request to RMA shipment Do request to RMA shipment Parameters `$request` `mixed` $request Returns `array` Overrides `Mage_Shipping_Model_Carrier_Abstract::returnOfShipment()`
`public boolean`	# `rollBack( array $data )` For multi package shipments. Delete requested shipments if the current shipment request is failed For multi package shipments. Delete requested shipments if the current shipment request is failed Parameters `$data` `array` $data Returns `boolean`
`abstract protected Varien_Object`	# `_doShipmentRequest( Varien_Object $request )` Do shipment request to carrier web service, obtain Print Shipping Labels and process errors in response Do shipment request to carrier web service, obtain Print Shipping Labels and process errors in response Parameters `$request` `Varien_Object` $request Returns `Varien_Object`
`protected boolean`	# `_isUSCountry( string $countyId )` Check is Country U.S. Possessions and Trust Territories Check is Country U.S. Possessions and Trust Territories Parameters `$countyId` `string` $countyId Returns `boolean`
`public boolean`	# `isGirthAllowed( null\|string $countyDest = null )` Check whether girth is allowed for the carrier Check whether girth is allowed for the carrier Parameters `$countyDest` `null\|string` $countyDest Returns `boolean`

Methods inherited from Mage_Shipping_Model_Carrier_Abstract
`_debug(), _getAllowedContainers(), _getPerorderPrice(), _getPerpackagePrice(), _updateFreeMethodQuote(), checkAvailableShipCountries(), collectRates(), convertWeightToLbs(), debugData(), getConfigData(), getConfigFlag(), getContainerTypes(), getContentTypes(), getCustomizableContainerTypes(), getDebugFlag(), getDeliveryConfirmationTypes(), getFinalPriceWithHandlingFee(), getMethodPrice(), getSortOrder(), getTotalNumOfBoxes(), isActive(), isFixed(), isStateProvinceRequired()`

Constants summary
`string`	`PUERTORICO_COUNTRY_ID`	`'PR'`	#
`string`	`GUAM_COUNTRY_ID`	`'GU'`	#
`string`	`GUAM_REGION_CODE`	`'GU'`	#

Constants inherited from Mage_Shipping_Model_Carrier_Abstract
`CANADA_COUNTRY_ID, HANDLING_ACTION_PERORDER, HANDLING_ACTION_PERPACKAGE, HANDLING_TYPE_FIXED, HANDLING_TYPE_PERCENT, MEXICO_COUNTRY_ID, USA_COUNTRY_ID`

Properties summary
`protected static array`	`$_quotesCache`	`array()`	#
`protected string`	`$_activeFlag`	`'active'`	# Flag for check carriers for activity Flag for check carriers for activity

Properties inherited from Mage_Shipping_Model_Carrier_Abstract
`$_code, $_customizableContainerTypes, $_debugReplacePrivateDataKeys, $_freeMethod, $_isFixed, $_numBoxes, $_rates`

Packages

Classes

Class Mage_Usa_Model_Shipping_Carrier_Abstract

Direct known subclasses

Parameters

Returns

Returns

Overrides

Returns

Overrides

Returns

Overrides

Parameters

Returns

Overrides

Returns

Overrides

Parameters

Returns

Parameters

Returns

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns