Mage_Shipping_Model_Shipping Class Reference

List of all members.

Public Member Functions
	getResult ()
	setOrigData ($data)
	resetResult ()
	getConfig ()
	collectRates (Mage_Shipping_Model_Rate_Request $request)
	collectCarrierRates ($carrierCode, $request)
	collectRatesByAddress (Varien_Object $address, $limitCarrier=null)
	getCarrierByCode ($carrierCode, $storeId=null)
Protected Attributes
	$_orig = null
	$_result = null

---

Detailed Description

Definition at line 28 of file Shipping.php.

---

Member Function Documentation

collectCarrierRates	(	$	carrierCode,
		$	request
	)

Definition at line 125 of file Shipping.php.

    {
        $carrier = $this->getCarrierByCode($carrierCode, $request->getStoreId());
        if (!$carrier) {
            return $this;
        }
        $result = $carrier->checkAvailableShipCountries($request);
        if (false !== $result && !($result instanceof Mage_Shipping_Model_Rate_Result_Error)) {
            $result = $carrier->proccessAdditionalValidation($request);
        }
        /*
        * Result will be false if the admin set not to show the shipping module
        * if the devliery country is not within specific countries
        */
        if (false !== $result){
            if (!$result instanceof Mage_Shipping_Model_Rate_Result_Error) {
                $result = $carrier->collectRates($request);
            }
            // sort rates by price
            if (method_exists($result, 'sortRatesByPrice')) {
                $result->sortRatesByPrice();
            }
            $this->getResult()->append($result);
        }
        return $this;
    }

collectRates

(

Mage_Shipping_Model_Rate_Request $

request

)

Retrieve all methods for supplied shipping data

Todo:

make it ordered

Parameters:

Mage_Shipping_Model_Shipping_Method_Request

$data

Returns:

Mage_Shipping_Model_Shipping

Definition at line 92 of file Shipping.php.

    {
        if (!$request->getOrig()) {
            $request
                ->setCountryId(Mage::getStoreConfig('shipping/origin/country_id', $request->getStore()))
                ->setRegionId(Mage::getStoreConfig('shipping/origin/region_id', $request->getStore()))
                ->setCity(Mage::getStoreConfig('shipping/origin/city', $request->getStore()))
                ->setPostcode(Mage::getStoreConfig('shipping/origin/postcode', $request->getStore()));
        }

        $limitCarrier = $request->getLimitCarrier();
        if (!$limitCarrier) {
            $carriers = Mage::getStoreConfig('carriers', $request->getStoreId());

            foreach ($carriers as $carrierCode=>$carrierConfig) {
                $this->collectCarrierRates($carrierCode, $request);
            }
        } else {
            if (!is_array($limitCarrier)) {
                $limitCarrier = array($limitCarrier);
            }
            foreach ($limitCarrier as $carrierCode) {
                $carrierConfig = Mage::getStoreConfig('carriers/'.$carrierCode, $request->getStoreId());
                if (!$carrierConfig) {
                    continue;
                }
                $this->collectCarrierRates($carrierCode, $request);
            }
        }

        return $this;
    }

collectRatesByAddress	(	Varien_Object $	address,
		$	limitCarrier = null
	)

Definition at line 152 of file Shipping.php.

    {
        $request = Mage::getModel('shipping/rate_request');
        $request->setDestCountryId($address->getCountryId());
        $request->setDestRegionId($address->getRegionId());
        $request->setDestPostcode($address->getPostcode());
        $request->setPackageValue($address->getBaseSubtotal());
        $request->setPackageWeight($address->getWeight());
        $request->setFreeMethodWeight($address->getFreeMethodWeight());
        $request->setPackageQty($address->getItemQty());
        $request->setStoreId(Mage::app()->getStore()->getId());
        $request->setWebsiteId(Mage::app()->getStore()->getWebsiteId());
        $request->setBaseCurrency(Mage::app()->getStore()->getBaseCurrency());
        $request->setPackageCurrency(Mage::app()->getStore()->getCurrentCurrency());

        $request->setLimitCarrier($limitCarrier);

        return $this->collectRates($request);
    }

getCarrierByCode	(	$	carrierCode,
		$	storeId = null
	)

Definition at line 172 of file Shipping.php.

    {
        if (!Mage::getStoreConfigFlag('carriers/'.$carrierCode.'/active', $storeId)) {
            return false;
        }
        $className = Mage::getStoreConfig('carriers/'.$carrierCode.'/model', $storeId);
        if (!$className) {
            return false;
            #Mage::throwException('Invalid carrier: '.$carrierCode);
        }
        $obj = Mage::getModel($className);
        if ($storeId) {
            $obj->setStore($storeId);
        }
        return $obj;
    }

getConfig

(

)

Retrieve configuration model

Returns:

Mage_Shipping_Model_Config

Definition at line 80 of file Shipping.php.

    {
        return Mage::getSingleton('shipping/config');
    }

getResult

(

)

Get shipping rate result model

Returns:

Mage_Shipping_Model_Rate_Result

Definition at line 50 of file Shipping.php.

    {
        if (empty($this->_result)) {
            $this->_result = Mage::getModel('shipping/rate_result');
        }
        return $this->_result;
    }

resetResult

(

)

Reset cached result

Definition at line 69 of file Shipping.php.

    {
        $this->getResult()->reset();
        return $this;
    }

setOrigData

(

$

data

)

Set shipping orig data

Definition at line 61 of file Shipping.php.

    {
        $this->_orig = $data;
    }

---

Member Data Documentation

$_orig = null [protected]

Definition at line 35 of file Shipping.php.

$_result = null [protected]

Definition at line 42 of file Shipping.php.

---

The documentation for this class was generated from the following file:

• app/code/core/Mage/Shipping/Model/Shipping.php