Class Mage_Sales_Model_Quote_Item_Abstract

Description
Description | Descendents | Vars (details) | Methods (details)

Implements interfaces:

Quote item abstract model

Price attributes:

  • price - initial item price, declared during product association
  • original_price - product price before any calculations
  • calculation_price - prices for item totals calculation
  • custom_price - new price that can be declared by user and recalculated during calculation process
  • original_custom_price - original defined value of custom price without any convertion

Located in /Sales/Model/Quote/Item/Abstract.php (line 41) 

Varien_Object
   |
   --Mage_Core_Model_Abstract
      |
      --Mage_Sales_Model_Quote_Item_Abstract
Direct descendents
Description | Descendents | Vars (details) | Methods (details)
Class Description
Mage_Sales_Model_Quote_Item Sales Quote Item Model
Mage_Sales_Model_Quote_Address_Item Magento
Variable Summary
Description | Descendents | Vars (details) | Methods (details)
mixed $_children
mixed $_messages
mixed $_parentItem
Method Summary
Description | Descendents | Vars (details) | Methods (details)
Mage_Sales_Model_Quote_Item_Abstract addChild (Mage_Sales_Model_Quote_Item_Abstract $child)
Mage_Sales_Model_Quote_Item_Abstract addMessage (string $message)
Mage_Sales_Model_Quote_Item calcRowTotal ()
Mage_Sales_Model_Quote_Item calcTaxAmount ()
Mage_Sales_Model_Quote_Item_Abstract checkData ()
float getBaseCalculationPrice ()
float getBaseOriginalPrice ()
decimal getBaseTaxAmount ()
float getCalculationPrice ()
array getChildren ()
float getConvertedPrice ()
null|Varien_Object getFileDownloadParams ()
int getIsNominal ()
array|string getMessage ([bool $string = true])
float getOriginalPrice ()
Mage_Sales_Model_Quote_Item getParentItem ()
decimal getPrice ()
Mage_Catalog_Model_Product getProduct ()
int|float getQty ()
Mage_Sales_Model_Quote getQuote ()
Mage_Core_Model_Store getStore ()
decimal getTaxAmount ()
int|float getTotalQty ()
bool isChildrenCalculated ()
bool isNominal ()
bool isShipSeparately ()
Mage_Sales_Model_Quote_Item_Abstract setConvertedPrice (float $value)
Mage_Sales_Model_Quote_Item_Abstract setCustomPrice (float $value)
Mage_Sales_Model_Quote_Item_Abstract setMessage (mixed $messages)
Mage_Sales_Model_Quote_Item_Abstract setOriginalPrice (float $price)
Mage_Sales_Model_Quote_Item setParentItem (Mage_Sales_Model_Quote_Item $parentItem)
Mage_Sales_Model_Quote_Item_Abstract setPrice (float $value)
Mage_Sales_Model_Quote_Item_Abstract _beforeSave ()
decimal _calculatePrice ( $value, [ $saveTaxes = true])
Mage_Sales_Model_Quote_Item __clone ()
Variables
Description | Descendents | Vars (details) | Methods (details)
mixed $_children = array() (line 45)
  • access: protected
mixed $_messages = array() (line 46)
  • access: protected
mixed $_parentItem = null (line 44)
  • access: protected

Inherited Variables

Inherited from Mage_Core_Model_Abstract

Mage_Core_Model_Abstract::$_cacheTag
 Mage_Core_Model_Abstract::$_dataSaveAllowed
 Mage_Core_Model_Abstract::$_eventObject
 Mage_Core_Model_Abstract::$_eventPrefix
 Mage_Core_Model_Abstract::$_isObjectNew
 Mage_Core_Model_Abstract::$_resource
 Mage_Core_Model_Abstract::$_resourceCollectionName
 Mage_Core_Model_Abstract::$_resourceName
Methods
Description | Descendents | Vars (details) Methods (details)
addChild (line 148)

Add child item

  • access: public
Mage_Sales_Model_Quote_Item_Abstract addChild (Mage_Sales_Model_Quote_Item_Abstract $child)
addMessage (line 180)

Add message of quote item to array of messages

  • access: public
Mage_Sales_Model_Quote_Item_Abstract addMessage (string $message)
  • string $message
calcRowTotal (line 279)

Calculate item row total price

  • access: public
Mage_Sales_Model_Quote_Item calcRowTotal ()
calcTaxAmount (line 537)

Calculate item tax amount

  • deprecated: logic moved to tax totals calculation model
  • access: public
Mage_Sales_Model_Quote_Item calcTaxAmount ()
checkData (line 215)

Checking item data

  • access: public
Mage_Sales_Model_Quote_Item_Abstract checkData ()
Redefined in descendants as:
getBaseCalculationPrice (line 315)

