Docs For Class Mage_Sales_Model_Order

Description

Order Item Model

author: Magento Core Team <[email protected]>

Located in /Sales/Model/Order/Item.php (line 34)

Varien_Object
   |
   --Mage_Core_Model_Abstract
      |
      --Mage_Sales_Model_Order_Item

Class Constant Summary

STATUS_BACKORDERED = 3

STATUS_CANCELED = 5

STATUS_INVOICED = 9

STATUS_MIXED = 7

STATUS_PARTIAL = 6

STATUS_PENDING = 1

STATUS_REFUNDED = 8

STATUS_RETURNED = 4

STATUS_SHIPPED = 2

Variable Summary

static mixed $_statuses

mixed $_children

mixed $_eventObject

mixed $_eventPrefix

Mage_Sales_Model_Order $_order

mixed $_parentItem

Method Summary

static array getStatuses ()

static string getStatusName ( $statusId)

void addChildItem (Mage_Sales_Model_Order_Item $item)

Mage_Sales_Model_Order_Item cancel ()

bool canInvoice ()

bool canRefund ()

bool canShip ()

Varien_Object getBuyRequest ()

array getChildrenItems ()

Mage_Sales_Model_Order getOrder ()

float getOriginalPrice ()

Mage_Sales_Model_Order_Item getParentItem ()

array getProductOptionByCode ([string $code = null])

array getProductOptions ()

float|integer getQtyToCancel ()

float|integer getQtyToInvoice ()

float|integer getQtyToRefund ()

float|integer getQtyToShip ()

string getRealProductType ()

string getStatus ()

int getStatusId ()

bool isChildrenCalculated ()

bool isDummy ([bool $shipment = false])

bool isShipSeparately ()

Mage_Sales_Model_Order_Item setOrder (Mage_Sales_Model_Order $order)

Mage_Sales_Model_Order_Item setParentItem (Mage_Sales_Model_Order_Item $item)

Mage_Sales_Model_Order_Item setProductOptions ( $options)

Mage_Sales_Model_Order_Item _beforeSave ()

void _construct ()

float|null _getQtyChildrenBackordered ()

Variables

static mixed $_statuses = null (line 51)

access: protected

mixed $_children = array() (line 60)

access: protected

mixed $_eventObject = 'item' (line 49)

access: protected

Redefinition of:

Mage_Core_Model_Abstract::$_eventObject: Parameter name in event

mixed $_eventPrefix = 'sales_order_item' (line 48)

access: protected

Redefinition of:

Mage_Core_Model_Abstract::$_eventPrefix: Prefix of model events names

Mage_Sales_Model_Order $_order = null (line 58)

Order instance

access: protected

mixed $_parentItem = null (line 59)

access: protected

Inherited Variables

Inherited from Mage_Core_Model_Abstract

Mage_Core_Model_Abstract::$_cacheTag
Mage_Core_Model_Abstract::$_dataSaveAllowed
Mage_Core_Model_Abstract::$_isObjectNew
Mage_Core_Model_Abstract::$_resource
Mage_Core_Model_Abstract::$_resourceCollectionName
Mage_Core_Model_Abstract::$_resourceName

Methods

static method getStatuses (line 342)

Retrieve order item statuses array

access: public

static array getStatuses ()

static method getStatusName (line 310)

Retrieve status name

access: public

static string getStatusName ( $statusId)

$statusId

addChildItem (line 437)

Adds child item to this item

access: public

void addChildItem (Mage_Sales_Model_Order_Item $item)

Mage_Sales_Model_Order_Item $item

cancel (line 326)

Cancel order item

access: public

Mage_Sales_Model_Order_Item cancel ()

canInvoice (line 118)

Check item invoice availability

access: public

bool canInvoice ()

canRefund (line 138)

Check item refund availability

access: public

bool canRefund ()

canShip (line 128)

Check item ship availability

access: public

bool canShip ()

getBuyRequest (line 546)

Returns formatted buy request - object, holding request received from product view page with keys and options for configured product

access: public

Varien_Object getBuyRequest ()

getChildrenItems (line 451)

Return chilgren items of this item

access: public

array getChildrenItems ()

getOrder (line 221)

Retrieve order model object

access: public

Mage_Sales_Model_Order getOrder ()

getOriginalPrice (line 366)

Redeclare getter for back compatibility

access: public

float getOriginalPrice ()

getParentItem (line 108)

Get parent item

return: || null
access: public

Mage_Sales_Model_Order_Item getParentItem ()

getProductOptionByCode (line 407)

Get product options array by code.

If code is null return all options

access: public

array getProductOptionByCode ([string $code = null])

string $code

getProductOptions (line 392)

Get product options array

access: public

array getProductOptions ()

