/app/code/core/Mage/Sales/Model/Order/Invoice/Item.php

<?php

/**

 * 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.

 *

 * @category    Mage

 * @package     Mage_Sales

 * @copyright   Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)

 * @license     http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)

 */





/**

 * Enter description here ...

 *

 * @method Mage_Sales_Model_Resource_Order_Invoice_Item _getResource()

 * @method Mage_Sales_Model_Resource_Order_Invoice_Item getResource()

 * @method int getParentId()

 * @method Mage_Sales_Model_Order_Invoice_Item setParentId(int $value)

 * @method float getBasePrice()

 * @method Mage_Sales_Model_Order_Invoice_Item setBasePrice(float $value)

 * @method float getBaseWeeeTaxRowDisposition()

 * @method Mage_Sales_Model_Order_Invoice_Item setBaseWeeeTaxRowDisposition(float $value)

 * @method float getWeeeTaxAppliedRowAmount()

 * @method Mage_Sales_Model_Order_Invoice_Item setWeeeTaxAppliedRowAmount(float $value)

 * @method float getBaseWeeeTaxAppliedAmount()

 * @method Mage_Sales_Model_Order_Invoice_Item setBaseWeeeTaxAppliedAmount(float $value)

 * @method float getTaxAmount()

 * @method Mage_Sales_Model_Order_Invoice_Item setTaxAmount(float $value)

 * @method float getBaseRowTotal()

 * @method Mage_Sales_Model_Order_Invoice_Item setBaseRowTotal(float $value)

 * @method float getDiscountAmount()

 * @method Mage_Sales_Model_Order_Invoice_Item setDiscountAmount(float $value)

 * @method float getRowTotal()

 * @method Mage_Sales_Model_Order_Invoice_Item setRowTotal(float $value)

 * @method float getWeeeTaxRowDisposition()

 * @method Mage_Sales_Model_Order_Invoice_Item setWeeeTaxRowDisposition(float $value)

 * @method float getBaseDiscountAmount()

 * @method Mage_Sales_Model_Order_Invoice_Item setBaseDiscountAmount(float $value)

 * @method float getBaseWeeeTaxDisposition()

 * @method Mage_Sales_Model_Order_Invoice_Item setBaseWeeeTaxDisposition(float $value)

 * @method float getPriceInclTax()

 * @method Mage_Sales_Model_Order_Invoice_Item setPriceInclTax(float $value)

 * @method float getWeeeTaxAppliedAmount()

 * @method Mage_Sales_Model_Order_Invoice_Item setWeeeTaxAppliedAmount(float $value)

 * @method float getBaseTaxAmount()

 * @method Mage_Sales_Model_Order_Invoice_Item setBaseTaxAmount(float $value)

 * @method float getBasePriceInclTax()

 * @method Mage_Sales_Model_Order_Invoice_Item setBasePriceInclTax(float $value)

 * @method float getQty()

 * @method float getWeeeTaxDisposition()

 * @method Mage_Sales_Model_Order_Invoice_Item setWeeeTaxDisposition(float $value)

 * @method float getBaseCost()

 * @method Mage_Sales_Model_Order_Invoice_Item setBaseCost(float $value)

 * @method float getBaseWeeeTaxAppliedRowAmount()

 * @method Mage_Sales_Model_Order_Invoice_Item setBaseWeeeTaxAppliedRowAmount(float $value)

 * @method float getPrice()

 * @method Mage_Sales_Model_Order_Invoice_Item setPrice(float $value)

 * @method float getBaseRowTotalInclTax()

 * @method Mage_Sales_Model_Order_Invoice_Item setBaseRowTotalInclTax(float $value)

 * @method float getRowTotalInclTax()

 * @method Mage_Sales_Model_Order_Invoice_Item setRowTotalInclTax(float $value)

 * @method int getProductId()

 * @method Mage_Sales_Model_Order_Invoice_Item setProductId(int $value)

 * @method int getOrderItemId()

 * @method Mage_Sales_Model_Order_Invoice_Item setOrderItemId(int $value)

 * @method string getAdditionalData()

 * @method Mage_Sales_Model_Order_Invoice_Item setAdditionalData(string $value)

 * @method string getDescription()

 * @method Mage_Sales_Model_Order_Invoice_Item setDescription(string $value)

 * @method string getWeeeTaxApplied()

 * @method Mage_Sales_Model_Order_Invoice_Item setWeeeTaxApplied(string $value)

 * @method string getSku()

 * @method Mage_Sales_Model_Order_Invoice_Item setSku(string $value)

 * @method string getName()

 * @method Mage_Sales_Model_Order_Invoice_Item setName(string $value)

 * @method float getHiddenTaxAmount()

 * @method Mage_Sales_Model_Order_Invoice_Item setHiddenTaxAmount(float $value)

 * @method float getBaseHiddenTaxAmount()

 * @method Mage_Sales_Model_Order_Invoice_Item setBaseHiddenTaxAmount(float $value)

 *

 * @category    Mage

 * @package     Mage_Sales

 * @author      Magento Core Team <core@magentocommerce.com>

 */

