Overview

Packages

  • currencysymbol
  • MAbout
  • Mage
    • Admin
    • Adminhtml
    • AdminNotification
    • Api
    • Api2
    • Authorizenet
    • Backup
    • Bundle
    • Captcha
    • Catalog
    • CatalogIndex
    • CatalogInventory
    • CatalogRule
    • CatalogSearch
    • Centinel
    • Checkout
    • Cms
    • Compiler
    • Connect
    • Contacts
    • Core
    • Cron
    • CurrencySymbol
    • Customer
    • Dataflow
    • Directory
    • DirtectPost
    • Downloadable
    • Eav
    • GiftMessage
    • GoogleAnalytics
    • GoogleBase
    • GoogleCheckout
    • ImportExport
    • Index
    • Install
    • Log
    • Media
    • Newsletter
    • Oauth
    • Page
    • PageCache
    • Paygate
    • Payment
    • Paypal
    • PaypalUk
    • Persistent
    • Poll
    • ProductAlert
    • Rating
    • Reports
    • Review
    • Rss
    • Rule
    • Sales
    • SalesRule
    • Sedfriend
    • Sendfriend
    • Shipping
    • Sitemap
    • Tag
    • Tax
    • Usa
    • Weee
    • Widget
    • Wishlist
    • XmlConnect
  • None
  • Phoenix
    • Moneybookers
  • PHP
  • Zend
    • Date
    • Mime
    • XmlRpc

Classes

  • Mage_CatalogInventory_Block_Adminhtml_Form_Field_Customergroup
  • Mage_CatalogInventory_Block_Adminhtml_Form_Field_Minsaleqty
  • Mage_CatalogInventory_Block_Qtyincrements
  • Mage_CatalogInventory_Block_Stockqty_Abstract
  • Mage_CatalogInventory_Block_Stockqty_Composite
  • Mage_CatalogInventory_Block_Stockqty_Default
  • Mage_CatalogInventory_Block_Stockqty_Type_Configurable
  • Mage_CatalogInventory_Block_Stockqty_Type_Grouped
  • Mage_CatalogInventory_Helper_Data
  • Mage_CatalogInventory_Helper_Minsaleqty
  • Mage_CatalogInventory_Model_Api2_Stock_Item
  • Mage_CatalogInventory_Model_Api2_Stock_Item_Rest
  • Mage_CatalogInventory_Model_Api2_Stock_Item_Rest_Admin_V1
  • Mage_CatalogInventory_Model_Api2_Stock_Item_Validator_Item
  • Mage_CatalogInventory_Model_Indexer_Stock
  • Mage_CatalogInventory_Model_Mysql4_Indexer_Stock
  • Mage_CatalogInventory_Model_Mysql4_Indexer_Stock_Configurable
  • Mage_CatalogInventory_Model_Mysql4_Indexer_Stock_Default
  • Mage_CatalogInventory_Model_Mysql4_Indexer_Stock_Grouped
  • Mage_CatalogInventory_Model_Mysql4_Stock
  • Mage_CatalogInventory_Model_Mysql4_Stock_Item
  • Mage_CatalogInventory_Model_Mysql4_Stock_Item_Collection
  • Mage_CatalogInventory_Model_Mysql4_Stock_Status
  • Mage_CatalogInventory_Model_Observer
  • Mage_CatalogInventory_Model_Resource_Indexer_Stock
  • Mage_CatalogInventory_Model_Resource_Indexer_Stock_Configurable
  • Mage_CatalogInventory_Model_Resource_Indexer_Stock_Default
  • Mage_CatalogInventory_Model_Resource_Indexer_Stock_Grouped
  • Mage_CatalogInventory_Model_Resource_Stock
  • Mage_CatalogInventory_Model_Resource_Stock_Item
  • Mage_CatalogInventory_Model_Resource_Stock_Item_Collection
  • Mage_CatalogInventory_Model_Resource_Stock_Status
  • Mage_CatalogInventory_Model_Source_Backorders
  • Mage_CatalogInventory_Model_Source_Stock
  • Mage_CatalogInventory_Model_Stock
  • Mage_CatalogInventory_Model_Stock_Item
  • Mage_CatalogInventory_Model_Stock_Item_Api
  • Mage_CatalogInventory_Model_Stock_Item_Api_V2
  • Mage_CatalogInventory_Model_Stock_Status
  • Mage_CatalogInventory_Model_System_Config_Backend_Minqty
  • Mage_CatalogInventory_Model_System_Config_Backend_Minsaleqty
  • Mage_CatalogInventory_Model_System_Config_Backend_Qtyincrements

