Inheritance diagram for DefaultStock:

Public Member Functions
	__construct (\Magento\Framework\Model\ResourceModel\Db\Context $context, \Magento\Framework\Indexer\Table\StrategyInterface $tableStrategy, \Magento\Eav\Model\Config $eavConfig, \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, $connectionName=null)

	reindexAll ()

	reindexEntity ($entityIds)

	getActionType ()

	setActionType ($type)

	setTypeId ($typeId)

	getTypeId ()

	setIsComposite ($flag)

	getIsComposite ()

	getIdxTable ($table=null)

Public Member Functions inherited from AbstractIndexer
	__construct (\Magento\Framework\Model\ResourceModel\Db\Context $context, \Magento\Framework\Indexer\Table\StrategyInterface $tableStrategy, \Magento\Eav\Model\Config $eavConfig, $connectionName=null)

	getRelationsByChild ($childIds)

	getRelationsByParent ($parentIds)

Public Member Functions inherited from AbstractResource
	__construct (\Magento\Framework\Model\ResourceModel\Db\Context $context, \Magento\Framework\Indexer\Table\StrategyInterface $tableStrategy, $connectionName=null)

	reindexAll ()

	getIdxTable ($table=null)

	syncData ()

	insertFromTable ($sourceTable, $destTable, $readToIndex=true)

	insertFromSelect ($select, $destTable, array $columns, $readToIndex=true)

	clearTemporaryIndexTable ()

Public Member Functions inherited from AbstractDb
	__construct (\Magento\Framework\Model\ResourceModel\Db\Context $context, $connectionName=null)

	__sleep ()

	__wakeup ()

	getIdFieldName ()

	getMainTable ()

	getTable ($tableName)

	getConnection ()

	load (\Magento\Framework\Model\AbstractModel $object, $value, $field=null)

	save (\Magento\Framework\Model\AbstractModel $object)

	delete (\Magento\Framework\Model\AbstractModel $object)

	addUniqueField ($field)

	resetUniqueField ()

	unserializeFields (\Magento\Framework\Model\AbstractModel $object)

	getUniqueFields ()

	hasDataChanged ($object)

	getChecksum ($table)

	afterLoad (\Magento\Framework\DataObject $object)

	beforeSave (\Magento\Framework\DataObject $object)

	afterSave (\Magento\Framework\DataObject $object)

	beforeDelete (\Magento\Framework\DataObject $object)

	afterDelete (\Magento\Framework\DataObject $object)

	serializeFields (\Magento\Framework\Model\AbstractModel $object)

Public Member Functions inherited from AbstractResource
	__construct ()

	getConnection ()

	beginTransaction ()

	addCommitCallback ($callback)

	commit ()

	rollBack ()

	getValidationRulesBeforeSave ()

Protected Member Functions
	_construct ()

	_isManageStock ()

	_getStockStatusSelect ($entityIds=null, $usePrimaryTable=false)

	_prepareIndexTable ($entityIds=null)

	_updateIndex ($entityIds)

	_updateIndexTable ($data)

	getStatusExpression (AdapterInterface $connection, $isAggregate=false)

	getStockConfiguration ()

Protected Member Functions inherited from AbstractIndexer
	_getAttribute ($attributeCode)

	_addAttributeToSelect ($select, $attrCode, $entity, $store, $condition=null, $required=false)

	_addWebsiteJoinToSelect ($select, $store=true, $joinCondition=null)

	_addProductWebsiteJoinToSelect ($select, $website, $product)

	getMetadataPool ()

Protected Member Functions inherited from AbstractResource
	_getIndexAdapter ()

Protected Member Functions inherited from AbstractDb
	_init ($mainTable, $idFieldName)

	_setResource ($connections, $tables=null)

	_setMainTable ($mainTable, $idFieldName=null)

	_getConnection ($resourceName)

	_getLoadSelect ($field, $value, $object)

	_initUniqueFields ()

	_prepareDataForSave (\Magento\Framework\Model\AbstractModel $object)

	_prepareValueForSave ($value, $type)

	_checkUnique (\Magento\Framework\Model\AbstractModel $object)

	_afterLoad (\Magento\Framework\Model\AbstractModel $object)

	_beforeSave (\Magento\Framework\Model\AbstractModel $object)

	_afterSave (\Magento\Framework\Model\AbstractModel $object)

	_beforeDelete (\Magento\Framework\Model\AbstractModel $object)

	_afterDelete (\Magento\Framework\Model\AbstractModel $object)

	_serializeFields (\Magento\Framework\Model\AbstractModel $object)

	prepareDataForUpdate ($object)

	isObjectNotNew (\Magento\Framework\Model\AbstractModel $object)

	saveNewObject (\Magento\Framework\Model\AbstractModel $object)

	updateObject (\Magento\Framework\Model\AbstractModel $object)

	processAfterSaves (\Magento\Framework\Model\AbstractModel $object)

	isModified (\Magento\Framework\Model\AbstractModel $object)

	processNotModifiedSave (\Magento\Framework\Model\AbstractModel $object)