class Mage_Sales_Model_Order_Invoice_Item extends Mage_Core_Model_Abstract

{

    protected $_eventPrefix = 'sales_invoice_item';

    protected $_eventObject = 'invoice_item';



    protected $_invoice = null;

    protected $_orderItem = null;



    /**

     * Initialize resource model

     */

    function _construct()

    {

        $this->_init('sales/order_invoice_item');

    }



    /**

     * Init mapping array of short fields to

     * its full names

     *

     * @return Varien_Object

     */

    protected function _initOldFieldsMap()

    {

        $this->_oldFieldsMap = Mage::helper('sales')->getOldFieldMap('invoice_item');

        return $this;

    }

    /**

     * Declare invoice instance

     *

     * @param   Mage_Sales_Model_Order_Invoice $invoice

     * @return  Mage_Sales_Model_Order_Invoice_Item

     */

    public function setInvoice(Mage_Sales_Model_Order_Invoice $invoice)

    {

        $this->_invoice = $invoice;

        return $this;

    }



    /**

     * Retrieve invoice instance

     *

     * @return Mage_Sales_Model_Order_Invoice

     */

    public function getInvoice()

    {

        return $this->_invoice;

    }



    /**

     * Declare order item instance

     *

     * @param   Mage_Sales_Model_Order_Item $item

     * @return  Mage_Sales_Model_Order_Invoice_Item

     */

    public function setOrderItem(Mage_Sales_Model_Order_Item $item)

    {

        $this->_orderItem = $item;

        $this->setOrderItemId($item->getId());

        return $this;

    }



    /**

     * Retrieve order item instance

     *

     * @return Mage_Sales_Model_Order_Item

     */

    public function getOrderItem()

    {

        if (is_null($this->_orderItem)) {

            if ($this->getInvoice()) {

                $this->_orderItem = $this->getInvoice()->getOrder()->getItemById($this->getOrderItemId());

            }

            else {

                $this->_orderItem = Mage::getModel('sales/order_item')

                    ->load($this->getOrderItemId());

            }

        }

        return $this->_orderItem;

    }



    /**

     * Declare qty

     *

     * @param   float $qty

     * @return  Mage_Sales_Model_Order_Invoice_Item

     */

    public function setQty($qty)

    {

        if ($this->getOrderItem()->getIsQtyDecimal()) {

            $qty = (float) $qty;

        }

        else {

            $qty = (int) $qty;

        }

        $qty = $qty > 0 ? $qty : 0;

        /**

         * Check qty availability

         */

        $qtyToInvoice = sprintf("%F", $this->getOrderItem()->getQtyToInvoice());

        $qty = sprintf("%F", $qty);

        if ($qty <= $qtyToInvoice || $this->getOrderItem()->isDummy()) {

            $this->setData('qty', $qty);

        }

        else {

            Mage::throwException(

                Mage::helper('sales')->__('Invalid qty to invoice item "%s"', $this->getName())

            );

        }

        return $this;

    }



    /**

     * Applying qty to order item

     *

     * @return Mage_Sales_Model_Order_Invoice_Item

     */

    public function register()

    {

        $orderItem = $this->getOrderItem();

        $orderItem->setQtyInvoiced($orderItem->getQtyInvoiced()+$this->getQty());



        $orderItem->setTaxInvoiced($orderItem->getTaxInvoiced()+$this->getTaxAmount());

        $orderItem->setBaseTaxInvoiced($orderItem->getBaseTaxInvoiced()+$this->getBaseTaxAmount());

        $orderItem->setHiddenTaxInvoiced($orderItem->getHiddenTaxInvoiced()+$this->getHiddenTaxAmount());

        $orderItem->setBaseHiddenTaxInvoiced($orderItem->getBaseHiddenTaxInvoiced()+$this->getBaseHiddenTaxAmount());



        $orderItem->setDiscountInvoiced($orderItem->getDiscountInvoiced()+$this->getDiscountAmount());

        $orderItem->setBaseDiscountInvoiced($orderItem->getBaseDiscountInvoiced()+$this->getBaseDiscountAmount());



        $orderItem->setRowInvoiced($orderItem->getRowInvoiced()+$this->getRowTotal());

        $orderItem->setBaseRowInvoiced($orderItem->getBaseRowInvoiced()+$this->getBaseRowTotal());

        return $this;

    }