Interfaces

  • Mage_CatalogInventory_Model_Mysql4_Indexer_Stock_Interface
  • Mage_CatalogInventory_Model_Resource_Indexer_Stock_Interface
  • Overview
  • Package
  • Class
  • Tree

Class Mage_CatalogInventory_Model_Observer

Catalog inventory module observer

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/Observer.php
Methods summary
public Mage_CatalogInventory_Model_Observer
# addInventoryData( Varien_Event_Observer $observer )

Add stock information to product

Add stock information to product

Parameters

$observer
Varien_Event_Observer
$observer

Returns

Mage_CatalogInventory_Model_Observer
public Mage_CatalogInventory_Model_Observer
# removeInventoryData( Varien_Event_Observer $observer )

Remove stock information from static variable

Remove stock information from static variable

Parameters

$observer
Varien_Event_Observer
$observer

Returns

Mage_CatalogInventory_Model_Observer
public Mage_CatalogInventory_Model_Observer
# addStockStatusToCollection( Varien_Event_Observer $observer )

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

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

Parameters

$observer
Varien_Event_Observer
$observer

Returns

Mage_CatalogInventory_Model_Observer
public Mage_CatalogInventory_Model_Observer
# addInventoryDataToCollection( Varien_Event_Observer $observer )

Add Stock items to product collection

Add Stock items to product collection

Parameters

$observer
Varien_Event_Observer
$observer

Returns

Mage_CatalogInventory_Model_Observer
public Mage_CatalogInventory_Model_Observer
# saveInventoryData( Varien_Event_Observer $observer )

Saving product inventory data. Product qty calculated dynamically.

Saving product inventory data. Product qty calculated dynamically.

Parameters

$observer
Varien_Event_Observer
$observer

Returns

Mage_CatalogInventory_Model_Observer
public Mage_CatalogInventory_Model_Observer
# copyInventoryData( Varien_Event_Observer $observer )

Copy product inventory data (used for product duplicate functionality)

Copy product inventory data (used for product duplicate functionality)

Parameters

$observer
Varien_Event_Observer
$observer

Returns

Mage_CatalogInventory_Model_Observer
protected Mage_CatalogInventory_Model_Observer
# _prepareItemForSave( Mage_CatalogInventory_Model_Stock_Item $item, Mage_Catalog_Model_Product $product )

Prepare stock item data for save

Prepare stock item data for save

Parameters

$item
Mage_CatalogInventory_Model_Stock_Item
$item
$product
Mage_Catalog_Model_Product
$product

Returns

Mage_CatalogInventory_Model_Observer
protected Mage_CatalogInventory_Model_Observer
# _removeErrorsFromQuoteAndItem( Mage_Sales_Model_Quote_Item $item, integer $code )

Removes error statuses from quote and item, set by this observer

Removes error statuses from quote and item, set by this observer

Parameters

$item
Mage_Sales_Model_Quote_Item
$item
$code
integer
$code

Returns

Mage_CatalogInventory_Model_Observer
public Mage_CatalogInventory_Model_Observer
# checkQuoteItemQty( Varien_Event_Observer $observer )

Check product inventory data when quote item quantity declaring

Check product inventory data when quote item quantity declaring

Parameters

$observer
Varien_Event_Observer
$observer

Returns

Mage_CatalogInventory_Model_Observer
protected integer
# _getQuoteItemQtyForCheck( integer $productId, integer $quoteItemId, float $itemQty )

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

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

Parameters