Protected Member Functions inherited from AbstractResource
	_construct ()

	_serializeField (DataObject $object, $field, $defaultValue=null, $unsetEmpty=false)

	_unserializeField (DataObject $object, $field, $defaultValue=null)

	_prepareDataForTable (DataObject $object, $table)

	_prepareTableValueForSave ($value, $type)

	_getColumnsForEntityLoad (\Magento\Framework\Model\AbstractModel $object, $tableName)

	getSerializer ()

Protected Attributes
	$_typeId

	$_isComposite = false

	$_scopeConfig

	$stockConfiguration

Protected Attributes inherited from AbstractIndexer
	$_eavConfig

	$metadataPool

Protected Attributes inherited from AbstractResource
	$tableStrategy

Protected Attributes inherited from AbstractDb
	$_resources

	$connectionName = \Magento\Framework\App\ResourceConnection::DEFAULT_CONNECTION

	$_connections = []

	$_resourceModel

	$_tables = []

	$_mainTable

	$_idFieldName

	$_isPkAutoIncrement = true

	$_useIsObjectNew = false

	$_mainTableFields

	$_uniqueFields = null

	$_serializableFields = []

	$transactionManager

	$objectRelationProcessor

Protected Attributes inherited from AbstractResource
	$serializer

	$_logger

Detailed Description

CatalogInventory Default Stock Status Indexer Resource Model @SuppressWarnings(PHPMD.CouplingBetweenObjects) @api

Since: 100.0.2

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 DefaultStock.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\Model\ResourceModel\Db\Context	$context,
		\Magento\Framework\Indexer\Table\StrategyInterface	$tableStrategy,
		\Magento\Eav\Model\Config	$eavConfig,
		\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig,
			$connectionName = `null`
	)

Class constructor

Parameters

\Magento\Framework\Model\ResourceModel\Db\Context	$context
\Magento\Framework\Indexer\Table\StrategyInterface	$tableStrategy
\Magento\Eav\Model\Config	$eavConfig
\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig
string	$connectionName

Definition at line 76 of file DefaultStock.php.

       {
         $this->_scopeConfig = $scopeConfig;
         parent::__construct($context, $tableStrategy, $eavConfig, $connectionName);
     }

Member Function Documentation

◆ _construct()

_construct ( )

protected

Initialize connection and define main table name

Returns: void

Definition at line 92 of file DefaultStock.php.

     {
         $this->_init('cataloginventory_stock_status', 'product_id');
     }

◆ _getStockStatusSelect()

_getStockStatusSelect	(	$entityIds = `null`,
		$usePrimaryTable = `false`
	)

protected

Get the select object for get stock status by product ids

Parameters

int \| array	$entityIds
bool	$usePrimaryTable	use primary or temporary index table

Returns: \Magento\Framework\DB\Select @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 229 of file DefaultStock.php.

     {
         $connection = $this->getConnection();
         $qtyExpr = $connection->getCheckSql('cisi.qty > 0', 'cisi.qty', 0);
         $metadata = $this->getMetadataPool()->getMetadata(\Magento\Catalog\Api\Data\ProductInterface::class);
         $linkField = $metadata->getLinkField();
 
         $select = $connection->select()->from(
             ['e' => $this->getTable('catalog_product_entity')],
             ['entity_id']
         );
         $select->join(
             ['cis' => $this->getTable('cataloginventory_stock')],
             '',
             ['website_id', 'stock_id']
         )->joinInner(
             ['cisi' => $this->getTable('cataloginventory_stock_item')],
             'cisi.stock_id = cis.stock_id AND cisi.product_id = e.entity_id',
             []
         )->joinInner(
             ['mcpei' => $this->getTable('catalog_product_entity_int')],
             'e.' . $linkField . ' = mcpei.' . $linkField
             . ' AND mcpei.attribute_id = ' . $this->_getAttribute('status')->getId()
             . ' AND mcpei.value = ' . ProductStatus::STATUS_ENABLED,
             []
         )->columns(
             ['qty' => $qtyExpr]
         )->where(
             'cis.website_id = ?',
             $this->getStockConfiguration()->getDefaultScopeId()
         )->where('e.type_id = ?', $this->getTypeId())
             ->group(['e.entity_id', 'cis.website_id', 'cis.stock_id']);
 
         $select->columns(['status' => $this->getStatusExpression($connection, true)]);
         if ($entityIds !== null) {
             $select->where('e.entity_id IN(?)', $entityIds);
         }
 
         return $select;
     }

