Docs For Class Mage_CatalogInventory_Model

Class Mage_CatalogInventory_Model_Observer

Description

Catalog inventory module observer

author: Magento Core Team <[email protected]>

Located in /CatalogInventory/Model/Observer.php (line 34)

Variable Summary

array $_checkedProductsQty

array $_checkedQuoteItems

mixed $_itemsForReindex

array $_stockItemsArray

Method Summary

Mage_CatalogInventory_Model_Observer addInventoryData (Varien_Event_Observer $observer)

Mage_CatalogInventory_Model_Observer addInventoryDataToCollection (Varien_Event_Observer $observer)

Mage_CatalogInventory_Model_Observer addStockStatusToCollection (Varien_Event_Observer $observer)

Mage_CatalogInventory_Model_Observer addStockStatusToPrepareIndexSelect ( $observer)

Mage_CatalogInventory_Model_Observer cancelOrderItem (Varien_Event_Observer $observer)

Mage_CatalogInventory_Model_Observer catalogProductWebsiteUpdate ( $observer)

Mage_CatalogInventory_Model_Observer checkoutAllSubmitAfter ( $observer)

Mage_CatalogInventory_Model_Observer checkQuoteItemQty (Varien_Event_Observer $observer)

Mage_CatalogInventory_Model_Observer copyInventoryData (Varien_Event_Observer $observer)

Mage_CatalogInventory_Model_Observer createOrderItem (Varien_Event_Observer $observer)

Mage_CatalogInventory_Model_Observer lockOrderInventoryData (Varien_Event_Observer $observer)

Mage_CatalogInventory_Model_Observer prepareCatalogProductIndexSelect ( $observer)

Mage_CatalogInventory_Model_Observer productStatusUpdate ( $observer)

void refundOrderInventory (Varien_Event_Observer $observer)

Mage_CatalogInventory_Model_Observer refundOrderItem (Varien_Event_Observer $observer)

void reindexQuoteInventory ($observer $observer)

Mage_CatalogInventory_Model_Observer removeInventoryData (Varien_Event_Observer $observer)

void revertQuoteInventory ($observer $observer)

Mage_CatalogInventory_Model_Observer saveInventoryData (Varien_Event_Observer $observer)

void subtractQuoteInventory ( $observer)

Mage_CatalogInventory_Model_Observer updateItemsStockUponConfigChange (Varien_Event_Observer $observer)

void _addItemToQtyArray (Mage_Sales_Model_Quote_Item $quoteItem, array &$items)

void _getProductQtyForCheck (int $productId, float $itemQty)

array _getProductsQty (array $relatedItems)

int _getQuoteItemQtyForCheck (int $productId, int $quoteItemId, float $itemQty)

Mage_CatalogInventory_Model_Observer _prepareItemForSave (Mage_CatalogInventory_Model_Stock_Item $item, Mage_Catalog_Model_Product $product)

Variables

array $_checkedProductsQty = array() (line 43)

Product qty's checked data is valid if you check quote item qty and use singleton instance

deprecated: after 1.4.2.0-rc1
access: protected

array $_checkedQuoteItems = array() (line 51)

Product qty's checked data is valid if you check quote item qty and use singleton instance

access: protected

mixed $_itemsForReindex = array() (line 53)

access: protected

array $_stockItemsArray = array() (line 61)

Array, indexed by product's id to contain stockItems of already loaded products Some kind of singleton for product's stock item

access: protected

Methods

addInventoryData (line 69)

Add stock information to product

access: public

Mage_CatalogInventory_Model_Observer addInventoryData (Varien_Event_Observer $observer)

Varien_Event_Observer $observer

addInventoryDataToCollection (line 123)

Add Stock items to product collection

access: public

Mage_CatalogInventory_Model_Observer addInventoryDataToCollection (Varien_Event_Observer $observer)

Varien_Event_Observer $observer

addStockStatusToCollection (line 106)

Add information about producs stock status to collection Used in for product collection after load

access: public

Mage_CatalogInventory_Model_Observer addStockStatusToCollection (Varien_Event_Observer $observer)

Varien_Event_Observer $observer

addStockStatusToPrepareIndexSelect (line 719)

Add stock status to prepare index select

access: public

Mage_CatalogInventory_Model_Observer addStockStatusToPrepareIndexSelect ( $observer)

Varien_Event_Observer $observer

cancelOrderItem (line 650)

Cancel order item

access: public

Mage_CatalogInventory_Model_Observer cancelOrderItem (Varien_Event_Observer $observer)

Varien_Event_Observer $observer

catalogProductWebsiteUpdate (line 698)

Catalog Product website update

access: public

Mage_CatalogInventory_Model_Observer catalogProductWebsiteUpdate ( $observer)

Varien_Event_Observer $observer

checkoutAllSubmitAfter (line 462)

Subtract qtys of quote item products after multishipping checkout

access: public

Mage_CatalogInventory_Model_Observer checkoutAllSubmitAfter ( $observer)

Varien_Event_Observer $observer

checkQuoteItemQty (line 246)

Check product inventory data when quote item quantity declaring

access: public

Mage_CatalogInventory_Model_Observer checkQuoteItemQty (Varien_Event_Observer $observer)

Varien_Event_Observer $observer

copyInventoryData (line 163)

Copy product inventory data (used for product duplicate functionality)

access: public

Mage_CatalogInventory_Model_Observer copyInventoryData (Varien_Event_Observer $observer)

Varien_Event_Observer $observer

createOrderItem (line 789)

deprecated: after 1.4
access: public

Mage_CatalogInventory_Model_Observer createOrderItem (Varien_Event_Observer $observer)

Varien_Event_Observer $observer

lockOrderInventoryData (line 757)

Lock DB rows for order products

We need do it for resolving problems with inventory on placing some orders in one time

deprecated: after 1.4
access: public

Mage_CatalogInventory_Model_Observer lockOrderInventoryData (Varien_Event_Observer $observer)

Varien_Event_Observer $observer

prepareCatalogProductIndexSelect (line 736)

Add stock status limitation to catalog product price index select object

access: public

Mage_CatalogInventory_Model_Observer prepareCatalogProductIndexSelect ( $observer)

Varien_Event_Observer $observer

productStatusUpdate (line 684)

Update Only product status observer

access: public

Mage_CatalogInventory_Model_Observer productStatusUpdate ( $observer)

Varien_Event_Observer $observer

refundOrderInventory (line 617)

Return creditmemo items qty to stock

access: public

void refundOrderInventory (Varien_Event_Observer $observer)

Varien_Event_Observer $observer

refundOrderItem (line 812)

Back refunded item qty to stock

deprecated: after 1.4
access: public

Mage_CatalogInventory_Model_Observer refundOrderItem (Varien_Event_Observer $observer)

Varien_Event_Observer $observer

reindexQuoteInventory (line 583)

Refresh stock index for specific stock items after succesful order placement

access: public

void reindexQuoteInventory ($observer $observer)

$observer $observer

removeInventoryData (line 88)

Remove stock information from static variable

access: public

Mage_CatalogInventory_Model_Observer removeInventoryData (Varien_Event_Observer $observer)

Varien_Event_Observer $observer

revertQuoteInventory (line 504)

Revert quote items inventory data (cover not success order place case)

access: public

void revertQuoteInventory ($observer $observer)

$observer $observer

saveInventoryData (line 136)

Saving product inventory data. Product qty calculated dynamically.

access: public

Mage_CatalogInventory_Model_Observer saveInventoryData (Varien_Event_Observer $observer)

Varien_Event_Observer $observer

subtractQuoteInventory (line 480)

Subtract quote items qtys from stock items related with quote items products.

Used before order placing to make order save/place transaction smaller Also called after every successful order placement to ensure subtraction of inventory

access: public

void subtractQuoteInventory ( $observer)

Varien_Event_Observer $observer

updateItemsStockUponConfigChange (line 670)

Update items stock status and low stock date.

access: public

Mage_CatalogInventory_Model_Observer updateItemsStockUponConfigChange (Varien_Event_Observer $observer)

Varien_Event_Observer $observer

_addItemToQtyArray (line 527)

Adds stock item qty to $items (creates new entry or increments existing one)

$items is array with following structure: array( $productId => array( 'qty' => $qty, 'item' => $stockItems|null ) )

access: protected

void _addItemToQtyArray (Mage_Sales_Model_Quote_Item $quoteItem, array &$items)

Mage_Sales_Model_Quote_Item $quoteItem
array &$items

_getProductQtyForCheck (line 423)

Get product qty includes information from all quote items Need be used only in sungleton mode

deprecated: after 1.4.2.0-rc1
access: protected

void _getProductQtyForCheck (int $productId, float $itemQty)

int $productId
float $itemQty

_getProductsQty (line 558)

Prepare array with iformation about used product qty and product stock item

result is: array( $productId => array( 'qty' => $qty, 'item' => $stockItems|null ) )

access: protected

array _getProductsQty (array $relatedItems)

array $relatedItems

_getQuoteItemQtyForCheck (line 442)

Get product qty includes information from all quote items Need be used only in sungleton mode

access: protected

int _getQuoteItemQtyForCheck (int $productId, int $quoteItemId, float $itemQty)

int $productId
int $quoteItemId
float $itemQty

_prepareItemForSave (line 198)

Prepare stock item data for save

access: protected

Mage_CatalogInventory_Model_Observer _prepareItemForSave (Mage_CatalogInventory_Model_Stock_Item $item, Mage_Catalog_Model_Product $product)

Mage_CatalogInventory_Model_Stock_Item $item
Mage_Catalog_Model_Product $product

Documentation generated on Fri, 11 Feb 2011 17:09:02 +0200 by phpDocumentor 1.4.3