Get calculation price used for quote calculation in base currency.

  • access: public
float getBaseCalculationPrice ()
getBaseOriginalPrice (line 389)

Get Original item price (got from product) in base website currency

  • access: public
float getBaseOriginalPrice ()
getBaseTaxAmount (line 608)

Get item base tax amount

  • deprecated:
  • access: public
decimal getBaseTaxAmount ()
getCalculationPrice (line 296)

Get item price used for quote calculation process.

This method get custom price (if ut defined) or original product final price

  • access: public
float getCalculationPrice ()
getChildren (line 137)

Get chil items

  • access: public
array getChildren ()
getConvertedPrice (line 434)

Get item price converted to quote currency

  • access: public
float getConvertedPrice ()
getFileDownloadParams (line 87)

Returns special download params (if needed) for custom option with type = 'file' Needed to implement Mage_Catalog_Model_Product_Configuration_Item_Interface.

Return null, as quote item needs no additional configuration.

  • access: public
null|Varien_Object getFileDownloadParams ()
getIsNominal (line 352)

Data getter for 'is_nominal' Used for converting item to order item

  • access: public
int getIsNominal ()
getMessage (line 192)

Get messages array of quote item

  • access: public
array|string getMessage ([bool $string = true])
  • bool $string: flag for converting messages to string
getOriginalPrice (line 363)

Get original price (retrieved from product) for item.

Original price value is in quote selected currency

  • access: public
float getOriginalPrice ()
getParentItem (line 127)

Get parent item

  • access: public
Mage_Sales_Model_Quote_Item getParentItem ()
getPrice (line 412)

Get item price. Item price currency is website base currency.

  • access: public
decimal getPrice ()
getProduct (line 60)

Retrieve product model object associated with item

  • access: public
Mage_Catalog_Model_Product getProduct ()
getQty (line 256)

Get original (not related with parent item) item quantity

  • access: public
int|float getQty ()
getQuote (line 53)

Retrieve Quote instance

  • abstract:
Mage_Sales_Model_Quote getQuote ()
Redefined in descendants as:
getStore (line 205)

Retrieve store model object

  • access: public
Mage_Core_Model_Store getStore ()
getTaxAmount (line 596)

Get item tax amount

  • deprecated:
  • access: public
decimal getTaxAmount ()
getTotalQty (line 266)

Get total item quantity (include parent item relation)

  • access: public
int|float getTotalQty ()
isChildrenCalculated (line 476)

Checking if there children calculated or parent item when we have parent quote item and its children

  • access: public
bool isChildrenCalculated ()
isNominal (line 338)

Get whether the item is nominal TODO: fix for multishipping checkout

  • access: public
bool isNominal ()
isShipSeparately (line 497)

Checking can we ship product separatelly (each child separately) or each parent product item can be shipped only like one item

  • access: public
bool isShipSeparately ()
setConvertedPrice (line 449)

Set new value for converted price

  • access: public
Mage_Sales_Model_Quote_Item_Abstract setConvertedPrice (float $value)
  • float $value
setCustomPrice (line 400)

Specify custom item price (used in case whe we have apply not product price to item)

  • access: public
Mage_Sales_Model_Quote_Item_Abstract setCustomPrice (float $value)
  • float $value
setMessage (line 161)

Set messages for quote item

  • access: public
Mage_Sales_Model_Quote_Item_Abstract setMessage (mixed $messages)
  • mixed $messages
setOriginalPrice (line 379)

Set original price to item (calculation price will be refreshed too)

  • access: public
Mage_Sales_Model_Quote_Item_Abstract setOriginalPrice (float $price)
  • float $price
setParentItem (line 113)

Set parent item

  • access: public
Mage_Sales_Model_Quote_Item setParentItem (Mage_Sales_Model_Quote_Item $parentItem)
setPrice (line 423)

Specify item price (base calculation price and converted price will be refreshed too)

  • access: public
Mage_Sales_Model_Quote_Item_Abstract setPrice (float $value)
  • float $value
_beforeSave (line 97)

Specify parent item id before saving data

  • access: protected
Mage_Sales_Model_Quote_Item_Abstract _beforeSave ()
Redefinition of:
Mage_Core_Model_Abstract::_beforeSave()
Processing object before save data
Redefined in descendants as:
_calculatePrice (line 619)

Get item price (item price always exclude price)

  • deprecated:
  • access: protected
decimal _calculatePrice ( $value, [ $saveTaxes = true])
  • $value
  • $saveTaxes
__clone (line 461)

Clone quote item

  • access: public
Mage_Sales_Model_Quote_Item __clone ()
Redefined in descendants as:

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()

Documentation generated on Fri, 11 Feb 2011 16:54:57 +0200 by phpDocumentor 1.4.3