Class Mage_Shipping_Model_Carrier_Abstract

Magento

NOTICE OF LICENSE

This source file is subject to the Open Software License (OSL 3.0) that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://opensource.org/licenses/osl-3.0.php If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@magentocommerce.com so we can send you a copy immediately.

DISCLAIMER

Do not edit or add to this file if you wish to upgrade Magento to newer versions in the future. If you wish to customize Magento for your needs please refer to http://www.magentocommerce.com for more information.

Varien_Object

Mage_Shipping_Model_Carrier_Abstract

Direct known subclasses

Mage_GoogleCheckout_Model_Shipping, Mage_Shipping_Model_Carrier_Flatrate, Mage_Shipping_Model_Carrier_Freeshipping, Mage_Shipping_Model_Carrier_Pickup, Mage_Shipping_Model_Carrier_Tablerate, Mage_Usa_Model_Shipping_Carrier_Abstract

Indirect 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\Shipping
Category: Mage
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Located at code/core/Mage/Shipping/Model/Carrier/Abstract.php

Methods summary
`public mixed`	# `getConfigData( string $field )` Retrieve information from carrier configuration Retrieve information from carrier configuration Parameters `$field` `string` $field Returns `mixed`
`public boolean`	# `getConfigFlag( string $field )` Retrieve config flag for store by field Retrieve config flag for store by field Parameters `$field` `string` $field Returns `boolean`
`abstract public Mage_Shipping_Model_Rate_Result\|boolean\|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 `Mage_Shipping_Model_Rate_Result\|boolean\|null`
`public Varien_Object`	# `requestToShipment( Mage_Shipping_Model_Shipment_Request $request )` Do request to shipment Implementation must be in overridden method Do request to shipment Implementation must be in overridden method Parameters `$request` `Mage_Shipping_Model_Shipment_Request` $request Returns `Varien_Object`
`public Varien_Object`	# `returnOfShipment( mixed $request )` Do return of shipment Implementation must be in overridden method Do return of shipment Implementation must be in overridden method Parameters `$request` `mixed` $request Returns `Varien_Object`
`public array`	# `getContainerTypes( Varien_Object $params = null )` Return container types of carrier Return container types of carrier Parameters `$params` `Varien_Object\|null` $params Returns `array`
`protected array\|boolean`	# `_getAllowedContainers( Varien_Object $params = null )` Get allowed containers of carrier Get allowed containers of carrier Parameters `$params` `Varien_Object\|null` $params Returns `array\|boolean`
`public array`	# `getCustomizableContainerTypes( )` Get Container Types, that could be customized Get Container Types, that could be customized Returns `array`
`public array`	# `getDeliveryConfirmationTypes( Varien_Object $params = null )` Return delivery confirmation types of carrier Return delivery confirmation types of carrier Parameters `$params` `Varien_Object\|null` $params Returns `array`
`public`	# `checkAvailableShipCountries( Mage_Shipping_Model_Rate_Request $request )`
`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 is carrier applicable. Processing additional validation to check is carrier applicable. Parameters `$request` `Mage_Shipping_Model_Rate_Request` $request Returns `Mage_Shipping_Model_Carrier_Abstract\|Mage_Shipping_Model_Rate_Result_Error\|boolean`
`public boolean`	# `isActive( )` Determine whether current carrier enabled for activity Determine whether current carrier enabled for activity Returns `boolean`
`public boolean`	# `isFixed( )` Whether this carrier has fixed rates calculation Whether this carrier has fixed rates calculation Returns `boolean`
`public boolean`	# `isTrackingAvailable( )` Check if carrier has shipping tracking option available Check if carrier has shipping tracking option available Returns `boolean`
`public boolean`	# `isShippingLabelsAvailable( )` Check if carrier has shipping label option available Check if carrier has shipping label option available Returns `boolean`
`public mixed`	# `getSortOrder( )` Retrieve sort order of current carrier Retrieve sort order of current carrier Returns `mixed`
`protected null`	# `_updateFreeMethodQuote( Mage_Shipping_Model_Rate_Request $request )` Parameters `$request` `Mage_Shipping_Model_Rate_Request` $request Returns `null`
`public string`	# `getMethodPrice( string $cost, string $method = '' )` Calculate price considering free shipping and handling fee Calculate price considering free shipping and handling fee Parameters `$cost` `string` $cost `$method` `string` $method Returns `string`
`public float`	# `getFinalPriceWithHandlingFee( float $cost )` get the handling fee for the shipping + cost get the handling fee for the shipping + cost Parameters `$cost` `float` $cost Returns `float` final price for shipping method
`protected float`	# `_getPerpackagePrice( float $cost, string $handlingType, float $handlingFee )` Get final price for shipping method with handling fee per package Get final price for shipping method with handling fee per package Parameters `$cost` `float` $cost `$handlingType` `string` $handlingType `$handlingFee` `float` $handlingFee Returns `float`
`protected float`	# `_getPerorderPrice( float $cost, string $handlingType, float $handlingFee )` Get final price for shipping method with handling fee per order Get final price for shipping method with handling fee per order Parameters `$cost` `float` $cost `$handlingType` `string` $handlingType `$handlingFee` `float` $handlingFee Returns `float`
`public float`	# `convertWeightToLbs( integer $weight )` Return weight in pounds Return weight in pounds Parameters `$weight` `integer` Weight in someone measure Returns `float` Weight in pounds
`public weight`	# `getTotalNumOfBoxes( mixed $weight )` set the number of boxes for shipping set the number of boxes for shipping Returns `weight`
`public boolean`	# `isStateProvinceRequired( )` Is state province required Is state province required Returns `boolean`
`public boolean`	# `isCityRequired( )` Check if city option required Check if city option required Returns `boolean`
`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`
`protected`	# `_debug( mixed $debugData )` Log debug data to file Log debug data to file Parameters `$debugData` `mixed` $debugData
`public boolean`	# `getDebugFlag( )` Define if debugging is enabled Define if debugging is enabled Returns `boolean`
`public`	# `debugData( mixed $debugData )` Used to call debug method from not Payment Method context Used to call debug method from not Payment Method context Parameters `$debugData` `mixed` $debugData
`public string`	# `getCarrierCode( )` Getter for carrier code Getter for carrier code Returns `string`
`public array`	# `getContentTypes( Varien_Object $params )` Return content types of package Return content types of package Parameters `$params` `Varien_Object` $params Returns `array`