◆ _isManageStock()

_isManageStock ( )

protected

Retrieve is Global Manage Stock enabled

Returns: bool

Definition at line 213 of file DefaultStock.php.

     {
         return $this->_scopeConfig->isSetFlag(
             \Magento\CatalogInventory\Model\Configuration::XML_PATH_MANAGE_STOCK,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE
         );
     }

◆ _prepareIndexTable()

_prepareIndexTable ( $entityIds = null )

protected

Prepare stock status data in temporary index table

Parameters

int | array $entityIds the product limitation

Returns: $this

Definition at line 276 of file DefaultStock.php.

     {
         $connection = $this->getConnection();
         $select = $this->_getStockStatusSelect($entityIds, true);
         $select = $this->getQueryProcessorComposite()->processQuery($select, $entityIds);
         $query = $select->insertFromSelect($this->getIdxTable());
         $connection->query($query);
 
         return $this;
     }

◆ _updateIndex()

_updateIndex ( $entityIds )

protected

Update Stock status index by product ids

Parameters

array | int $entityIds

Returns: $this

Definition at line 293 of file DefaultStock.php.

     {
         $connection = $this->getConnection();
         $select = $this->_getStockStatusSelect($entityIds, true);
         $select = $this->getQueryProcessorComposite()->processQuery($select, $entityIds, true);
         $query = $connection->query($select);
 
         $i = 0;
         $data = [];
         while ($row = $query->fetch(\PDO::FETCH_ASSOC)) {
             $i++;
             $data[] = [
                 'product_id' => (int)$row['entity_id'],
                 'website_id' => (int)$row['website_id'],
                 'stock_id' => Stock::DEFAULT_STOCK_ID,
                 'qty' => (double)$row['qty'],
                 'stock_status' => (int)$row['status'],
             ];
             if ($i % 1000 == 0) {
                 $this->_updateIndexTable($data);
                 $data = [];
             }
         }
 
         $this->deleteOldRecords($entityIds);
         $this->_updateIndexTable($data);
 
         return $this;
     }

◆ _updateIndexTable()

_updateIndexTable ( $data )

protected

Update stock status index table (INSERT ... ON DUPLICATE KEY UPDATE ...)

Parameters

array $data

Returns: $this

Definition at line 344 of file DefaultStock.php.

     {
         if (empty($data)) {
             return $this;
         }
 
         $connection = $this->getConnection();
         $connection->insertOnDuplicate($this->getMainTable(), $data, ['qty', 'stock_status']);
 
         return $this;
     }

◆ getActionType()

getActionType ( )

Returns action run type

Returns: string

Since: 100.2.0

Definition at line 141 of file DefaultStock.php.

     {
         return $this->actionType;
     }

◆ getIdxTable()

getIdxTable ( $table = null )

Retrieve temporary index table name

Parameters

string $table

Returns: string @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 363 of file DefaultStock.php.

     {
         return $this->tableStrategy->getTableName('cataloginventory_stock_status');
     }

◆ getIsComposite()

getIsComposite ( )

Check product type is composite

Returns: bool @SuppressWarnings(PHPMD.BooleanGetMethodName)

Definition at line 203 of file DefaultStock.php.

     {
         return $this->_isComposite;
     }

◆ getStatusExpression()

getStatusExpression	(	AdapterInterface	$connection,
			$isAggregate = `false`
	)

protected

Parameters

AdapterInterface	$connection
bool	$isAggregate

Returns: mixed

Since: 100.1.0

Definition at line 374 of file DefaultStock.php.

     {
         $isInStockExpression = $isAggregate ? 'MAX(cisi.is_in_stock)' : 'cisi.is_in_stock';
         if ($this->_isManageStock()) {
             $statusExpr = $connection->getCheckSql(
                 'cisi.use_config_manage_stock = 0 AND cisi.manage_stock = 0',
                 1,
                 $isInStockExpression
             );
         } else {
             $statusExpr = $connection->getCheckSql(
                 'cisi.use_config_manage_stock = 0 AND cisi.manage_stock = 1',
                 $isInStockExpression,
                 1
             );
         }
         return $statusExpr;
     }

◆ getStockConfiguration()

getStockConfiguration ( )

protected

Returns: StockConfigurationInterface

Deprecated:: 100.1.0

Since: 100.1.0

Definition at line 399 of file DefaultStock.php.

     {
         if ($this->stockConfiguration === null) {
             $this->stockConfiguration = \Magento\Framework\App\ObjectManager::getInstance()
                 ->get(\Magento\CatalogInventory\Api\StockConfigurationInterface::class);
         }
         return $this->stockConfiguration;
     }

◆ getTypeId()

getTypeId ( )

Retrieve active Product Type Id

Returns: string

Exceptions

Implements StockInterface.

Definition at line 177 of file DefaultStock.php.

     {
         if ($this->_typeId === null) {
             throw new \Magento\Framework\Exception\LocalizedException(__('Undefined product type'));
         }
         return $this->_typeId;
     }

◆ reindexAll()

reindexAll ( )

Reindex all stock status data for default logic product type

Returns: $this

Exceptions

Implements StockInterface.

Definition at line 103 of file DefaultStock.php.

     {
         $this->tableStrategy->setUseIdxTable(true);
         $this->beginTransaction();
         try {
             $this->_prepareIndexTable();
             $this->commit();
         } catch (\Exception $e) {
             $this->rollBack();
             throw $e;
         }
         return $this;
     }

◆ reindexEntity()

reindexEntity ( $entityIds )

Reindex stock data for defined product ids

Parameters

int | array $entityIds

Returns: $this

Implements StockInterface.

Definition at line 123 of file DefaultStock.php.

     {
         if ($this->getActionType() === Full::ACTION_TYPE) {
             $this->tableStrategy->setUseIdxTable(false);
             $this->_prepareIndexTable($entityIds);
             return $this;
         }
 
         $this->_updateIndex($entityIds);
         return $this;
     }

◆ setActionType()

setActionType ( $type )

Set action run type

Parameters

string $type

Returns: $this

Since: 100.2.0

Definition at line 153 of file DefaultStock.php.

     {
         $this->actionType = $type;
         return $this;
     }

◆ setIsComposite()

setIsComposite ( $flag )

Set Product Type Composite flag

Parameters

bool $flag

Returns: $this

Definition at line 191 of file DefaultStock.php.

     {
         $this->_isComposite = (bool) $flag;
         return $this;
     }

◆ setTypeId()

setTypeId ( $typeId )

Set active Product Type Id

Parameters

string $typeId

Returns: $this

Implements StockInterface.

Definition at line 165 of file DefaultStock.php.

     {
         $this->_typeId = $typeId;
         return $this;
     }

Field Documentation

◆ $_isComposite

$_isComposite = false

protected

Definition at line 40 of file DefaultStock.php.

◆ $_scopeConfig

$_scopeConfig

protected

Definition at line 47 of file DefaultStock.php.

◆ $_typeId

$_typeId

protected

Definition at line 33 of file DefaultStock.php.

◆ $stockConfiguration

$stockConfiguration

protected

Definition at line 58 of file DefaultStock.php.

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

vendor/magento/module-catalog-inventory/Model/ResourceModel/Indexer/Stock/DefaultStock.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _construct()

◆ _getStockStatusSelect()

◆ _isManageStock()

◆ _prepareIndexTable()

◆ _updateIndex()

◆ _updateIndexTable()

◆ getActionType()

◆ getIdxTable()

◆ getIsComposite()

◆ getStatusExpression()

◆ getStockConfiguration()

◆ getTypeId()

◆ reindexAll()

◆ reindexEntity()

◆ setActionType()

◆ setIsComposite()

◆ setTypeId()

Field Documentation

◆ $_isComposite

◆ $_scopeConfig

◆ $_typeId

◆ $stockConfiguration