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_Status

CatalogInventory Stock Status per website Model

Varien_Object
Extended by Mage_Core_Model_Abstract
Extended by Mage_CatalogInventory_Model_Stock_Status
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/Status.php
Methods summary
protected
# _construct( )

Init resource model

Init resource model

public array
# getProductTypeInstances( )

Retrieve Product Type Instances as key - type code, value - instance model

Retrieve Product Type Instances as key - type code, value - instance model

Returns

array
public Mage_Catalog_Model_Product_Type_Abstract
# getProductTypeInstance( string $productType )

Retrieve Product Type Instance By Product Type

Retrieve Product Type Instance By Product Type

Parameters

$productType
string
$productType

Returns

Mage_Catalog_Model_Product_Type_Abstract
public array
# getWebsites( mixed $websiteId = null )

Retrieve website models

Retrieve website models

Returns

array
public integer
# getWebsiteDefaultStoreId( integer $websiteId )

Retrieve Default website store Id

Retrieve Default website store Id

Parameters

$websiteId
integer
$websiteId

Returns

integer
public Mage_Catalog_Model_Product_Status
# getProductStatusModel( )

Retrieve Catalog Product Status Model

Retrieve Catalog Product Status Model

Returns

Mage_Catalog_Model_Product_Status
public Mage_CatalogInventory_Model_Stock_Item
# getStockItemModel( )

Retrieve CatalogInventory empty Stock Item model

Retrieve CatalogInventory empty Stock Item model

Returns

Mage_CatalogInventory_Model_Stock_Item
public integer
# getProductStatusEnabled( )

Retrieve Product Status Enabled Constant

Retrieve Product Status Enabled Constant

Returns

integer
public Mage_CatalogInventory_Model_Stock_Status
# changeItemStatus( Mage_CatalogInventory_Model_Stock_Item $item )

Change Stock Item status process

Change Stock Item status process

Parameters

$item
Mage_CatalogInventory_Model_Stock_Item
$item

Returns

Mage_CatalogInventory_Model_Stock_Status
public Mage_CatalogInventory_Model_Stock_Status
# assignProduct( Mage_Catalog_Model_Product $product, integer $stockId = 1, integer $stockStatus = null )

Assign Stock Status to Product

Assign Stock Status to Product

Parameters

$product
Mage_Catalog_Model_Product
$product
$stockId
integer
$stockId
$stockStatus
integer
$stockStatus

Returns

Mage_CatalogInventory_Model_Stock_Status
public Mage_CatalogInventory_Model_Stock_Status
# rebuild( integer $websiteId = null )

Rebuild stock status for all products

Rebuild stock status for all products

Parameters

$websiteId
integer
$websiteId

Returns

Mage_CatalogInventory_Model_Stock_Status
public Mage_CatalogInventory_Model_Stock_Status
# updateStatus( integer $productId, string $productType = null, integer $websiteId = null )

Update product status from stock item

Update product status from stock item

Parameters

$productId
integer
$productId
$productType
string
$productType
$websiteId
integer
$websiteId

Returns

Mage_CatalogInventory_Model_Stock_Status
protected Mage_CatalogInventory_Model_Stock_Status
# _processChildren( integer $productId, string $productType, float $qty = 0, integer $status = Mage_CatalogInventory_Model_Stock_Status::STATUS_IN_STOCK, integer $stockId = 1, integer $websiteId = null )

Process children stock status

Process children stock status

Parameters

$productId
integer
$productId
$productType
string
$productType
$qty
float
$qty
$status
integer
$status
$stockId
integer
$stockId
$websiteId
integer
$websiteId

Returns

Mage_CatalogInventory_Model_Stock_Status
protected Mage_CatalogInventory_Model_Stock_Status
# _processParents( integer $productId, integer $stockId = 1, integer $websiteId = null )

Process Parents by child

Process Parents by child

Parameters

$productId
integer
$productId
$stockId
integer
$stockId
$websiteId
integer
$websiteId

