Stock Class Reference

Inheritance diagram for Stock:

Public Member Functions
	__construct (\Magento\CatalogInventory\Api\StockRegistryInterface $stockRegistry)
	afterLoad ($object)
	validate ($object)
Public Member Functions inherited from AbstractBackend
	setAttribute ($attribute)
	getAttribute ()
	getType ()
	isStatic ()
	getTable ()
	getEntityIdField ()
	setValueId ($valueId)
	setEntityValueId ($entity, $valueId)
	getValueId ()
	getEntityValueId ($entity)
	getDefaultValue ()
	validate ($object)
	afterLoad ($object)
	beforeSave ($object)
	afterSave ($object)
	beforeDelete ($object)
	afterDelete ($object)
	getAffectedFields ($object)
	isScalar ()

Protected Attributes
	$stockRegistry
Protected Attributes inherited from AbstractBackend
	$_attribute
	$_valueId
	$_valueIds = []
	$_table
	$_entityIdField
	$_defaultValue = null

Detailed Description

Quantity and Stock Status attribute processing

Deprecated:

102.0.0 as this attribute should be removed

See also

StockItemInterface when you want to change the stock data

StockStatusInterface when you want to read the stock data for representation layer (storefront)

StockItemRepositoryInterface::save as extension point for customization of saving process

Definition at line 18 of file Stock.php.

Constructor & Destructor Documentation

__construct()

__construct

(

\Magento\CatalogInventory\Api\StockRegistryInterface

$stockRegistry

)

Construct

Parameters

\Magento\CatalogInventory\Api\StockRegistryInterface

$stockRegistry

Definition at line 32 of file Stock.php.

      {
        $this->stockRegistry = $stockRegistry;
    }

Member Function Documentation

afterLoad()

afterLoad

(

$object

)

Set inventory data to custom attribute

Parameters

Product

$object

Returns

$this

Implements BackendInterface.

Definition at line 44 of file Stock.php.

    {
        $stockItem = $this->stockRegistry->getStockItem($object->getId(), $object->getStore()->getWebsiteId());
        $object->setData(
            $this->getAttribute()->getAttributeCode(),
            ['is_in_stock' => $stockItem->getIsInStock(), 'qty' => $stockItem->getQty()]
        );
        return parent::afterLoad($object);
    }

validate()

validate

(

$object

)

Validate

Parameters

Product

$object

Exceptions

Definition at line 61 of file Stock.php.

    {
        $attrCode = $this->getAttribute()->getAttributeCode();
        $value = $object->getData($attrCode);
        if (!empty($value['qty']) && !preg_match('/^-?\d*(\.|,)?\d{0,4}$/i', $value['qty'])) {
            throw new \Magento\Framework\Exception\LocalizedException(__('Please enter a valid number in this field.'));
        }
        return true;
    }

Field Documentation

$stockRegistry

$stockRegistry

protected

Definition at line 25 of file Stock.php.

---

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

• vendor/magento/module-catalog/Model/Product/Attribute/Backend/Stock.php