Class Mage_Shipping_Model_Shipping

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.

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/Shipping.php

Methods summary
`public Mage_Shipping_Model_Rate_Result`	# `getResult( )` Get shipping rate result model Get shipping rate result model Returns `Mage_Shipping_Model_Rate_Result`
`public null`	# `setOrigData( array $data )` Set shipping orig data Set shipping orig data Parameters `$data` `array` $data Returns `null`
`public Mage_Shipping_Model_Shipping`	# `resetResult( )` Reset cached result Reset cached result Returns `Mage_Shipping_Model_Shipping`
`public Mage_Shipping_Model_Config`	# `getConfig( )` Retrieve configuration model Retrieve configuration model Returns `Mage_Shipping_Model_Config`
`public Mage_Shipping_Model_Shipping`	# `collectRates( Mage_Shipping_Model_Rate_Request $request )` Retrieve all methods for supplied shipping data Retrieve all methods for supplied shipping data Parameters `$request` `Mage_Shipping_Model_Shipping_Method_Request` $data Returns `Mage_Shipping_Model_Shipping`
`public Mage_Shipping_Model_Shipping`	# `collectCarrierRates( string $carrierCode, Mage_Shipping_Model_Rate_Request $request )` Collect rates of given carrier Collect rates of given carrier Parameters `$carrierCode` `string` $carrierCode `$request` `Mage_Shipping_Model_Rate_Request` $request Returns `Mage_Shipping_Model_Shipping`
`public array`	# `composePackagesForCarrier( Mage_Shipping_Model_Carrier_Abstract $carrier, Mage_Shipping_Model_Rate_Request $request )` Compose Packages For Carrier. Devides order into items and items into parts if it's neccesary Compose Packages For Carrier. Devides order into items and items into parts if it's neccesary Parameters `$carrier` `Mage_Shipping_Model_Carrier_Abstract` $carrier `$request` `Mage_Shipping_Model_Rate_Request` $request Returns `array` [int, float]
`protected array`	# `_makePieces( array $items, float $maxWeight )` Make pieces Compose packeges list based on given items, so that each package is as heavy as possible Make pieces Compose packeges list based on given items, so that each package is as heavy as possible Parameters `$items` `array` $items `$maxWeight` `float` $maxWeight Returns `array`
`public Mage_Shipping_Model_Shipping`	# `collectRatesByAddress( Varien_Object $address, null\|boolean\|array $limitCarrier = null )` Collect rates by address Collect rates by address Parameters `$address` `Varien_Object` $address `$limitCarrier` `null\|boolean\|array` $limitCarrier Returns `Mage_Shipping_Model_Shipping`
`public Mage_Shipping_Model_Shipping`	# `setCarrierAvailabilityConfigField( string $code = 'active' )` Set part of carrier xml config path Set part of carrier xml config path Parameters `$code` `string` $code Returns `Mage_Shipping_Model_Shipping`
`public boolean\|Mage_Core_Model_Abstract`	# `getCarrierByCode( string $carrierCode, null\|integer $storeId = null )` Get carrier by its code Get carrier by its code Parameters `$carrierCode` `string` $carrierCode `$storeId` `null\|integer` $storeId Returns `boolean\|Mage_Core_Model_Abstract`
`public Varien_Object`	# `requestToShipment( Mage_Sales_Model_Order_Shipment $orderShipment )` Prepare and do request to shipment Prepare and do request to shipment Parameters `$orderShipment` `Mage_Sales_Model_Order_Shipment` $orderShipment Returns `Varien_Object`

Constants summary
`string`	`XML_PATH_STORE_ADDRESS1`	`'shipping/origin/street_line1'`	# Store address Store address
`string`	`XML_PATH_STORE_ADDRESS2`	`'shipping/origin/street_line2'`	#
`string`	`XML_PATH_STORE_CITY`	`'shipping/origin/city'`	#
`string`	`XML_PATH_STORE_REGION_ID`	`'shipping/origin/region_id'`	#
`string`	`XML_PATH_STORE_ZIP`	`'shipping/origin/postcode'`	#
`string`	`XML_PATH_STORE_COUNTRY_ID`	`'shipping/origin/country_id'`	#

Properties summary
`protected array`	`$_orig`	`null`	# Default shipping orig for requests Default shipping orig for requests
`protected Mage_Sales_Model_Shipping_Method_Result`	`$_result`	`null`	# Cached result Cached result
`protected string`	`$_availabilityConfigField`	`'active'`	# Part of carrier xml config path Part of carrier xml config path

Packages

Classes

Interfaces

Class Mage_Shipping_Model_Shipping

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns