Class Mage_Usa_Model_Shipping_Carrier_Dhl

DHL shipping implementation

Varien_Object

Mage_Usa_Model_Shipping_Carrier_Abstract

Mage_Usa_Model_Shipping_Carrier_Dhl implements Mage_Shipping_Model_Carrier_Interface

Package: Mage\Usa
Category: Mage
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/Dhl.php

Methods summary
`public boolean\|Mage_Shipping_Model_Rate_Result\|null`	# `collectRates( Mage_Shipping_Model_Rate_Request $request )` Collect and get rates Collect and get rates Parameters `$request` `Mage_Shipping_Model_Rate_Request` $request Returns `boolean\|Mage_Shipping_Model_Rate_Result\|null`
`public Mage_Usa_Model_Shipping_Carrier_Dhl`	# `setRequest( Varien_Object $request )` Prepare and set request in property of current instance Prepare and set request in property of current instance Parameters `$request` `Varien_Object` $request Returns `Mage_Usa_Model_Shipping_Carrier_Dhl`
`public mixed`	# `getResult( )` Get result of request Get result of request Returns `mixed`
`protected Mage_Shipping_Model_Rate_Result`	# `_getQuotes( )` Get quotes Get quotes Returns `Mage_Shipping_Model_Rate_Result`
`protected`	# `_setFreeMethodRequest( mixed $freeMethod )` Set free method request Set free method request Parameters `$freeMethod` `mixed` $freeMethod
`protected string`	# `_getShipDate( boolean $domestic = true )` Get shipping date Get shipping date Parameters `$domestic` `boolean` $domestic Returns `string`
`protected Mage_Core_Model_Abstract\|Varien_Object`	# `_getXmlQuotes( )` Get xml quotes Get xml quotes Returns `Mage_Core_Model_Abstract\|Varien_Object`
`protected Mage_Shipping_Model_Rate_Result\|Varien_Object`	# `_doRequest( )` Do rate request and handle errors Do rate request and handle errors Returns `Mage_Shipping_Model_Rate_Result\|Varien_Object`
`protected`	# `_createShipmentXml( mixed $shipment, mixed $shipKey )` Create shipment xml Create shipment xml Parameters `$shipment` `mixed` $shipment `$shipKey` `mixed` $shipKey
`protected Mage_Shipping_Model_Rate_Result\|Varien_Object`	# `_parseXmlResponse( string $response )` Parse xml response and return result Parse xml response and return result Parameters `$response` `string` $response Returns `Mage_Shipping_Model_Rate_Result\|Varien_Object`
`protected Mage_Usa_Model_Shipping_Carrier_Dhl`	# `_parseXmlObject( mixed $shipXml )` Parse xml object Parse xml object Parameters `$shipXml` `mixed` $shipXml Returns `Mage_Usa_Model_Shipping_Carrier_Dhl`
`public array\|boolean`	# `getCode( string $type, string $code = '' )` Get configuration data of carrier Get configuration data of carrier Parameters `$type` `string` $type `$code` `string` $code Returns `array\|boolean`
`protected`	# `_addRate( mixed $shipXml )` Parse xml and add rates to instance property Parse xml and add rates to instance property Parameters `$shipXml` `mixed` $shipXml
`public mixed`	# `getTracking( mixed $trackings )` Get tracking Get tracking Parameters `$trackings` `mixed` $trackings Returns `mixed`
`protected null`	# `setTrackingReqeust( )` Set tracking request Set tracking request Returns `null`
`protected null`	# `_getXMLTracking( array $trackings )` Send request for tracking Send request for tracking Parameters `$trackings` `array` $tracking Returns `null`
`protected null`	# `_parseXmlTrackingResponse( array $trackings, string $response )` Parse xml tracking response Parse xml tracking response Parameters `$trackings` `array` $trackingvalue `$response` `string` $response Returns `null`
`public string`	# `getResponse( )` Get tracking response Get tracking response Returns `string`
`public array`	# `getAllowedMethods( )` Get allowed shipping methods Get allowed shipping methods Returns `array` Implementation of `Mage_Shipping_Model_Carrier_Interface::getAllowedMethods()`
`public boolean`	# `isStateProvinceRequired( )` Is state province required Is state province required Returns `boolean` Overrides `Mage_Shipping_Model_Carrier_Abstract::isStateProvinceRequired()`
`public array`	# `getAdditionalProtectionValueTypes( )` Get additional protection value types Get additional protection value types Returns `array`
`public array`	# `getAdditionalProtectionRoundingTypes( )` Get additional protection rounding types Get additional protection rounding types Returns `array`
`protected null`	# `_mapRequestToShipment( Varien_Object $request )` Map request to shipment Map request to shipment Parameters `$request` `Varien_Object` $request Returns `null`
`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`
`public array\|boolean`	# `getContainerTypes( Varien_Object $params = null )` Return container types of carrier Return container types of carrier Parameters `$params` `Varien_Object\|null` $params Returns `array\|boolean` Overrides `Mage_Shipping_Model_Carrier_Abstract::getContainerTypes()`

