Mage_Sales_Model_Order_Shipment_Item Class Reference

Inheritance diagram for Mage_Sales_Model_Order_Shipment_Item:

List of all members.

Public Member Functions
	_construct ()
	setShipment (Mage_Sales_Model_Order_Shipment $shipment)
	getShipment ()
	setOrderItem (Mage_Sales_Model_Order_Item $item)
	getOrderItem ()
	setQty ($qty)
	register ()
Protected Attributes
	$_eventPrefix = 'sales_shipment_item'
	$_eventObject = 'shipment_item'
	$_shipment = null
	$_orderItem = null

---

Detailed Description

Definition at line 27 of file Item.php.

---

Member Function Documentation

_construct

(

)

Initialize resource model

Reimplemented from Varien_Object.

Definition at line 38 of file Item.php.

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

getOrderItem

(

)

Retrieve order item instance

Returns:

Mage_Sales_Model_Order_Item

Definition at line 83 of file Item.php.

    {
        if (is_null($this->_orderItem)) {
            if ($this->getShipment()) {
                $this->_orderItem = $this->getShipment()->getOrder()->getItemById($this->getOrderItemId());
            }
            else {
                $this->_orderItem = Mage::getModel('sales/order_item')
                    ->load($this->getOrderItemId());
            }
        }
        return $this->_orderItem;
    }

getShipment

(

)

Retrieve Shipment instance

Returns:

Mage_Sales_Model_Order_Shipment

Definition at line 60 of file Item.php.

    {
        return $this->_shipment;
    }

register

(

)

Applying qty to order item

Returns:

Mage_Sales_Model_Order_Shipment_Item

Definition at line 131 of file Item.php.

    {
        $this->getOrderItem()->setQtyShipped(
            $this->getOrderItem()->getQtyShipped()+$this->getQty()
        );
        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_Shipment_Item

Definition at line 71 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 103 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()->getQtyToShip() || $this->getOrderItem()->isDummy(true)) {
            $this->setData('qty', $qty);
        }
        else {
            Mage::throwException(
                Mage::helper('sales')->__('Invalid qty to ship for item "%s"', $this->getName())
            );
        }
        return $this;
    }

setShipment

(

Mage_Sales_Model_Order_Shipment $

shipment

)

Declare Shipment instance

Parameters:

Mage_Sales_Model_Order_Shipment

$shipment

Returns:

Mage_Sales_Model_Order_Shipment_Item

Definition at line 49 of file Item.php.

    {
        $this->_shipment = $shipment;
        return $this;
    }

---

Member Data Documentation

$_eventObject = 'shipment_item' [protected]

Reimplemented from Mage_Core_Model_Abstract.

Definition at line 30 of file Item.php.

$_eventPrefix = 'sales_shipment_item' [protected]

Reimplemented from Mage_Core_Model_Abstract.

Definition at line 29 of file Item.php.

$_orderItem = null [protected]

Definition at line 33 of file Item.php.

$_shipment = null [protected]

Definition at line 32 of file Item.php.

---

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

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