Docs For Class Mage_CatalogInventory_Model

Description

Stock model

author: Magento Core Team <[email protected]>

Located in /CatalogInventory/Model/Stock.php (line 32)

Varien_Object
   |
   --Mage_Core_Model_Abstract
      |
      --Mage_CatalogInventory_Model_Stock

Class Constant Summary

BACKORDERS_BELOW = 1

BACKORDERS_NO = 0

BACKORDERS_YES = 2

BACKORDERS_YES_NONOTIFY = 1

BACKORDERS_YES_NOTIFY = 2

DEFAULT_STOCK_ID = 1

STOCK_IN_STOCK = 1

STOCK_OUT_OF_STOCK = 0

Method Summary

Mage_CatalogInventory_Model_Stock addInStockFilterToCollection (Mage_Catalog_Model_Resource_Eav_Mysql4_Product_Link_Product_Collection $collection)

Mage_CatalogInventory_Model_Stock addItemsToProducts ( $productCollection, collection $products)

Mage_CatalogInventory_Model_Stock backItemQty (int $productId, numeric $qty)

int getId ()

unknown getItemCollection ()

Mage_CatalogInventory_Model_Stock lockProductItems (array $productIds)

Mage_CatalogInventory_Model_Stock registerItemSale ( $item)

array registerProductsSale (array $items)

void revertProductsSale (unknown_type $items)

void _construct ()

void _prepareProductQtys (array $items)

Variables

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

addInStockFilterToCollection (line 226)

Adds filtering for collection to return only in stock products

access: public

Mage_CatalogInventory_Model_Stock addInStockFilterToCollection (Mage_Catalog_Model_Resource_Eav_Mysql4_Product_Link_Product_Collection $collection)

Mage_Catalog_Model_Resource_Eav_Mysql4_Product_Link_Product_Collection $collection

addItemsToProducts (line 68)

Add stock item objects to products

access: public

Mage_CatalogInventory_Model_Stock addItemsToProducts ( $productCollection, collection $products)

collection $products
$productCollection

backItemQty (line 194)

Get back to stock (when order is canceled or whatever else)

access: public

Mage_CatalogInventory_Model_Stock backItemQty (int $productId, numeric $qty)

int $productId
numeric $qty

getId (line 57)

Retrieve stock identifier

access: public

int getId ()

Redefinition of:

Mage_Core_Model_Abstract::getId(): Retrieve model object identifier

getItemCollection (line 91)

Retrieve items collection object with stock filter

access: public

unknown getItemCollection ()

lockProductItems (line 214)

Lock stock items for product ids array

access: public

Mage_CatalogInventory_Model_Stock lockProductItems (array $productIds)

array $productIds

registerItemSale (line 166)

Subtract ordered qty for product

access: public

Mage_CatalogInventory_Model_Stock registerItemSale ( $item)

Varien_Object $item

registerProductsSale (line 126)

Subtract product qtys from stock.

Return array of items that require full save

access: public

array registerProductsSale (array $items)

array $items

revertProductsSale (line 153)

access: public

void revertProductsSale (unknown_type $items)

unknown_type $items

_construct (line 47)

access: protected

void _construct ()

_prepareProductQtys (line 102)

Prepare array($productId=>$qty) based on array($productId => array('qty'=>$qty, 'item'=>$stockItem))

access: protected

void _prepareProductQtys (array $items)

array $items

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

BACKORDERS_BELOW = 1 (line 39)

BACKORDERS_NO = 0 (line 34)

BACKORDERS_YES = 2 (line 40)

BACKORDERS_YES_NONOTIFY = 1 (line 35)

BACKORDERS_YES_NOTIFY = 2 (line 36)

DEFAULT_STOCK_ID = 1 (line 45)

STOCK_IN_STOCK = 1 (line 43)

STOCK_OUT_OF_STOCK = 0 (line 42)

Class Mage_CatalogInventory_Model_Stock

Inherited Variables

Inherited Methods