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_Sales
 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:  * Order creditmemo shipping total calculation model
 29:  *
 30:  * @category    Mage
 31:  * @package     Mage_Sales
 32:  * @author      Magento Core Team <core@magentocommerce.com>
 33:  */
 34: class Mage_Sales_Model_Order_Creditmemo_Total_Shipping extends Mage_Sales_Model_Order_Creditmemo_Total_Abstract
 35: {
 36:     public function collect(Mage_Sales_Model_Order_Creditmemo $creditmemo)
 37:     {
 38:         $order = $creditmemo->getOrder();
 39:         $allowedAmount          = $order->getShippingAmount()-$order->getShippingRefunded();
 40:         $baseAllowedAmount      = $order->getBaseShippingAmount()-$order->getBaseShippingRefunded();
 41: 
 42:         $shipping               = $order->getShippingAmount();
 43:         $baseShipping           = $order->getBaseShippingAmount();
 44:         $shippingInclTax        = $order->getShippingInclTax();
 45:         $baseShippingInclTax    = $order->getBaseShippingInclTax();
 46: 
 47:         $isShippingInclTax = Mage::getSingleton('tax/config')->displaySalesShippingInclTax($order->getStoreId());
 48: 
 49:         /**
 50:          * Check if shipping amount was specified (from invoice or another source).
 51:          * Using has magic method to allow setting 0 as shipping amount.
 52:          */
 53:         if ($creditmemo->hasBaseShippingAmount()) {
 54:             $baseShippingAmount = Mage::app()->getStore()->roundPrice($creditmemo->getBaseShippingAmount());
 55:             if ($isShippingInclTax && $baseShippingInclTax != 0) {
 56:                 $part = $baseShippingAmount/$baseShippingInclTax;
 57:                 $shippingInclTax    = Mage::app()->getStore()->roundPrice($shippingInclTax*$part);
 58:                 $baseShippingInclTax= $baseShippingAmount;
 59:                 $baseShippingAmount = Mage::app()->getStore()->roundPrice($baseShipping*$part);
 60:             }
 61:             /*
 62:              * Rounded allowed shipping refund amount is the highest acceptable shipping refund amount.
 63:              * Shipping refund amount shouldn't cause errors, if it doesn't exceed that limit.
 64:              * Note: ($x < $y + 0.0001) means ($x <= $y) for floats
 65:              */
 66:             if ($baseShippingAmount < Mage::app()->getStore()->roundPrice($baseAllowedAmount) + 0.0001) {
 67:                 /*
 68:                  * Shipping refund amount should be equated to allowed refund amount,
 69:                  * if it exceeds that limit.
 70:                  * Note: ($x > $y - 0.0001) means ($x >= $y) for floats
 71:                  */
 72:                 if ($baseShippingAmount > $baseAllowedAmount - 0.0001) {
 73:                     $shipping     = $allowedAmount;
 74:                     $baseShipping = $baseAllowedAmount;
 75:                 } else {
 76:                     if ($baseShipping != 0) {
 77:                         $shipping = $shipping * $baseShippingAmount / $baseShipping;
 78:                     }
 79:                     $shipping     = Mage::app()->getStore()->roundPrice($shipping);
 80:                     $baseShipping = $baseShippingAmount;
 81:                 }
 82:             } else {
 83:                 $baseAllowedAmount = $order->getBaseCurrency()->format($baseAllowedAmount,null,false);
 84:                 Mage::throwException(
 85:                     Mage::helper('sales')->__('Maximum shipping amount allowed to refund is: %s', $baseAllowedAmount)
 86:                 );
 87:             }
 88:         } else {
 89:             if ($baseShipping != 0) {
 90:                 $allowedTaxAmount = $order->getShippingTaxAmount() - $order->getShippingTaxRefunded();
 91:                 $baseAllowedTaxAmount = $order->getBaseShippingTaxAmount() - $order->getBaseShippingTaxRefunded();
 92: 
 93:                 $shippingInclTax = Mage::app()->getStore()->roundPrice($allowedAmount + $allowedTaxAmount);
 94:                 $baseShippingInclTax = Mage::app()->getStore()->roundPrice($baseAllowedAmount + $baseAllowedTaxAmount);
 95:             }
 96:             $shipping           = $allowedAmount;
 97:             $baseShipping       = $baseAllowedAmount;
 98:         }
 99: 
100:         $creditmemo->setShippingAmount($shipping);
101:         $creditmemo->setBaseShippingAmount($baseShipping);
102:         $creditmemo->setShippingInclTax($shippingInclTax);
103:         $creditmemo->setBaseShippingInclTax($baseShippingInclTax);
104: 
105:         $creditmemo->setGrandTotal($creditmemo->getGrandTotal()+$shipping);
106:         $creditmemo->setBaseGrandTotal($creditmemo->getBaseGrandTotal()+$baseShipping);
107:         return $this;
108:     }
109: }
110: