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_Stock

Stock model

Varien_Object
Extended by Mage_Core_Model_Abstract
Extended by Mage_CatalogInventory_Model_Stock
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.php
Methods summary
protected
# _construct( )
public integer
# getId( )

Retrieve stock identifier

Retrieve stock identifier

Returns

integer

Overrides

Mage_Core_Model_Abstract::getId()
public Mage_CatalogInventory_Model_Stock
# addItemsToProducts( collection $productCollection )

Add stock item objects to products

Add stock item objects to products

Parameters

$productCollection
collection
$products

Returns

Mage_CatalogInventory_Model_Stock
public unknown
# getItemCollection( )

Retrieve items collection object with stock filter

Retrieve items collection object with stock filter

Returns

unknown
protected
# _prepareProductQtys( array $items )

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

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

Parameters

$items
array
$items
public array
# registerProductsSale( array $items )

Subtract product qtys from stock. Return array of items that require full save

Subtract product qtys from stock. Return array of items that require full save

Parameters

$items
array
$items

Returns

array
public
# revertProductsSale( unknown_type $items )

Parameters

$items
unknown_type
$items
public Mage_CatalogInventory_Model_Stock
# registerItemSale( Varien_Object $item )

Subtract ordered qty for product

Subtract ordered qty for product

Parameters

$item
Varien_Object
$item

Returns

Mage_CatalogInventory_Model_Stock
public Mage_CatalogInventory_Model_Stock
# backItemQty( integer $productId, numeric $qty )

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

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

Parameters

$productId
integer
$productId
$qty
numeric
$qty

Returns

Mage_CatalogInventory_Model_Stock
public Mage_CatalogInventory_Model_Stock
# lockProductItems( array $productIds )

Lock stock items for product ids array

Lock stock items for product ids array

Parameters

$productIds
array
$productIds

Returns

Mage_CatalogInventory_Model_Stock
public Mage_CatalogInventory_Model_Stock
# addInStockFilterToCollection( Mage_Catalog_Model_Resource_Eav_Mysql4_Product_Link_Product_Collection $collection )

Adds filtering for collection to return only in stock products

Adds filtering for collection to return only in stock products

Parameters

$collection
Mage_Catalog_Model_Resource_Eav_Mysql4_Product_Link_Product_Collection
$collection

Returns

Mage_CatalogInventory_Model_Stock
$this
Methods inherited from Mage_Core_Model_Abstract
_afterDelete(), _afterDeleteCommit(), _afterLoad(), _afterSave(), _beforeDelete(), _beforeLoad(), _beforeSave(), _clearData(), _clearReferences(), _getEventData(), _getResource(), _hasModelChanged(), _init(), _protectFromNonAdmin(), _setResourceModel(), afterCommitCallback(), afterLoad(), cleanModelCache(), clearInstance(), delete(), getCacheIdTags(), getCacheTags(), getCollection(), getEntityId(), getIdFieldName(), getResource(), getResourceCollection(), getResourceName(), isObjectNew(), load(), save(), setId()
Constants summary
integer BACKORDERS_NO 0
#
integer BACKORDERS_YES_NONOTIFY 1
#
integer BACKORDERS_YES_NOTIFY 2
#
integer BACKORDERS_BELOW 1
#
integer BACKORDERS_YES 2
#
integer STOCK_OUT_OF_STOCK 0
#
integer STOCK_IN_STOCK 1
#
integer DEFAULT_STOCK_ID 1
#
Properties inherited from Mage_Core_Model_Abstract
$_cacheTag, $_dataSaveAllowed, $_eventObject, $_eventPrefix, $_isObjectNew, $_resource, $_resourceCollectionName, $_resourceName
Magento 1.7.0.2 API documentation generated by ApiGen 2.8.0