    /**

     * Cancelling invoice item

     *

     * @return Mage_Sales_Model_Order_Invoice_Item

     */

    public function cancel()

    {

        $orderItem = $this->getOrderItem();

        $orderItem->setQtyInvoiced($orderItem->getQtyInvoiced()-$this->getQty());



        $orderItem->setTaxInvoiced($orderItem->getTaxInvoiced()-$this->getTaxAmount());

        $orderItem->setBaseTaxInvoiced($orderItem->getBaseTaxInvoiced()-$this->getBaseTaxAmount());

        $orderItem->setHiddenTaxInvoiced($orderItem->getHiddenTaxInvoiced()-$this->getHiddenTaxAmount());

        $orderItem->setBaseHiddenTaxInvoiced($orderItem->getBaseHiddenTaxInvoiced()-$this->getBaseHiddenTaxAmount());





        $orderItem->setDiscountInvoiced($orderItem->getDiscountInvoiced()-$this->getDiscountAmount());

        $orderItem->setBaseDiscountInvoiced($orderItem->getBaseDiscountInvoiced()-$this->getBaseDiscountAmount());



        $orderItem->setRowInvoiced($orderItem->getRowInvoiced()-$this->getRowTotal());

        $orderItem->setBaseRowInvoiced($orderItem->getBaseRowInvoiced()-$this->getBaseRowTotal());

        return $this;

    }



    /**

     * Invoice item row total calculation

     *

     * @return Mage_Sales_Model_Order_Invoice_Item

     */

    public function calcRowTotal()

    {

        $invoice        = $this->getInvoice();

        $orderItem      = $this->getOrderItem();

        $orderItemQty   = $orderItem->getQtyOrdered();



        $rowTotal            = $orderItem->getRowTotal() - $orderItem->getRowInvoiced();

        $baseRowTotal        = $orderItem->getBaseRowTotal() - $orderItem->getBaseRowInvoiced();

        $rowTotalInclTax     = $orderItem->getRowTotalInclTax();

        $baseRowTotalInclTax = $orderItem->getBaseRowTotalInclTax();



        if (!$this->isLast()) {

            $availableQty = $orderItemQty - $orderItem->getQtyInvoiced();

            $rowTotal = $invoice->roundPrice($rowTotal / $availableQty * $this->getQty());

            $baseRowTotal = $invoice->roundPrice($baseRowTotal / $availableQty * $this->getQty(), 'base');

        }



        $this->setRowTotal($rowTotal);

        $this->setBaseRowTotal($baseRowTotal);



        if ($rowTotalInclTax && $baseRowTotalInclTax) {

            $this->setRowTotalInclTax($invoice->roundPrice($rowTotalInclTax / $orderItemQty * $this->getQty(), 'including'));

            $this->setBaseRowTotalInclTax($invoice->roundPrice($baseRowTotalInclTax / $orderItemQty * $this->getQty(), 'including_base'));

        }

        return $this;

    }



    /**

     * Checking if the item is last

     *

     * @return bool

     */

    public function isLast()

    {

        if ((string)(float)$this->getQty() == (string)(float)$this->getOrderItem()->getQtyToInvoice()) {

            return true;

        }

        return false;

    }



    /**

     * Before object save

     *

     * @return Mage_Sales_Model_Order_Invoice_Item

     */

    protected function _beforeSave()

    {

        parent::_beforeSave();



        if (!$this->getParentId() && $this->getInvoice()) {

            $this->setParentId($this->getInvoice()->getId());

        }



        return $this;

    }



    /**

     * After object save

     *

     * @return Mage_Sales_Model_Order_Invoice_Item

     */

    protected function _afterSave()

    {

        if (null ==! $this->_orderItem) {

            $this->_orderItem->save();

        }



        parent::_afterSave();

        return $this;

    }

}