Returns

Mage_CatalogInventory_Model_Stock_Status
public Mage_CatalogInventory_Model_Stock_Status
# saveProductStatus( integer $productId, integer $status, float $qty = 0, integer $stockId = 1, integer|null $websiteId = null )

Save product status per website if website is null, saved for all websites

Save product status per website if website is null, saved for all websites

Parameters

$productId
integer
$productId
$status
integer
$status
$qty
float
$qty
$stockId
integer
$stockId
$websiteId
integer|null
$websiteId

Returns

Mage_CatalogInventory_Model_Stock_Status
public array
# getProductStatus( integer|array $productIds, integer $websiteId, integer $stockId = 1 )

Retrieve Product(s) status

Retrieve Product(s) status

Parameters

$productIds
integer|array
$productIds
$websiteId
integer
$websiteId
$stockId
integer
$stockId

Returns

array
public array
# getProductData( integer|array $productIds, integer $websiteId, integer $stockId = 1 )

Retrieve Product(s) Data array

Retrieve Product(s) Data array

Parameters

$productIds
integer|array
$productIds
$websiteId
integer
$websiteId
$stockId
integer
$stockId

Returns

array
public string|false
# getProductType( integer $productId )

Retrieve Product Type

Retrieve Product Type

Parameters

$productId
integer
$productId

Returns

string|false
public array
# getProductsType( array|integer $productIds )

Retrieve Products Type as array Return array as key product_id, value type

Retrieve Products Type as array Return array as key product_id, value type

Parameters

$productIds
array|integer
$productIds

Returns

array
public Mage_CatalogInventory_Model_Stock_Status
# addStockStatusToProducts( Mage_Catalog_Model_Resource_Eav_Mysql4_Product_Collection $productCollection, integer|null $websiteId = null, integer|null $stockId = null )

Add information about stock status to product collection

Add information about stock status to product collection

Parameters

$productCollection
Mage_Catalog_Model_Resource_Eav_Mysql4_Product_Collection
$productCollection
$websiteId
integer|null
$websiteId
$stockId
integer|null
$stockId

Returns

Mage_CatalogInventory_Model_Stock_Status
public Mage_CatalogInventory_Model_Stock_Status
# addStockStatusToSelect( Varien_Db_Select $select, Mage_Core_Model_Website $website )

Add stock status to prepare index select

Add stock status to prepare index select

Parameters

$select
Varien_Db_Select
$select
$website
Mage_Core_Model_Website
$website

Returns

Mage_CatalogInventory_Model_Stock_Status
public Mage_CatalogInventory_Model_Stock_Status
# prepareCatalogProductIndexSelect( Varien_Db_Select $select, string|Zend_Db_Expr $entityField, string|Zend_Db_Expr $websiteField )

Add stock status limitation to catalog product price index select object

Add stock status limitation to catalog product price index select object

Parameters

$select
Varien_Db_Select
$select
$entityField
string|Zend_Db_Expr
$entityField
$websiteField
string|Zend_Db_Expr
$websiteField

Returns

Mage_CatalogInventory_Model_Stock_Status
public Mage_CatalogInventory_Model_Stock_Status
# addIsInStockFilterToCollection( Mage_Catalog_Model_Resource_Eav_Mysql4_Product_Collection $collection )

Add only is in stock products filter to product collection

Add only is in stock products filter to product collection

Parameters

$collection
Mage_Catalog_Model_Resource_Eav_Mysql4_Product_Collection
$collection

Returns

Mage_CatalogInventory_Model_Stock_Status
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(), getId(), getIdFieldName(), getResource(), getResourceCollection(), getResourceName(), isObjectNew(), load(), save(), setId()
Constants summary
integer STATUS_OUT_OF_STOCK 0
#
integer STATUS_IN_STOCK 1
#
Properties summary
protected array $_productTypes
#

Product Type Instances cache

Product Type Instances cache

protected array $_websites
#

Websites cache

Websites cache

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