Class Mage_CatalogInventory_Model_Stock_Item

Catalog Inventory Stock Model

Varien_Object

Mage_CatalogInventory_Model_Stock_Item

Package: Mage\CatalogInventory
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/CatalogInventory/Model/Stock/Item.php

Methods summary
`protected`	# `_construct( )` Initialize resource model Initialize resource model
`protected`	# `_initOldFieldsMap( )` Init mapping array of short fields to its full names Init mapping array of short fields to its full names Resturn Varien_Object
`public integer`	# `getStockId( )` Retrieve stock identifier Retrieve stock identifier Returns `integer`
`public integer`	# `getProductId( )` Retrieve Product Id data wrapper Retrieve Product Id data wrapper Returns `integer`
`public Mage_CatalogInventory_Model_Stock_Item`	# `loadByProduct( mixed $product )` Load item data by product Load item data by product Parameters `$product` `mixed` $product Returns `Mage_CatalogInventory_Model_Stock_Item`
`public Mage_CatalogInventory_Model_Stock_Item`	# `subtractQty( decimal $qty )` Subtract quote item quantity Subtract quote item quantity Parameters `$qty` `decimal` $qty Returns `Mage_CatalogInventory_Model_Stock_Item`
`public boolean`	# `canSubtractQty( )` Check if is possible subtract value from item qty Check if is possible subtract value from item qty Returns `boolean`
`public Mage_CatalogInventory_Model_Stock_Item`	# `addQty( float $qty )` Add quantity process Add quantity process Parameters `$qty` `float` $qty Returns `Mage_CatalogInventory_Model_Stock_Item`
`public integer`	# `getStoreId( )` Retrieve Store Id (product or current) Retrieve Store Id (product or current) Returns `integer`
`public Mage_CatalogInventory_Model_Stock_Item`	# `assignProduct( Mage_Catalog_Model_Product $product )` Adding stock data to product Adding stock data to product Parameters `$product` `Mage_Catalog_Model_Product` $product Returns `Mage_CatalogInventory_Model_Stock_Item`
`public float`	# `getMinQty( )` Retrieve minimal quantity available for item status in stock Retrieve minimal quantity available for item status in stock Returns `float`
`public integer`	# `getCustomerGroupId( )` Getter for customer group id Getter for customer group id Returns `integer`
`public Mage_CatalogInventory_Model_Stock_Item`	# `setCustomerGroupId( integer $value )` Setter for customer group id Setter for customer group id Parameters `$value` `integer` Value of customer group id Returns `Mage_CatalogInventory_Model_Stock_Item`
`public float\|null`	# `getMinSaleQty( )` Retrieve Minimum Qty Allowed in Shopping Cart or NULL when there is no limitation Retrieve Minimum Qty Allowed in Shopping Cart or NULL when there is no limitation Returns `float\|null`
`public float`	# `getMaxSaleQty( )` Retrieve Maximum Qty Allowed in Shopping Cart data wrapper Retrieve Maximum Qty Allowed in Shopping Cart data wrapper Returns `float`
`public float`	# `getNotifyStockQty( )` Retrieve Notify for Quantity Below data wrapper Retrieve Notify for Quantity Below data wrapper Returns `float`
`public boolean`	# `getEnableQtyIncrements( )` Retrieve whether Quantity Increments is enabled Retrieve whether Quantity Increments is enabled Returns `boolean`
`public float\|false`	# `getQtyIncrements( )` Retrieve Quantity Increments data wrapper Retrieve Quantity Increments data wrapper Returns `float\|false`
`public integer`	# `getBackorders( )` Retrieve backorders status Retrieve backorders status Returns `integer`
`public integer`	# `getManageStock( )` Retrieve Manage Stock data wrapper Retrieve Manage Stock data wrapper Returns `integer`
`public boolean`	# `getCanBackInStock( )` Retrieve can Back in stock Retrieve can Back in stock Returns `boolean`
`public boolean`	# `checkQty( decimal $qty )` Check quantity Check quantity Parameters `$qty` `decimal` $qty Returns `boolean` Exception Mage_Core_Exception
`public integer\|float`	# `suggestQty( integer\|float $qty )` Returns suggested qty that satisfies qty increments and minQty/maxQty/minSaleQty/maxSaleQty conditions or original qty if such value does not exist Returns suggested qty that satisfies qty increments and minQty/maxQty/minSaleQty/maxSaleQty conditions or original qty if such value does not exist Parameters `$qty` `integer\|float` $qty Returns `integer\|float`
`public Varien_Object`	# `checkQuoteItemQty( mixed $qty, mixed $summaryQty, mixed $origQty = 0 )` Checking quote item quantity Checking quote item quantity Second parameter of this method specifies quantity of this product in whole shopping cart which should be checked for stock availability Parameters `$qty` `mixed` $qty quantity of this item (item qty x parent item qty) `$summaryQty` `mixed` $summaryQty quantity of this product `$origQty` `mixed` $origQty original qty of item (not multiplied on parent item qty) Returns `Varien_Object`
`public Varien_Object`	# `checkQtyIncrements( integer\|float $qty )` Check qty increments Check qty increments Parameters `$qty` `integer\|float` $qty Returns `Varien_Object`
`public Mage_CatalogInventory_Model_Stock_Item`	# `addCatalogInventoryToProductCollection( Mage_Catalog_Model_Entity_Product_Collection $productCollection )` Add join for catalog in stock field to product collection Add join for catalog in stock field to product collection Parameters `$productCollection` `Mage_Catalog_Model_Entity_Product_Collection` $productCollection Returns `Mage_CatalogInventory_Model_Stock_Item`
`protected Mage_CatalogInventory_Model_Stock_Item`	# `_addQuoteItemError( Mage_Sales_Model_Quote_Item $item, string $itemError, string $quoteError, string $errorIndex = 'error' )` Add error to Quote Item Add error to Quote Item Parameters `$item` `Mage_Sales_Model_Quote_Item` $item `$itemError` `string` $itemError `$quoteError` `string` $quoteError `$errorIndex` `string` $errorIndex Returns `Mage_CatalogInventory_Model_Stock_Item`
`protected Mage_CatalogInventory_Model_Stock_Item`	# `_beforeSave( )` Before save prepare process Before save prepare process Returns `Mage_CatalogInventory_Model_Stock_Item` Overrides `Mage_Core_Model_Abstract::_beforeSave()`
`public boolean`	# `verifyStock( float\|null $qty = null )` Chceck if item should be in stock or out of stock based on $qty param of existing item qty Chceck if item should be in stock or out of stock based on $qty param of existing item qty Parameters `$qty` `float\|null` $qty Returns `boolean` true - item in stock \| false - item out of stock
`public boolean`	# `verifyNotification( float $qty = null )` Check if item qty require stock status notification Check if item qty require stock status notification Parameters `$qty` `float` \| null $qty Returns `boolean` (true - if require, false - if not require)
`protected Mage_CatalogInventory_Model_Stock_Item`	# `_afterSave( )` Reindex CatalogInventory save event Reindex CatalogInventory save event Returns `Mage_CatalogInventory_Model_Stock_Item` Overrides `Mage_Core_Model_Abstract::_afterSave()`
`public boolean\|integer`	# `getIsInStock( )` Retrieve Stock Availability Retrieve Stock Availability Returns `boolean\|integer`
`public Mage_CatalogInventory_Model_Stock_Item`	# `setProduct( Mage_Catalog_Model_Product $product )` Add product data to stock item Add product data to stock item Parameters `$product` `Mage_Catalog_Model_Product` $product Returns `Mage_CatalogInventory_Model_Stock_Item`
`public Mage_Catalog_Model_Product\|null`	# `getProduct( )` Returns product instance Returns product instance Returns `Mage_Catalog_Model_Product\|null`
`public float`	# `getStockQty( )` Retrieve stock qty whether product is composite or no Retrieve stock qty whether product is composite or no Returns `float`
`public Mage_CatalogInventory_Model_Stock_Item`	# `reset( )` Reset model data Reset model data Returns `Mage_CatalogInventory_Model_Stock_Item`
`public Mage_CatalogInventory_Model_Stock_Item`	# `setProcessIndexEvents( boolean $process = true )` Set whether index events should be processed immediately Set whether index events should be processed immediately Parameters `$process` `boolean` $process Returns `Mage_CatalogInventory_Model_Stock_Item`

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

Constants summary
`string`	`XML_PATH_GLOBAL`	`'cataloginventory/options/'`	#
`string`	`XML_PATH_CAN_SUBTRACT`	`'cataloginventory/options/can_subtract'`	#
`string`	`XML_PATH_CAN_BACK_IN_STOCK`	`'cataloginventory/options/can_back_in_stock'`	#
`string`	`XML_PATH_ITEM`	`'cataloginventory/item_options/'`	#
`string`	`XML_PATH_MIN_QTY`	`'cataloginventory/item_options/min_qty'`	#
`string`	`XML_PATH_MIN_SALE_QTY`	`'cataloginventory/item_options/min_sale_qty'`	#
`string`	`XML_PATH_MAX_SALE_QTY`	`'cataloginventory/item_options/max_sale_qty'`	#
`string`	`XML_PATH_BACKORDERS`	`'cataloginventory/item_options/backorders'`	#
`string`	`XML_PATH_NOTIFY_STOCK_QTY`	`'cataloginventory/item_options/notify_stock_qty'`	#
`string`	`XML_PATH_MANAGE_STOCK`	`'cataloginventory/item_options/manage_stock'`	#
`string`	`XML_PATH_ENABLE_QTY_INCREMENTS`	`'cataloginventory/item_options/enable_qty_increments'`	#
`string`	`XML_PATH_QTY_INCREMENTS`	`'cataloginventory/item_options/qty_increments'`	#
`string`	`ENTITY`	`'cataloginventory_stock_item'`	#

Properties summary
`private array`	`$_minSaleQtyCache`	`array()`	#
`protected float\|false`	`$_qtyIncrements`		#
`protected string`	`$_eventPrefix`	`'cataloginventory_stock_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()->getItem() in this case
`protected Mage_Catalog_Model_Product`	`$_productInstance`	`null`	# Associated product instance Associated product instance
`protected integer\|null`	`$_customerGroupId`		# Customer group id Customer group id
`protected boolean`	`$_processIndexEvents`	`true`	# Whether index events should be processed immediately Whether index events should be processed immediately

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

Packages

Classes

Interfaces

Class Mage_CatalogInventory_Model_Stock_Item

Resturn

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Exception

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Overrides

Parameters

Returns

Parameters

Returns

Returns

Overrides

Returns

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns