Status.php 5.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216
  1. <?php
  2. /**
  3. * Copyright © Magento, Inc. All rights reserved.
  4. * See COPYING.txt for license details.
  5. */
  6. namespace Magento\CatalogInventory\Model\Stock;
  7. use Magento\CatalogInventory\Api\Data\StockItemInterface;
  8. use Magento\CatalogInventory\Api\Data\StockStatusInterface;
  9. use Magento\CatalogInventory\Api\StockRegistryInterface;
  10. use Magento\Framework\Api\AttributeValueFactory;
  11. use Magento\Framework\Api\ExtensionAttributesFactory;
  12. use Magento\Framework\Model\AbstractExtensibleModel;
  13. /**
  14. * CatalogInventory Stock Status
  15. */
  16. class Status extends AbstractExtensibleModel implements StockStatusInterface
  17. {
  18. /**#@+
  19. * Field name
  20. */
  21. const KEY_PRODUCT_ID = 'product_id';
  22. const KEY_WEBSITE_ID = 'website_id';
  23. const KEY_STOCK_ID = 'stock_id';
  24. const KEY_QTY = 'qty';
  25. const KEY_STOCK_STATUS = 'stock_status';
  26. /**#@-*/
  27. /**
  28. * @param \Magento\Framework\Model\Context $context
  29. * @param \Magento\Framework\Registry $registry
  30. * @param ExtensionAttributesFactory $extensionFactory
  31. * @param AttributeValueFactory $customAttributeFactory
  32. * @param StockRegistryInterface $stockRegistry
  33. * @param \Magento\Framework\Model\ResourceModel\AbstractResource $resource
  34. * @param \Magento\Framework\Data\Collection\AbstractDb $resourceCollection
  35. * @param array $data
  36. */
  37. public function __construct(
  38. \Magento\Framework\Model\Context $context,
  39. \Magento\Framework\Registry $registry,
  40. ExtensionAttributesFactory $extensionFactory,
  41. AttributeValueFactory $customAttributeFactory,
  42. StockRegistryInterface $stockRegistry,
  43. \Magento\Framework\Model\ResourceModel\AbstractResource $resource = null,
  44. \Magento\Framework\Data\Collection\AbstractDb $resourceCollection = null,
  45. array $data = []
  46. ) {
  47. parent::__construct(
  48. $context,
  49. $registry,
  50. $extensionFactory,
  51. $customAttributeFactory,
  52. $resource,
  53. $resourceCollection,
  54. $data
  55. );
  56. $this->stockRegistry = $stockRegistry;
  57. }
  58. /**
  59. * Init resource model
  60. *
  61. * @return void
  62. */
  63. protected function _construct()
  64. {
  65. $this->_init(\Magento\CatalogInventory\Model\ResourceModel\Stock\Status::class);
  66. }
  67. //@codeCoverageIgnoreStart
  68. /**
  69. * Retrieve product ID
  70. *
  71. * @return int
  72. */
  73. public function getProductId()
  74. {
  75. return $this->getData(self::KEY_PRODUCT_ID);
  76. }
  77. /**
  78. * Retrieve website ID
  79. *
  80. * @return int
  81. */
  82. public function getWebsiteId()
  83. {
  84. return $this->getData(self::KEY_WEBSITE_ID);
  85. }
  86. /**
  87. * Retrieve stock ID
  88. *
  89. * @return int
  90. */
  91. public function getStockId()
  92. {
  93. return $this->getData(self::KEY_STOCK_ID);
  94. }
  95. /**
  96. * Retrieve qty
  97. *
  98. * @return int
  99. */
  100. public function getQty()
  101. {
  102. return $this->getData(self::KEY_QTY);
  103. }
  104. /**
  105. * Retrieve stock status
  106. *
  107. * @return int
  108. */
  109. public function getStockStatus(): int
  110. {
  111. return (int)$this->getData(self::KEY_STOCK_STATUS);
  112. }
  113. //@codeCoverageIgnoreEnd
  114. /**
  115. * Retrieve stock item
  116. *
  117. * @return StockItemInterface
  118. */
  119. public function getStockItem()
  120. {
  121. return $this->stockRegistry->getStockItem($this->getProductId(), $this->getWebsiteId());
  122. }
  123. //@codeCoverageIgnoreStart
  124. /**
  125. * Set product ID
  126. *
  127. * @param int $productId
  128. * @return $this
  129. */
  130. public function setProductId($productId)
  131. {
  132. return $this->setData(self::KEY_PRODUCT_ID, $productId);
  133. }
  134. /**
  135. * Set web website ID
  136. *
  137. * @param int $websiteId
  138. * @return $this
  139. */
  140. public function setWebsiteId($websiteId)
  141. {
  142. return $this->setData(self::KEY_WEBSITE_ID, $websiteId);
  143. }
  144. /**
  145. * Set stock ID
  146. *
  147. * @param int $stockId
  148. * @return $this
  149. */
  150. public function setStockId($stockId)
  151. {
  152. return $this->setData(self::KEY_STOCK_ID, $stockId);
  153. }
  154. /**
  155. * Set qty
  156. *
  157. * @param int $qty
  158. * @return $this
  159. */
  160. public function setQty($qty)
  161. {
  162. return $this->setData(self::KEY_QTY, $qty);
  163. }
  164. /**
  165. * Set stock status
  166. *
  167. * @param int $stockStatus
  168. * @return $this
  169. */
  170. public function setStockStatus($stockStatus)
  171. {
  172. return $this->setData(self::KEY_STOCK_STATUS, $stockStatus);
  173. }
  174. /**
  175. * Retrieve existing extension attributes object or create a new one.
  176. *
  177. * @return \Magento\CatalogInventory\Api\Data\StockStatusExtensionInterface|null
  178. */
  179. public function getExtensionAttributes()
  180. {
  181. return $this->_getExtensionAttributes();
  182. }
  183. /**
  184. * Set an extension attributes object.
  185. *
  186. * @param \Magento\CatalogInventory\Api\Data\StockStatusExtensionInterface $extensionAttributes
  187. * @return $this
  188. */
  189. public function setExtensionAttributes(
  190. \Magento\CatalogInventory\Api\Data\StockStatusExtensionInterface $extensionAttributes
  191. ) {
  192. return $this->_setExtensionAttributes($extensionAttributes);
  193. }
  194. //@codeCoverageIgnoreEnd
  195. }