Stock Class Reference

Public Member Functions
	__construct (StoreManagerInterface $storeManager, ScopeConfigInterface $scopeConfig, StatusFactory $stockStatusFactory, StockRegistryProviderInterface $stockRegistryProvider)
	assignStatusToProduct (Product $product, $status=null)
	addStockStatusToProducts (AbstractCollection $productCollection)
	addInStockFilterToCollection ($collection)
	addIsInStockFilterToCollection ($collection)

Protected Member Functions
	getStockStatusResource ()

Protected Attributes
	$storeManager
	$scopeConfig
	$stockStatusResource
	$stockStatusFactory

Detailed Description

Class Stock @SuppressWarnings(PHPMD.CouplingBetweenObjects) @api

Deprecated:

2.3.0 Replaced with Multi Source Inventory https://devdocs.magento.com/guides/v2.3/inventory/catalog-inventory-replacements.html

Definition at line 26 of file Stock.php.

Constructor & Destructor Documentation

__construct()

__construct	(	StoreManagerInterface	$storeManager,
		ScopeConfigInterface	$scopeConfig,
		StatusFactory	$stockStatusFactory,
		StockRegistryProviderInterface	$stockRegistryProvider
	)

Parameters

StoreManagerInterface	$storeManager
ScopeConfigInterface	$scopeConfig
StatusFactory	$stockStatusFactory
StockRegistryProviderInterface	$stockRegistryProvider

Definition at line 68 of file Stock.php.

      {
        $this->storeManager = $storeManager;
        $this->scopeConfig = $scopeConfig;
        $this->stockStatusFactory  = $stockStatusFactory;
        $this->stockRegistryProvider = $stockRegistryProvider;
    }

Member Function Documentation

addInStockFilterToCollection()

addInStockFilterToCollection

(

$collection

)

Adds filtering for collection to return only in stock products

Parameters

\Magento\Catalog\Model\ResourceModel\Product\Link\Product\Collection

$collection

Returns

void

Definition at line 121 of file Stock.php.

    {
        $manageStock = $this->scopeConfig->getValue(
            \Magento\CatalogInventory\Model\Configuration::XML_PATH_MANAGE_STOCK,
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
        );
        $cond = [
            '{{table}}.use_config_manage_stock = 0 AND {{table}}.manage_stock=1 AND {{table}}.is_in_stock=1',
            '{{table}}.use_config_manage_stock = 0 AND {{table}}.manage_stock=0'
        ];

        if ($manageStock) {
            $cond[] = '{{table}}.use_config_manage_stock = 1 AND {{table}}.is_in_stock=1';
        } else {
            $cond[] = '{{table}}.use_config_manage_stock = 1';
        }

        $collection->joinField(
            'inventory_in_stock',
            'cataloginventory_stock_item',
            'is_in_stock',
            'product_id=entity_id',
            '(' . join(') OR (', $cond) . ')'
        );
    }

addIsInStockFilterToCollection()

addIsInStockFilterToCollection

(

$collection

)

Add only is in stock products filter to product collection

Parameters

\Magento\Catalog\Model\ResourceModel\Product\Collection

$collection

Returns

void

Definition at line 153 of file Stock.php.

    {
        $stockFlag = 'has_stock_status_filter';
        if (!$collection->hasFlag($stockFlag)) {
            $isShowOutOfStock = $this->scopeConfig->getValue(
                \Magento\CatalogInventory\Model\Configuration::XML_PATH_SHOW_OUT_OF_STOCK,
                \Magento\Store\Model\ScopeInterface::SCOPE_STORE
            );
            $resource = $this->getStockStatusResource();
            $resource->addStockDataToCollection(
                $collection,
                !$isShowOutOfStock
            );
            $collection->setFlag($stockFlag, true);
        }
    }

addStockStatusToProducts()

addStockStatusToProducts

(

AbstractCollection

$productCollection

)

Add stock status information to products

Parameters

AbstractCollection

$productCollection

Deprecated:

100.1.0 Use Stock::addIsInStockFilterToCollection instead

Returns

void

Definition at line 104 of file Stock.php.

    {
        $scopeId = $this->getStockConfiguration()->getDefaultScopeId();
        foreach ($productCollection as $product) {
            $productId = $product->getId();
            $stockStatus = $this->stockRegistryProvider->getStockStatus($productId, $scopeId);
            $status = $stockStatus->getStockStatus();
            $product->setIsSalable($status);
        }
    }

assignStatusToProduct()

assignStatusToProduct	(	Product	$product,
			$status = null
	)

Assign stock status information to product

Parameters

Product	$product
int	$status

Returns

void

Definition at line 87 of file Stock.php.

    {
        if ($status === null) {
            $scopeId = $this->getStockConfiguration()->getDefaultScopeId();
            $stockStatus = $this->stockRegistryProvider->getStockStatus($product->getId(), $scopeId);
            $status = $stockStatus->getStockStatus();
        }
        $product->setIsSalable($status);
    }

getStockStatusResource()

getStockStatusResource ( )

protected

Returns

Status

Definition at line 173 of file Stock.php.

    {
        if (empty($this->stockStatusResource)) {
            $this->stockStatusResource = $this->stockStatusFactory->create();
        }
        return $this->stockStatusResource;
    }

Field Documentation

$scopeConfig

$scopeConfig

protected

Definition at line 40 of file Stock.php.

$stockStatusFactory

$stockStatusFactory

protected

Definition at line 50 of file Stock.php.

$stockStatusResource

$stockStatusResource

protected

Definition at line 45 of file Stock.php.

$storeManager

$storeManager

protected

Definition at line 33 of file Stock.php.

---

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

• vendor/magento/module-catalog-inventory/Helper/Stock.php