QuantityValidator Class Reference

Public Member Functions
	__construct (Option $optionInitializer, StockItem $stockItemInitializer, StockRegistryInterface $stockRegistry, StockStateInterface $stockState)
	validate (Observer $observer)

Protected Member Functions
	_removeErrorsFromQuoteAndItem ($item, $code)

Protected Attributes
	$optionInitializer
	$stockItemInitializer
	$stockRegistry
	$stockState

Detailed Description

Quote item quantity validator.

@api

Since

100.0.2 @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Deprecated:

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

Definition at line 33 of file QuantityValidator.php.

Constructor & Destructor Documentation

__construct()

__construct	(	Option	$optionInitializer,
		StockItem	$stockItemInitializer,
		StockRegistryInterface	$stockRegistry,
		StockStateInterface	$stockState
	)

Parameters

Option	$optionInitializer
StockItem	$stockItemInitializer
StockRegistryInterface	$stockRegistry
StockStateInterface	$stockState

Returns

void

Definition at line 62 of file QuantityValidator.php.

      {
        $this->optionInitializer = $optionInitializer;
        $this->stockItemInitializer = $stockItemInitializer;
        $this->stockRegistry = $stockRegistry;
        $this->stockState = $stockState;
    }

Member Function Documentation

_removeErrorsFromQuoteAndItem()

_removeErrorsFromQuoteAndItem (   $item,   $code  )

protected

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

Parameters

Item	$item
int	$code

Returns

void

Definition at line 258 of file QuantityValidator.php.

    {
        if ($item->getHasError()) {
            $params = ['origin' => 'cataloginventory', 'code' => $code];
            $item->removeErrorInfosByParams($params);
        }

        $quote = $item->getQuote();
        if ($quote->getHasError()) {
            $quoteItems = $quote->getItemsCollection();
            $canRemoveErrorFromQuote = true;
            foreach ($quoteItems as $quoteItem) {
                if ($quoteItem->getItemId() == $item->getItemId()) {
                    continue;
                }

                $errorInfos = $quoteItem->getErrorInfos();
                foreach ($errorInfos as $errorInfo) {
                    if ($errorInfo['code'] == $code) {
                        $canRemoveErrorFromQuote = false;
                        break;
                    }
                }

                if (!$canRemoveErrorFromQuote) {
                    break;
                }
            }

            if ($canRemoveErrorFromQuote) {
                $params = ['origin' => 'cataloginventory', 'code' => $code];
                $quote->removeErrorInfosByParams(null, $params);
            }
        }
    }

validate()

validate

(

Observer

$observer

)

Check product inventory data when quote item quantity declaring

Parameters

\Magento\Framework\Event\Observer

$observer

Returns

void

Exceptions

Check if product in stock. For composite products check base (parent) item stock status

Check item for options

Definition at line 108 of file QuantityValidator.php.

    {
        /* @var $quoteItem Item */
        $quoteItem = $observer->getEvent()->getItem();
        if (!$quoteItem ||
            !$quoteItem->getProductId() ||
            !$quoteItem->getQuote()
        ) {
            return;
        }
        $product = $quoteItem->getProduct();
        $qty = $quoteItem->getQty();

        /* @var \Magento\CatalogInventory\Model\Stock\Item $stockItem */
        $stockItem = $this->stockRegistry->getStockItem($product->getId(), $product->getStore()->getWebsiteId());
        if (!$stockItem instanceof StockItemInterface) {
            throw new LocalizedException(__('The Product stock item is invalid. Verify the stock item and try again.'));
        }

        if (($options = $quoteItem->getQtyOptions()) && $qty > 0) {
            foreach ($options as $option) {
                $this->optionInitializer->initialize($option, $quoteItem, $qty);
            }
        } else {
            $this->stockItemInitializer->initialize($stockItem, $quoteItem, $qty);
        }

        if ($quoteItem->getQuote()->getIsSuperMode()) {
            return;
        }

        /* @var \Magento\CatalogInventory\Api\Data\StockStatusInterface $stockStatus */
        $stockStatus = $this->stockRegistry->getStockStatus($product->getId(), $product->getStore()->getWebsiteId());

        /* @var \Magento\CatalogInventory\Api\Data\StockStatusInterface $parentStockStatus */
        $parentStockStatus = false;

        if ($quoteItem->getParentItem()) {
            $product = $quoteItem->getParentItem()->getProduct();
            $parentStockStatus = $this->stockRegistry->getStockStatus(
                $product->getId(),
                $product->getStore()->getWebsiteId()
            );
        }

        if ($stockStatus) {
            if ($stockStatus->getStockStatus() === Stock::STOCK_OUT_OF_STOCK
                    || $parentStockStatus && $parentStockStatus->getStockStatus() == Stock::STOCK_OUT_OF_STOCK
            ) {
                $quoteItem->addErrorInfo(
                    'cataloginventory',
                    Data::ERROR_QTY,
                    __('This product is out of stock.')
                );
                $quoteItem->getQuote()->addErrorInfo(
                    'stock',
                    'cataloginventory',
                    Data::ERROR_QTY,
                    __('Some of the products are out of stock.')
                );
                return;
            } else {
                // Delete error from item and its quote, if it was set due to item out of stock
                $this->_removeErrorsFromQuoteAndItem($quoteItem, Data::ERROR_QTY);
            }
        }

        if ($options) {
            $qty = $product->getTypeInstance()->prepareQuoteItemQty($qty, $product);
            $quoteItem->setData('qty', $qty);
            if ($stockStatus) {
                $this->checkOptionsQtyIncrements($quoteItem, $options);
            }

            // variable to keep track if we have previously encountered an error in one of the options
            $removeError = true;
            foreach ($options as $option) {
                $result = $option->getStockStateResult();
                if ($result->getHasError()) {
                    $option->setHasError(true);
                    //Setting this to false, so no error statuses are cleared
                    $removeError = false;
                    $this->addErrorInfoToQuote($result, $quoteItem, $removeError);
                }
            }
            if ($removeError) {
                $this->_removeErrorsFromQuoteAndItem($quoteItem, Data::ERROR_QTY);
            }
        } else {
            if ($quoteItem->getParentItem() === null) {
                $result = $quoteItem->getStockStateResult();
                if ($result->getHasError()) {
                    $this->addErrorInfoToQuote($result, $quoteItem);
                } else {
                    $this->_removeErrorsFromQuoteAndItem($quoteItem, Data::ERROR_QTY);
                }
            }
        }
    }

Field Documentation

$optionInitializer

$optionInitializer

protected

Definition at line 38 of file QuantityValidator.php.

$stockItemInitializer

$stockItemInitializer

protected

Definition at line 43 of file QuantityValidator.php.

$stockRegistry

$stockRegistry

protected

Definition at line 48 of file QuantityValidator.php.

$stockState

$stockState

protected

Definition at line 53 of file QuantityValidator.php.

---

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

• vendor/magento/module-catalog-inventory/Model/Quote/Item/QuantityValidator.php