$productId
integer
$productId
$quoteItemId
integer
$quoteItemId
$itemQty
float
$itemQty

Returns

integer
public Mage_CatalogInventory_Model_Observer
# checkoutAllSubmitAfter( Varien_Event_Observer $observer )

Subtract qtys of quote item products after multishipping checkout

Subtract qtys of quote item products after multishipping checkout

Parameters

$observer
Varien_Event_Observer
$observer

Returns

Mage_CatalogInventory_Model_Observer
public
# subtractQuoteInventory( Varien_Event_Observer $observer )

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

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

Parameters

$observer
Varien_Event_Observer
$observer
public
# revertQuoteInventory( mixed $observer )

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

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

Parameters

$observer
mixed
$observer
protected
# _addItemToQtyArray( Mage_Sales_Model_Quote_Item $quoteItem, array & $items )

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

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

Parameters

$quoteItem
Mage_Sales_Model_Quote_Item
$quoteItem
$items
array
&$items
protected array
# _getProductsQty( array $relatedItems )

Prepare array with information about used product qty and product stock item result is: array(
$productId => array(
'qty' => $qty,
'item' => $stockItems|null
) )

Prepare array with information about used product qty and product stock item result is: array( $productId => array( 'qty' => $qty, 'item' => $stockItems|null ) )

Parameters

$relatedItems
array
$relatedItems

Returns

array
public
# reindexQuoteInventory( mixed $observer )

Refresh stock index for specific stock items after succesful order placement

Refresh stock index for specific stock items after succesful order placement

Parameters

$observer
mixed
$observer
public
# refundOrderInventory( Varien_Event_Observer $observer )

Return creditmemo items qty to stock

Return creditmemo items qty to stock

Parameters

$observer
Varien_Event_Observer
$observer
public Mage_CatalogInventory_Model_Observer
# cancelOrderItem( Varien_Event_Observer $observer )

Cancel order item

Cancel order item

Parameters

$observer
Varien_Event_Observer
$observer

Returns

Mage_CatalogInventory_Model_Observer
public Mage_CatalogInventory_Model_Observer
# updateItemsStockUponConfigChange( Varien_Event_Observer $observer )

Update items stock status and low stock date.

Update items stock status and low stock date.

Parameters

$observer
Varien_Event_Observer
$observer

Returns

Mage_CatalogInventory_Model_Observer
public Mage_CatalogInventory_Model_Observer
# productStatusUpdate( Varien_Event_Observer $observer )

Update Only product status observer

Update Only product status observer

Parameters

$observer
Varien_Event_Observer
$observer

Returns

Mage_CatalogInventory_Model_Observer
public Mage_CatalogInventory_Model_Observer
# catalogProductWebsiteUpdate( Varien_Event_Observer $observer )

Catalog Product website update

Catalog Product website update

Parameters

$observer
Varien_Event_Observer
$observer

Returns

Mage_CatalogInventory_Model_Observer
public Mage_CatalogInventory_Model_Observer
# addStockStatusToPrepareIndexSelect( Varien_Event_Observer $observer )

Add stock status to prepare index select

Add stock status to prepare index select

Parameters

$observer
Varien_Event_Observer
$observer

Returns

Mage_CatalogInventory_Model_Observer
public Mage_CatalogInventory_Model_Observer
# prepareCatalogProductIndexSelect( Varien_Event_Observer $observer )

Add stock status limitation to catalog product price index select object

Add stock status limitation to catalog product price index select object

Parameters

$observer
Varien_Event_Observer
$observer

Returns

Mage_CatalogInventory_Model_Observer
public
# reindexProductsMassAction( Varien_Event_Observer $observer )

Reindex all events of product-massAction type

Reindex all events of product-massAction type

Parameters

$observer
Varien_Event_Observer
$observer
Properties summary
protected array $_checkedQuoteItems array()
#

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

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

protected array $_itemsForReindex array()
#
protected array $_stockItemsArray array()
#

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

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

Magento 1.7.0.2 API documentation generated by ApiGen 2.8.0