Mage_Sales_Model_Order_Invoice_Item Class Reference

Inheritance diagram for Mage_Sales_Model_Order_Invoice_Item:

List of all members.

Public Member Functions
	_construct ()
	setInvoice (Mage_Sales_Model_Order_Invoice $invoice)
	getInvoice ()
	setOrderItem (Mage_Sales_Model_Order_Item $item)
	getOrderItem ()
	setQty ($qty)
	register ()
	cancel ()
	calcRowTotal ()
	isLast ()
Protected Attributes
	$_eventPrefix = 'sales_invoice_item'
	$_eventObject = 'invoice_item'
	$_invoice = null
	$_orderItem = null

---

Detailed Description

Definition at line 28 of file Item.php.

---

Member Function Documentation

_construct

(

)

Initialize resource model

Reimplemented from Varien_Object.

Definition at line 39 of file Item.php.

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

calcRowTotal

(

)

Invoice item row total calculation

Returns:

Mage_Sales_Model_Order_Invoice_Item

Definition at line 175 of file Item.php.

    {
        $rowTotal       = $this->getOrderItem()->getRowTotal()/$this->getOrderItem()->getQtyOrdered()*$this->getQty();
        $baseRowTotal   = $this->getOrderItem()->getBaseRowTotal()/$this->getOrderItem()->getQtyOrdered()*$this->getQty();

        $this->setRowTotal($this->getInvoice()->getStore()->roundPrice($rowTotal));
        $this->setBaseRowTotal($this->getInvoice()->getStore()->roundPrice($baseRowTotal));
        return $this;
    }

cancel

(

)

Cancelling invoice item

Returns:

Mage_Sales_Model_Order_Invoice_Item

Definition at line 154 of file Item.php.

    {
        $orderItem = $this->getOrderItem();
        $orderItem->setQtyInvoiced($orderItem->getQtyInvoiced()-$this->getQty());

        $orderItem->setTaxInvoiced($orderItem->getTaxInvoiced()-$this->getTaxAmount());
        $orderItem->setBaseTaxInvoiced($orderItem->getBaseTaxInvoiced()-$this->getBaseTaxAmount());

        $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;
    }

getInvoice

(

)

Retrieve invoice instance

Returns:

Mage_Sales_Model_Order_Invoice

Definition at line 61 of file Item.php.

    {
        return $this->_invoice;
    }

getOrderItem

(

)

Retrieve order item instance

Returns:

Mage_Sales_Model_Order_Item

Definition at line 84 of file Item.php.

    {
        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;
    }

isLast

(

)

Checking if the item is last

Returns:

bool

Definition at line 190 of file Item.php.

    {
        if ($this->getQty() == $this->getOrderItem()->getQtyToInvoice()) {
            return true;
        }
        return false;
    }

register

(

)

Applying qty to order item

Returns:

Mage_Sales_Model_Order_Invoice_Item

Definition at line 133 of file Item.php.

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

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

        $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;
    }

setInvoice

(

Mage_Sales_Model_Order_Invoice $

invoice

)

Declare invoice instance

Parameters:

Mage_Sales_Model_Order_Invoice

$invoice

Returns:

Mage_Sales_Model_Order_Invoice_Item

Definition at line 50 of file Item.php.

    {
        $this->_invoice = $invoice;
        return $this;
    }

setOrderItem

(

Mage_Sales_Model_Order_Item $

item

)

Declare order item instance

Parameters:

Mage_Sales_Model_Order_Item

$item

Returns:

Mage_Sales_Model_Order_Invoice_Item

Definition at line 72 of file Item.php.

    {
        $this->_orderItem = $item;
        $this->setOrderItemId($item->getId());
        return $this;
    }

setQty

(

$

qty

)

Declare qty

Parameters:

float

$qty

Returns:

Mage_Sales_Model_Order_Invoice_Item

Check qty availability

Definition at line 104 of file Item.php.

    {
        if ($this->getOrderItem()->getIsQtyDecimal()) {
            $qty = (float) $qty;
        }
        else {
            $qty = (int) $qty;
        }
        $qty = $qty > 0 ? $qty : 0;
        /**
         * Check qty availability
         */

        if ($qty <= $this->getOrderItem()->getQtyToInvoice() || $this->getOrderItem()->isDummy()) {
            $this->setData('qty', $qty);
        }
        else {
            Mage::throwException(
                Mage::helper('sales')->__('Invalid qty to invoice item "%s"', $this->getName())
            );
        }
        return $this;
    }

---

Member Data Documentation

$_eventObject = 'invoice_item' [protected]

Reimplemented from Mage_Core_Model_Abstract.

Definition at line 31 of file Item.php.

$_eventPrefix = 'sales_invoice_item' [protected]

Reimplemented from Mage_Core_Model_Abstract.

Definition at line 30 of file Item.php.

$_invoice = null [protected]

Definition at line 33 of file Item.php.

$_orderItem = null [protected]

Definition at line 34 of file Item.php.

---

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

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