Methods inherited from Mage_Usa_Model_Shipping_Carrier_Abstract
`_getCachedQuotes(), _getQuotesCacheKey(), _isUSCountry(), _prepareServiceName(), _prepareShipmentRequest(), _setCachedQuotes(), getAllItems(), getCarrierCode(), getTrackingInfo(), isCityRequired(), isGirthAllowed(), isShippingLabelsAvailable(), isTrackingAvailable(), isZipCodeRequired(), proccessAdditionalValidation(), requestToShipment(), returnOfShipment(), rollBack(), setActiveFlag()`

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

Constants summary
`string`	`CODE`	`'dhl'`	# Code of the carrier Code of the carrier
`integer`	`SUCCESS_CODE`	`203`	#
`integer`	`SUCCESS_LABEL_CODE`	`100`	#
`string`	`ADDITIONAL_PROTECTION_ASSET`	`'AP'`	#
`string`	`ADDITIONAL_PROTECTION_NOT_REQUIRED`	`'NR'`	#
`integer`	`ADDITIONAL_PROTECTION_VALUE_CONFIG`	`0`	#
`integer`	`ADDITIONAL_PROTECTION_VALUE_SUBTOTAL`	`1`	#
`integer`	`ADDITIONAL_PROTECTION_VALUE_SUBTOTAL_WITH_DISCOUNT`	`2`	#
`integer`	`ADDITIONAL_PROTECTION_ROUNDING_FLOOR`	`0`	#
`integer`	`ADDITIONAL_PROTECTION_ROUNDING_CEIL`	`1`	#
`integer`	`ADDITIONAL_PROTECTION_ROUNDING_ROUND`	`2`	#

Constants inherited from Mage_Usa_Model_Shipping_Carrier_Abstract
`GUAM_COUNTRY_ID, GUAM_REGION_CODE, PUERTORICO_COUNTRY_ID`

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 string`	`$_code`	`Mage_Usa_Model_Shipping_Carrier_Dhl::CODE`	# Code of the carrier Code of the carrier
`protected Mage_Shipping_Model_Rate_Request\|null`	`$_request`	`null`	# Rate request data Rate request data
`protected Varien_Object\|null`	`$_rawRequest`	`null`	# Raw rate request data Raw rate request data
`protected Mage_Shipping_Model_Rate_Result\|null`	`$_result`	`null`	# Rate result data Rate result data
`protected array`	`$_errors`	`array()`	# Errors placeholder Errors placeholder
`protected array`	`$_dhlRates`	`array()`	# Dhl rates result Dhl rates result
`protected string`	`$_defaultGatewayUrl`	`'https://eCommerce.airborne.com/ApiLandingTest.asp'`	# Default gateway url Default gateway url
`protected array`	`$_customizableContainerTypes`	`array('P')`	# Container types that could be customized Container types that could be customized

Properties inherited from Mage_Usa_Model_Shipping_Carrier_Abstract
`$_activeFlag, $_quotesCache`

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

Packages

Classes

Class Mage_Usa_Model_Shipping_Carrier_Dhl

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Parameters

Returns

Returns

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Implementation of

Returns

Overrides

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Overrides