Mage_CatalogInventory_Model_Stock Class Reference

Inheritance diagram for Mage_CatalogInventory_Model_Stock:

List of all members.

Public Member Functions
	getId ()
	addItemsToProducts ($productCollection)
	getItemCollection ()
	registerItemSale (Varien_Object $item)
	backItemQty ($productId, $qty)
	lockProductItems ($productIds)
	addInStockFilterToCollection ($collection)
Public Attributes
const	BACKORDERS_NO = 0
const	BACKORDERS_YES_NONOTIFY = 1
const	BACKORDERS_YES_NOTIFY = 2
const	BACKORDERS_BELOW = 1
const	BACKORDERS_YES = 2
const	STOCK_OUT_OF_STOCK = 0
const	STOCK_IN_STOCK = 1
const	DEFAULT_STOCK_ID = 1
Protected Member Functions
	_construct ()

---

Detailed Description

Stock model

Author:

Magento Core Team <core@magentocommerce.com>

Definition at line 32 of file Stock.php.

---

Member Function Documentation

_construct

(

)

[protected]

Enter description here...

Reimplemented from Varien_Object.

Definition at line 47 of file Stock.php.

    {
        $this->_init('cataloginventory/stock');
    }

addInStockFilterToCollection

(

$

collection

)

Enter description here...

Parameters:

Mage_Catalog_Model_Resource_Eav_Mysql4_Product_Link_Product_Collection

$collection

Returns:

Mage_CatalogInventory_Model_Stock $this

Definition at line 162 of file Stock.php.

    {
        $this->getResource()->setInStockFilterToCollection($collection);
        return $this;
    }

addItemsToProducts

(

$

productCollection

)

Add stock item objects to products

Parameters:

collection

$products

Returns:

Mage_CatalogInventory_Model_Stock

Definition at line 68 of file Stock.php.

    {
        $items = $this->getItemCollection()
            ->addProductsFilter($productCollection)
            ->joinStockStatus($productCollection->getStoreId())
            ->load();
        foreach ($items as $item) {
            foreach($productCollection as $product){
                if($product->getId()==$item->getProductId()){
                    if($product instanceof Mage_Catalog_Model_Product) {
                        $item->assignProduct($product);
                    }
                }
            }
        }
        return $this;
    }

backItemQty	(	$	productId,
		$	qty
	)

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

Parameters:

	int	$productId
	numeric	$qty

Returns:

Mage_CatalogInventory_Model_Stock

Definition at line 130 of file Stock.php.

    {
        $stockItem = Mage::getModel('cataloginventory/stock_item')->loadByProduct($productId);
        if ($stockItem->getId() && Mage::helper('catalogInventory')->isQty($stockItem->getTypeId())) {
            $stockItem->addQty($qty);
            if ($stockItem->getCanBackInStock() && $stockItem->getQty() > $stockItem->getMinQty()) {
                $stockItem->setIsInStock(true)
                    ->setStockStatusChangedAutomaticallyFlag(true);
            }
            $stockItem->save();
        }
        return $this;
    }

getId

(

)

Retrieve stock identifier

Returns:

int

Reimplemented from Mage_Core_Model_Abstract.

Definition at line 57 of file Stock.php.

    {
        return self::DEFAULT_STOCK_ID;
    }

getItemCollection

(

)

Retrieve items collection object with stock filter

Returns:

unknown

Definition at line 91 of file Stock.php.

    {
        return Mage::getResourceModel('cataloginventory/stock_item_collection')
            ->addStockFilter($this->getId());
    }

lockProductItems

(

$

productIds

)

Lock stock items for product ids array

Parameters:

array

$productIds

Returns:

Mage_CatalogInventory_Model_Stock

Definition at line 150 of file Stock.php.

    {
        $this->_getResource()->lockProductItems($this, $productIds);
        return $this;
    }

registerItemSale

(

Varien_Object $

item

)

Subtract ordered qty for product

Parameters:

Varien_Object

$item

Returns:

Mage_CatalogInventory_Model_Stock

Definition at line 103 of file Stock.php.

    {
        if ($productId = $item->getProductId()) {
            $stockItem = Mage::getModel('cataloginventory/stock_item')->loadByProduct($productId);
            if (Mage::helper('catalogInventory')->isQty($stockItem->getTypeId())) {
                if ($item->getStoreId()) {
                    $stockItem->setStoreId($item->getStoreId());
                }
                if ($stockItem->checkQty($item->getQtyOrdered()) || Mage::app()->getStore()->isAdmin()) {
                    $stockItem->subtractQty($item->getQtyOrdered());
                    $stockItem->save();
                }
            }
        }
        else {
            Mage::throwException(Mage::helper('cataloginventory')->__('Can not specify product identifier for order item'));
        }
        return $this;
    }

---

Member Data Documentation

const BACKORDERS_BELOW = 1

Definition at line 39 of file Stock.php.

const BACKORDERS_NO = 0

Definition at line 34 of file Stock.php.

const BACKORDERS_YES = 2

Definition at line 40 of file Stock.php.

const BACKORDERS_YES_NONOTIFY = 1

Definition at line 35 of file Stock.php.

const BACKORDERS_YES_NOTIFY = 2

Definition at line 36 of file Stock.php.

const DEFAULT_STOCK_ID = 1

Definition at line 45 of file Stock.php.

const STOCK_IN_STOCK = 1

Definition at line 43 of file Stock.php.

const STOCK_OUT_OF_STOCK = 0

Definition at line 42 of file Stock.php.

---

The documentation for this class was generated from the following file:

• app/code/core/Mage/CatalogInventory/Model/Stock.php