getQtyToCancel (line 197)

Retrieve item qty available for cancel

access: public

float|integer getQtyToCancel ()

getQtyToInvoice (line 166)

Retrieve item qty available for invoice

access: public

float|integer getQtyToInvoice ()

getQtyToRefund (line 183)

Retrieve item qty available for refund

access: public

float|integer getQtyToRefund ()

getQtyToShip (line 148)

Retrieve item qty available for ship

access: public

float|integer getQtyToShip ()

getRealProductType (line 424)

Return real product type of item or NULL if item is not composite

return: | null
access: public

string getRealProductType ()

getStatus (line 300)

Retrieve status

access: public

string getStatus ()

getStatusId (line 236)

Retrieve item status identifier

access: public

int getStatusId ()

isChildrenCalculated (line 461)

Return checking of what calculation type was for this product

access: public

bool isChildrenCalculated ()

isDummy (line 503)

This is Dummy item or not if $shipment is true then we checking this for shipping situation if not then we checking this for calculation

access: public

bool isDummy ([bool $shipment = false])

bool $shipment

isShipSeparately (line 481)

Return checking of what shipment type was for this product

access: public

bool isShipSeparately ()

setOrder (line 209)

Declare order

access: public

Mage_Sales_Model_Order_Item setOrder (Mage_Sales_Model_Order $order)

Mage_Sales_Model_Order $order

setParentItem (line 93)

Set parent item

access: public

Mage_Sales_Model_Order_Item setParentItem (Mage_Sales_Model_Order_Item $item)

Mage_Sales_Model_Order_Item $item

setProductOptions (line 381)

Set product options

access: public

Mage_Sales_Model_Order_Item setProductOptions ( $options)

array $options

_beforeSave (line 75)

Prepare data before save

access: protected

Mage_Sales_Model_Order_Item _beforeSave ()

Redefinition of:

Mage_Core_Model_Abstract::_beforeSave(): Processing object before save data

_construct (line 65)

Init resource model

access: protected

void _construct ()

_getQtyChildrenBackordered (line 285)

Retrieve backordered qty of children items

access: protected

float|null _getQtyChildrenBackordered ()

Inherited Methods

Inherited From Mage_Core_Model_Abstract

Mage_Core_Model_Abstract::afterCommitCallback()
Mage_Core_Model_Abstract::afterLoad()
Mage_Core_Model_Abstract::cleanModelCache()
Mage_Core_Model_Abstract::clearInstance()
Mage_Core_Model_Abstract::delete()
Mage_Core_Model_Abstract::getCacheIdTags()
Mage_Core_Model_Abstract::getCacheTags()
Mage_Core_Model_Abstract::getCollection()
Mage_Core_Model_Abstract::getEntityId()
Mage_Core_Model_Abstract::getId()
Mage_Core_Model_Abstract::getIdFieldName()
Mage_Core_Model_Abstract::getResource()
Mage_Core_Model_Abstract::getResourceCollection()
Mage_Core_Model_Abstract::getResourceName()
Mage_Core_Model_Abstract::isObjectNew()
Mage_Core_Model_Abstract::load()
Mage_Core_Model_Abstract::save()
Mage_Core_Model_Abstract::setId()
Mage_Core_Model_Abstract::_afterDelete()
Mage_Core_Model_Abstract::_afterDeleteCommit()
Mage_Core_Model_Abstract::_afterLoad()
Mage_Core_Model_Abstract::_afterSave()
Mage_Core_Model_Abstract::_afterSaveCommit()
Mage_Core_Model_Abstract::_beforeDelete()
Mage_Core_Model_Abstract::_beforeLoad()
Mage_Core_Model_Abstract::_beforeSave()
Mage_Core_Model_Abstract::_clearData()
Mage_Core_Model_Abstract::_clearReferences()
Mage_Core_Model_Abstract::_getEventData()
Mage_Core_Model_Abstract::_getResource()
Mage_Core_Model_Abstract::_hasModelChanged()
Mage_Core_Model_Abstract::_init()
Mage_Core_Model_Abstract::_protectFromNonAdmin()
Mage_Core_Model_Abstract::_setResourceModel()

Class Constants

STATUS_BACKORDERED = 3 (line 40)

STATUS_CANCELED = 5 (line 41)

STATUS_INVOICED = 9 (line 39)

STATUS_MIXED = 7 (line 43)

STATUS_PARTIAL = 6 (line 42)

STATUS_PENDING = 1 (line 37)

STATUS_REFUNDED = 8 (line 44)

STATUS_RETURNED = 4 (line 46)

STATUS_SHIPPED = 2 (line 38)

Class Mage_Sales_Model_Order_Item

Inherited Variables

Inherited Methods