Constants summary
`string`	`USA_COUNTRY_ID`	`'US'`	#
`string`	`CANADA_COUNTRY_ID`	`'CA'`	#
`string`	`MEXICO_COUNTRY_ID`	`'MX'`	#
`string`	`HANDLING_TYPE_PERCENT`	`'P'`	#
`string`	`HANDLING_TYPE_FIXED`	`'F'`	#
`string`	`HANDLING_ACTION_PERPACKAGE`	`'P'`	#
`string`	`HANDLING_ACTION_PERORDER`	`'O'`	#

Properties summary
`protected string`	`$_code`		# Carrier's code Carrier's code
`protected array`	`$_rates`	`null`	# Rates result Rates result
`protected integer`	`$_numBoxes`	`1`	# Number of boxes in package Number of boxes in package
`protected string`	`$_freeMethod`	`'free_method'`	# Free Method config path Free Method config path
`protected boolean`	`$_isFixed`	`false`	# Whether this carrier has fixed rates calculation Whether this carrier has fixed rates calculation
`protected array`	`$_customizableContainerTypes`	`array()`	# Container types that could be customized Container types that could be customized
`protected array`	`$_debugReplacePrivateDataKeys`	`array()`	# Fields that should be replaced in debug with '*' Fields that should be replaced in debug with '*'

Packages

Classes

Interfaces

Class Mage_Shipping_Model_Carrier_Abstract

Direct known subclasses

Indirect known subclasses

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns