Class Mage_Sales_Model_Quote_Item

Sales Quote Item Model

Varien_Object

Mage_Sales_Model_Quote_Item_Abstract implements Mage_Catalog_Model_Product_Configuration_Item_Interface

Mage_Sales_Model_Quote_Item

Package: Mage\Sales
Category: Mage
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Author: Magento Core Team <core@magentocommerce.com>
Located at code/core/Mage/Sales/Model/Quote/Item.php

Methods summary
`protected`	# `_construct( )` Initialize resource model Initialize resource model
`protected Varien_Object`	# `_initOldFieldsMap( )` Init mapping array of short fields to its full names Init mapping array of short fields to its full names Returns `Varien_Object`
`protected Mage_Sales_Model_Quote_Item`	# `_beforeSave( )` Quote Item Before Save prepare data process Quote Item Before Save prepare data process Returns `Mage_Sales_Model_Quote_Item` Overrides `Mage_Sales_Model_Quote_Item_Abstract::_beforeSave()`
`public Mage_Sales_Model_Quote_Item`	# `setQuote( Mage_Sales_Model_Quote $quote )` Declare quote model object Declare quote model object Parameters `$quote` `Mage_Sales_Model_Quote` $quote Returns `Mage_Sales_Model_Quote_Item`
`public Mage_Sales_Model_Quote`	# `getQuote( )` Retrieve quote model object Retrieve quote model object Returns `Mage_Sales_Model_Quote`
`protected integer\|float`	# `_prepareQty( float\|integer $qty )` Prepare quantity Prepare quantity Parameters `$qty` `float\|integer` $qty Returns `integer\|float`
`public Mage_Sales_Model_Quote_Item`	# `addQty( float $qty )` Adding quantity to quote item Adding quantity to quote item Parameters `$qty` `float` $qty Returns `Mage_Sales_Model_Quote_Item`
`public Mage_Sales_Model_Quote_Item`	# `setQty( float $qty )` Declare quote item quantity Declare quote item quantity Parameters `$qty` `float` $qty Returns `Mage_Sales_Model_Quote_Item`
`public array`	# `getQtyOptions( )` Retrieve option product with Qty Retrieve option product with Qty Return array 'qty' => the qty 'product' => the product model Returns `array`
`public Mage_Sales_Model_Quote_Item`	# `setQtyOptions( mixed $qtyOptions )` Set option product with Qty Set option product with Qty Parameters `$qtyOptions` `mixed` $qtyOptions Returns `Mage_Sales_Model_Quote_Item`
`public Mage_Sales_Model_Quote_Item_Abstract`	# `checkData( )` Checking item data Checking item data Returns `Mage_Sales_Model_Quote_Item_Abstract` Overrides `Mage_Sales_Model_Quote_Item_Abstract::checkData()`
`public Mage_Sales_Model_Quote_Item`	# `setProduct( Mage_Catalog_Model_Product $product )` Setup product for quote item Setup product for quote item Parameters `$product` `Mage_Catalog_Model_Product` $product Returns `Mage_Sales_Model_Quote_Item`
`public boolean`	# `representProduct( Mage_Catalog_Model_Product $product )` Check product representation in item Check product representation in item Parameters `$product` `Mage_Catalog_Model_Product` $product Returns `boolean`
`public boolean`	# `compareOptions( array $options1, array $options2 )` Check if two options array are identical First options array is prerogative Second options array checked against first one Check if two options array are identical First options array is prerogative Second options array checked against first one Parameters `$options1` `array` $options1 `$options2` `array` $options2 Returns `boolean`
`public boolean`	# `compare( Mage_Sales_Model_Quote_Item $item )` Compare item Compare item Parameters `$item` `Mage_Sales_Model_Quote_Item` $item Returns `boolean`
`public string`	# `getProductType( )` Get item product type Get item product type Returns `string`
`public unknown`	# `getRealProductType( )` Return real product type of item Return real product type of item Returns `unknown`
`public array`	# `toArray( array $arrAttributes = array() )` Convert Quote Item to array Convert Quote Item to array Parameters `$arrAttributes` `array` $arrAttributes Returns `array`
`public Mage_Sales_Model_Quote_Item`	# `setOptions( array $options )` Initialize quote item options Initialize quote item options Parameters `$options` `array` $options Returns `Mage_Sales_Model_Quote_Item`
`public array`	# `getOptions( )` Get all item options Get all item options Returns `array`
`public array`	# `getOptionsByCode( )` Get all item options as array with codes in array key Get all item options as array with codes in array key Returns `array`
`public Mage_Sales_Model_Quote_Item`	# `addOption( Mage_Sales_Model_Quote_Item_Option\|Varien_Object $option )` Add option to item Add option to item Parameters `$option` `Mage_Sales_Model_Quote_Item_Option\|Varien_Object` $option Returns `Mage_Sales_Model_Quote_Item`
`public object`	# `updateQtyOption( Varien_Object $option, Varien_Object $value )` Can specify specific actions for ability to change given quote options values Exemple: cataloginventory decimal qty validation may change qty to int, so need to change quote item qty option value. Can specify specific actions for ability to change given quote options values Exemple: cataloginventory decimal qty validation may change qty to int, so need to change quote item qty option value. Parameters `$option` `array` $options `$value` `Varien_Object` $option Returns `object` Mage_Catalog_Model_Product_Type_Abstract
`public Mage_Sales_Model_Quote_Item`	# `removeOption( string $code )` Remove option from item options Remove option from item options Parameters `$code` `string` $code Returns `Mage_Sales_Model_Quote_Item`
`protected Mage_Sales_Model_Quote_Item`	# `_addOptionCode( Mage_Sales_Model_Quote_Item_Option $option )` Register option code Register option code Parameters `$option` `Mage_Sales_Model_Quote_Item_Option` $option Returns `Mage_Sales_Model_Quote_Item`
`public Mage_Sales_Model_Quote_Item_Option`	# `getOptionByCode( string $code )` Get item option by code Get item option by code Parameters `$code` `string` $code Returns `Mage_Sales_Model_Quote_Item_Option` \|\| null
`protected boolean`	# `_hasModelChanged( )` Checks that item model has data changes. Call save item options if model isn't need to save in DB Checks that item model has data changes. Call save item options if model isn't need to save in DB Returns `boolean` Overrides `Mage_Core_Model_Abstract::_hasModelChanged()`
`protected Mage_Sales_Model_Quote_Item`	# `_saveItemOptions( )` Save item options Save item options Returns `Mage_Sales_Model_Quote_Item`
`public Mage_Core_Model_Abstract`	# `save( )` Save model plus its options Ensures saving options in case when resource model was not changed Save model plus its options Ensures saving options in case when resource model was not changed Returns `Mage_Core_Model_Abstract` Overrides `Mage_Core_Model_Abstract::save()`
`protected Mage_Sales_Model_Quote_Item`	# `_afterSave( )` Save item options after item saved Save item options after item saved Returns `Mage_Sales_Model_Quote_Item` Overrides `Mage_Core_Model_Abstract::_afterSave()`
`public Mage_Sales_Model_Quote_Item`	# `__clone( )` Clone quote item Clone quote item Returns `Mage_Sales_Model_Quote_Item` Overrides `Mage_Sales_Model_Quote_Item_Abstract::__clone()`
`public Varien_Object`	# `getBuyRequest( )` Returns formatted buy request - object, holding request received from product view page with keys and options for configured product Returns formatted buy request - object, holding request received from product view page with keys and options for configured product Returns `Varien_Object`
`protected Mage_Sales_Model_Quote_Item`	# `_setHasError( boolean $flag )` Sets flag, whether this quote item has some error associated with it. Sets flag, whether this quote item has some error associated with it. Parameters `$flag` `boolean` $flag Returns `Mage_Sales_Model_Quote_Item`
`public Mage_Sales_Model_Quote_Item`	# `setHasError( boolean $flag )` Sets flag, whether this quote item has some error associated with it. When TRUE - also adds 'unknown' error information to list of quote item errors. When FALSE - clears whole list of quote item errors. It's recommended to use addErrorInfo() instead - to be able to remove error statuses later. Sets flag, whether this quote item has some error associated with it. When TRUE - also adds 'unknown' error information to list of quote item errors. When FALSE - clears whole list of quote item errors. It's recommended to use addErrorInfo() instead - to be able to remove error statuses later. Parameters `$flag` `boolean` $flag Returns `Mage_Sales_Model_Quote_Item` See `Mage_Sales_Model_Quote_Item::addErrorInfo()`
`protected Mage_Sales_Model_Quote_Item`	# `_clearErrorInfo( )` Clears list of errors, associated with this quote item. Also automatically removes error-flag from oneself. Clears list of errors, associated with this quote item. Also automatically removes error-flag from oneself. Returns `Mage_Sales_Model_Quote_Item`
`public Mage_Sales_Model_Quote_Item`	# `addErrorInfo( string\|null $origin = null, integer\|null $code = null, string\|null $message = null, Varien_Object\|null $additionalData = null )` Adds error information to the quote item. Automatically sets error flag. Adds error information to the quote item. Automatically sets error flag. Parameters `$origin` `string\|null` $origin Usually a name of module, that embeds error `$code` `integer\|null` $code Error code, unique for origin, that sets it `$message` `string\|null` $message Error message `$additionalData` `Varien_Object\|null` $additionalData Any additional data, that caller would like to store Returns `Mage_Sales_Model_Quote_Item`
`public array`	# `getErrorInfos( )` Retrieves all error infos, associated with this item Retrieves all error infos, associated with this item Returns `array`
`public Mage_Sales_Model_Quote_Item`	# `removeErrorInfosByParams( array $params )` Removes error infos, that have parameters equal to passed in $params. $params can have following keys (if not set - then any item is good for this key): 'origin', 'code', 'message' Removes error infos, that have parameters equal to passed in $params. $params can have following keys (if not set - then any item is good for this key): 'origin', 'code', 'message' Parameters `$params` `array` $params Returns `Mage_Sales_Model_Quote_Item`

Methods inherited from Mage_Sales_Model_Quote_Item_Abstract
addChild(), addMessage(), calcRowTotal(), clearMessage(), getBaseCalculationPrice(), getBaseCalculationPriceOriginal(), getBaseOriginalPrice(), getCalculationPrice(), getCalculationPriceOriginal(), getChildren(), getConvertedPrice(), getFileDownloadParams(), getIsNominal(), getMessage(), getOriginalPrice(), getParentItem(), getPrice(), getProduct(), getQty(), getStore(), getTotalQty(), isChildrenCalculated(), isNominal(), isShipSeparately(), removeMessageByText(), setConvertedPrice(), setCustomPrice(), setMessage(), setOriginalPrice(), setParentItem(), setPrice()

Methods inherited from Mage_Core_Model_Abstract
`_afterDelete(), _afterDeleteCommit(), _afterLoad(), _beforeDelete(), _beforeLoad(), _clearData(), _clearReferences(), _getEventData(), _getResource(), _init(), _protectFromNonAdmin(), _setResourceModel(), afterCommitCallback(), afterLoad(), cleanModelCache(), clearInstance(), delete(), getCacheIdTags(), getCacheTags(), getCollection(), getEntityId(), getId(), getIdFieldName(), getResource(), getResourceCollection(), getResourceName(), isObjectNew(), load(), setId()`

Properties summary
`protected string`	`$_eventPrefix`	`'sales_quote_item'`	# Prefix of model events names Prefix of model events names
`protected string`	`$_eventObject`	`'item'`	# Parameter name in event Parameter name in event In observe method you can use $observer->getEvent()->getObject() in this case
`protected Mage_Sales_Model_Quote`	`$_quote`		# Quote model object Quote model object
`protected array`	`$_options`	`array()`	# Item options array Item options array
`protected array`	`$_optionsByCode`	`array()`	# Item options by code cache Item options by code cache
`protected array`	`$_notRepresentOptions`	`array('info_buyRequest')`	# Not Represent options Not Represent options
`protected mixed`	`$_flagOptionsSaved`	`null`	# Flag stating that options were successfully saved Flag stating that options were successfully saved
`protected Mage_Sales_Model_Status_List`	`$_errorInfos`	`null`	# Array of errors associated with this quote item Array of errors associated with this quote item

Properties inherited from Mage_Sales_Model_Quote_Item_Abstract
`$_children, $_messages, $_parentItem`

Properties inherited from Mage_Core_Model_Abstract
`$_cacheTag, $_dataSaveAllowed, $_isObjectNew, $_resource, $_resourceCollectionName, $_resourceName`

Packages

Classes

Interfaces

Class Mage_Sales_Model_Quote_Item

Returns

Returns

Overrides

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Overrides

Returns

Returns

Overrides

Returns

Overrides

Returns

Overrides

Returns

Parameters

Returns

Parameters

Returns

See

Returns

Parameters

Returns

Returns

Parameters

Returns