1: <?php
  2: /**
  3:  * Magento
  4:  *
  5:  * NOTICE OF LICENSE
  6:  *
  7:  * This source file is subject to the Open Software License (OSL 3.0)
  8:  * that is bundled with this package in the file LICENSE.txt.
  9:  * It is also available through the world-wide-web at this URL:
 10:  * http://opensource.org/licenses/osl-3.0.php
 11:  * If you did not receive a copy of the license and are unable to
 12:  * obtain it through the world-wide-web, please send an email
 13:  * to license@magentocommerce.com so we can send you a copy immediately.
 14:  *
 15:  * DISCLAIMER
 16:  *
 17:  * Do not edit or add to this file if you wish to upgrade Magento to newer
 18:  * versions in the future. If you wish to customize Magento for your
 19:  * needs please refer to http://www.magentocommerce.com for more information.
 20:  *
 21:  * @category    Mage
 22:  * @package     Mage_Shipping
 23:  * @copyright   Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
 24:  * @license     http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
 25:  */
 26: 
 27: 
 28: /**
 29:  * Free shipping model
 30:  *
 31:  * @category   Mage
 32:  * @package    Mage_Shipping
 33:  * @author      Magento Core Team <core@magentocommerce.com>
 34:  */
 35: class Mage_Shipping_Model_Carrier_Freeshipping
 36:     extends Mage_Shipping_Model_Carrier_Abstract
 37:     implements Mage_Shipping_Model_Carrier_Interface
 38: {
 39: 
 40:     protected $_code = 'freeshipping';
 41:     protected $_isFixed = true;
 42: 
 43:     /**
 44:      * FreeShipping Rates Collector
 45:      *
 46:      * @param Mage_Shipping_Model_Rate_Request $request
 47:      * @return Mage_Shipping_Model_Rate_Result
 48:      */
 49:     public function collectRates(Mage_Shipping_Model_Rate_Request $request)
 50:     {
 51:         if (!$this->getConfigFlag('active')) {
 52:             return false;
 53:         }
 54: 
 55:         $result = Mage::getModel('shipping/rate_result');
 56: 
 57:         $this->_updateFreeMethodQuote($request);
 58: 
 59:         if (($request->getFreeShipping())
 60:             || ($request->getBaseSubtotalInclTax() >= $this->getConfigData('free_shipping_subtotal'))
 61:         ) {
 62:             $method = Mage::getModel('shipping/rate_result_method');
 63: 
 64:             $method->setCarrier('freeshipping');
 65:             $method->setCarrierTitle($this->getConfigData('title'));
 66: 
 67:             $method->setMethod('freeshipping');
 68:             $method->setMethodTitle($this->getConfigData('name'));
 69: 
 70:             $method->setPrice('0.00');
 71:             $method->setCost('0.00');
 72: 
 73:             $result->append($method);
 74:         }
 75: 
 76:         return $result;
 77:     }
 78: 
 79:     /**
 80:      * Allows free shipping when all product items have free shipping (promotions etc.)
 81:      *
 82:      * @param Mage_Shipping_Model_Rate_Request $request
 83:      * @return void
 84:      */
 85:     protected function _updateFreeMethodQuote($request)
 86:     {
 87:         $freeShipping = false;
 88:         $items = $request->getAllItems();
 89:         $c = count($items);
 90:         for ($i = 0; $i < $c; $i++) {
 91:             if ($items[$i]->getProduct() instanceof Mage_Catalog_Model_Product) {
 92:                 if ($items[$i]->getFreeShipping()) {
 93:                     $freeShipping = true;
 94:                 } else {
 95:                     return;
 96:                 }
 97:             }
 98:         }
 99:         if ($freeShipping) {
100:             $request->setFreeShipping(true);
101:         }
102:     }
103: 
104:     public function getAllowedMethods()
105:     {
106:         return array('freeshipping'=>$this->getConfigData('name'));
107:     }
108: 
109: }
110: