StockRegistry.php 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203
  1. <?php
  2. /**
  3. * Copyright © Magento, Inc. All rights reserved.
  4. * See COPYING.txt for license details.
  5. */
  6. namespace Magento\CatalogInventory\Model;
  7. use Magento\Catalog\Model\ProductFactory;
  8. use Magento\CatalogInventory\Api\Data\StockItemInterface;
  9. use Magento\CatalogInventory\Api\StockConfigurationInterface;
  10. use Magento\CatalogInventory\Api\StockItemCriteriaInterfaceFactory;
  11. use Magento\CatalogInventory\Api\StockItemRepositoryInterface;
  12. use Magento\CatalogInventory\Api\StockRegistryInterface;
  13. use Magento\CatalogInventory\Model\Spi\StockRegistryProviderInterface;
  14. /**
  15. * Class StockRegistry
  16. *
  17. * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  18. */
  19. class StockRegistry implements StockRegistryInterface
  20. {
  21. /**
  22. * @var StockConfigurationInterface
  23. */
  24. protected $stockConfiguration;
  25. /**
  26. * @var StockRegistryProviderInterface
  27. */
  28. protected $stockRegistryProvider;
  29. /**
  30. * @var ProductFactory
  31. */
  32. protected $productFactory;
  33. /**
  34. * @var StockItemRepositoryInterface
  35. */
  36. protected $stockItemRepository;
  37. /**
  38. * @var \Magento\CatalogInventory\Api\StockItemCriteriaInterfaceFactory
  39. */
  40. protected $criteriaFactory;
  41. /**
  42. * @param StockConfigurationInterface $stockConfiguration
  43. * @param StockRegistryProviderInterface $stockRegistryProvider
  44. * @param StockItemRepositoryInterface $stockItemRepository
  45. * @param StockItemCriteriaInterfaceFactory $criteriaFactory
  46. * @param ProductFactory $productFactory
  47. */
  48. public function __construct(
  49. StockConfigurationInterface $stockConfiguration,
  50. StockRegistryProviderInterface $stockRegistryProvider,
  51. StockItemRepositoryInterface $stockItemRepository,
  52. StockItemCriteriaInterfaceFactory $criteriaFactory,
  53. ProductFactory $productFactory
  54. ) {
  55. $this->stockConfiguration = $stockConfiguration;
  56. $this->stockRegistryProvider = $stockRegistryProvider;
  57. $this->stockItemRepository = $stockItemRepository;
  58. $this->criteriaFactory = $criteriaFactory;
  59. $this->productFactory = $productFactory;
  60. }
  61. /**
  62. * @param int $scopeId
  63. * @return \Magento\CatalogInventory\Api\Data\StockInterface
  64. */
  65. public function getStock($scopeId = null)
  66. {
  67. $scopeId = $this->stockConfiguration->getDefaultScopeId();
  68. return $this->stockRegistryProvider->getStock($scopeId);
  69. }
  70. /**
  71. * @param int $productId
  72. * @param int $scopeId
  73. * @return \Magento\CatalogInventory\Api\Data\StockItemInterface
  74. */
  75. public function getStockItem($productId, $scopeId = null)
  76. {
  77. $scopeId = $this->stockConfiguration->getDefaultScopeId();
  78. return $this->stockRegistryProvider->getStockItem($productId, $scopeId);
  79. }
  80. /**
  81. * @param string $productSku
  82. * @param int $scopeId
  83. * @return \Magento\CatalogInventory\Api\Data\StockItemInterface
  84. * @throws \Magento\Framework\Exception\NoSuchEntityException
  85. */
  86. public function getStockItemBySku($productSku, $scopeId = null)
  87. {
  88. $scopeId = $this->stockConfiguration->getDefaultScopeId();
  89. $productId = $this->resolveProductId($productSku);
  90. return $this->stockRegistryProvider->getStockItem($productId, $scopeId);
  91. }
  92. /**
  93. * @param int $productId
  94. * @param int $scopeId
  95. * @return \Magento\CatalogInventory\Api\Data\StockStatusInterface
  96. */
  97. public function getStockStatus($productId, $scopeId = null)
  98. {
  99. $scopeId = $this->stockConfiguration->getDefaultScopeId();
  100. return $this->stockRegistryProvider->getStockStatus($productId, $scopeId);
  101. }
  102. /**
  103. * @param string $productSku
  104. * @param int $scopeId
  105. * @return \Magento\CatalogInventory\Api\Data\StockStatusInterface
  106. * @throws \Magento\Framework\Exception\NoSuchEntityException
  107. */
  108. public function getStockStatusBySku($productSku, $scopeId = null)
  109. {
  110. $scopeId = $this->stockConfiguration->getDefaultScopeId();
  111. $productId = $this->resolveProductId($productSku);
  112. return $this->getStockStatus($productId, $scopeId);
  113. }
  114. /**
  115. * Retrieve Product stock status
  116. * @param int $productId
  117. * @param int $scopeId
  118. * @return int
  119. */
  120. public function getProductStockStatus($productId, $scopeId = null)
  121. {
  122. $scopeId = $this->stockConfiguration->getDefaultScopeId();
  123. $stockStatus = $this->getStockStatus($productId, $scopeId);
  124. return $stockStatus->getStockStatus();
  125. }
  126. /**
  127. * @param string $productSku
  128. * @param null $scopeId
  129. * @return int
  130. * @throws \Magento\Framework\Exception\NoSuchEntityException
  131. */
  132. public function getProductStockStatusBySku($productSku, $scopeId = null)
  133. {
  134. $scopeId = $this->stockConfiguration->getDefaultScopeId();
  135. $productId = $this->resolveProductId($productSku);
  136. return $this->getProductStockStatus($productId, $scopeId);
  137. }
  138. /**
  139. * @inheritdoc
  140. */
  141. public function getLowStockItems($scopeId, $qty, $currentPage = 1, $pageSize = 0)
  142. {
  143. $criteria = $this->criteriaFactory->create();
  144. $criteria->setLimit($currentPage, $pageSize);
  145. $criteria->setScopeFilter($scopeId);
  146. $criteria->setQtyFilter('<=', $qty);
  147. $criteria->addField('qty');
  148. return $this->stockItemRepository->getList($criteria);
  149. }
  150. /**
  151. * @inheritdoc
  152. */
  153. public function updateStockItemBySku($productSku, \Magento\CatalogInventory\Api\Data\StockItemInterface $stockItem)
  154. {
  155. $productId = $this->resolveProductId($productSku);
  156. $websiteId = $stockItem->getWebsiteId() ?: null;
  157. $origStockItem = $this->getStockItem($productId, $websiteId);
  158. $data = $stockItem->getData();
  159. if ($origStockItem->getItemId()) {
  160. unset($data['item_id']);
  161. }
  162. $origStockItem->addData($data);
  163. $origStockItem->setProductId($productId);
  164. return $this->stockItemRepository->save($origStockItem)->getItemId();
  165. }
  166. /**
  167. * @param string $productSku
  168. * @return int
  169. * @throws \Magento\Framework\Exception\NoSuchEntityException
  170. */
  171. protected function resolveProductId($productSku)
  172. {
  173. $product = $this->productFactory->create();
  174. $productId = $product->getIdBySku($productSku);
  175. if (!$productId) {
  176. throw new \Magento\Framework\Exception\NoSuchEntityException(
  177. __(
  178. 'The Product with the "%1" SKU doesn\'t exist.',
  179. $productSku
  180. )
  181. );
  182. }
  183. return $productId;
  184. }
  185. }