MAGETWO-33661: Refactor CatalogInventory module to use mutable data object interfaces

Author: Yu Tang

app/code/Magento/Catalog/Controller/Adminhtml/Product/Action/Attribute/Save.php

@@ -32,9 +32,9 @@ class Save extends \Magento\Catalog\Controller\Adminhtml\Product\Action\Attribut
     protected $_catalogProduct;
 
     /**
-     * @var \Magento\CatalogInventory\Api\Data\StockItemDataBuilder
+     * @var \Magento\CatalogInventory\Api\Data\StockItemInterfaceFactory
      */
-    protected $stockItemBuilder;
+    protected $stockItemFactory;
 
     /**
      * Stock Indexer
@@ -48,15 +48,21 @@ class Save extends \Magento\Catalog\Controller\Adminhtml\Product\Action\Attribut
      */
     protected $resultRedirectFactory;
 
+    /**
+     * @var \Magento\Framework\Api\DataObjectHelper
+     */
+    protected $dataObjectHelper;
+
     /**
      * @param Action\Context $context
      * @param \Magento\Catalog\Helper\Product\Edit\Action\Attribute $attributeHelper
      * @param \Magento\Catalog\Model\Indexer\Product\Flat\Processor $productFlatIndexerProcessor
      * @param \Magento\Catalog\Model\Indexer\Product\Price\Processor $productPriceIndexerProcessor
      * @param \Magento\CatalogInventory\Model\Indexer\Stock\Processor $stockIndexerProcessor
      * @param \Magento\Catalog\Helper\Product $catalogProduct
-     * @param \Magento\CatalogInventory\Api\Data\StockItemDataBuilder $stockItemBuilder
+     * @param \Magento\CatalogInventory\Api\Data\StockItemInterfaceFactory $stockItemFactory
      * @param \Magento\Backend\Model\View\Result\RedirectFactory $resultRedirectFactory
+     * @param \Magento\Framework\Api\DataObjectHelper $dataObjectHelper
      */
     public function __construct(
         Action\Context $context,
@@ -65,16 +71,18 @@ public function __construct(
         \Magento\Catalog\Model\Indexer\Product\Price\Processor $productPriceIndexerProcessor,
         \Magento\CatalogInventory\Model\Indexer\Stock\Processor $stockIndexerProcessor,
         \Magento\Catalog\Helper\Product $catalogProduct,
-        \Magento\CatalogInventory\Api\Data\StockItemDataBuilder $stockItemBuilder,
-        \Magento\Backend\Model\View\Result\RedirectFactory $resultRedirectFactory
+        \Magento\CatalogInventory\Api\Data\StockItemInterfaceFactory $stockItemFactory,
+        \Magento\Backend\Model\View\Result\RedirectFactory $resultRedirectFactory,
+        \Magento\Framework\Api\DataObjectHelper $dataObjectHelper
     ) {
         $this->_productFlatIndexerProcessor = $productFlatIndexerProcessor;
         $this->_productPriceIndexerProcessor = $productPriceIndexerProcessor;
         $this->_stockIndexerProcessor = $stockIndexerProcessor;
         $this->_catalogProduct = $catalogProduct;
-        $this->stockItemBuilder = $stockItemBuilder;
+        $this->stockItemFactory = $stockItemFactory;
         parent::__construct($context, $attributeHelper);
         $this->resultRedirectFactory = $resultRedirectFactory;
+        $this->dataObjectHelper = $dataObjectHelper;
     }
 
     /**
@@ -166,10 +174,13 @@ public function execute()
                     }
 
                     $stockItemId = $stockItemDo->getId();
-                    $stockItemBuilder = $this->stockItemBuilder->mergeDataObjectWithArray($stockItemDo, $inventoryData);
-                    $stockItemToSave = $stockItemBuilder->create();
-                    $stockItemToSave->setItemId($stockItemId);
-                    $stockItemRepository->save($stockItemToSave);
+                    $this->dataObjectHelper->populateWithArray(
+                        $stockItemDo,
+                        $inventoryData,
+                        '\Magento\CatalogInventory\Api\Data\StockItemInterface'
+                    );
+                    $stockItemDo->setItemId($stockItemId);
+                    $stockItemRepository->save($stockItemDo);
                 }
                 $this->_stockIndexerProcessor->reindexList($this->attributeHelper->getProductIds());
             }

app/code/Magento/Catalog/Model/Product.php

@@ -186,9 +186,9 @@ class Product extends \Magento\Catalog\Model\AbstractModel implements
     /**
      * Stock item factory
      *
-     * @var \Magento\CatalogInventory\Api\Data\StockItemDataBuilder
+     * @var \Magento\CatalogInventory\Api\Data\StockItemInterfaceFactory
      */
-    protected $_stockItemBuilder;
+    protected $_stockItemFactory;
 
     /**
      * Item option factory
@@ -237,6 +237,11 @@ class Product extends \Magento\Catalog\Model\AbstractModel implements
      */
     protected $imageCacheFactory;
 
+    /**
+     * @var \Magento\Framework\Api\DataObjectHelper
+     */
+    protected $dataObjectHelper;
+
     /**
      * @param \Magento\Framework\Model\Context $context
      * @param \Magento\Framework\Registry $registry
@@ -246,7 +251,7 @@ class Product extends \Magento\Catalog\Model\AbstractModel implements
      * @param Product\Url $url
      * @param Product\Link $productLink
      * @param Product\Configuration\Item\OptionFactory $itemOptionFactory
-     * @param \Magento\CatalogInventory\Api\Data\StockItemDataBuilder $stockItemBuilder
+     * @param \Magento\CatalogInventory\Api\Data\StockItemInterfaceFactory $stockItemFactory
      * @param Product\Option $catalogProductOption
      * @param Product\Visibility $catalogProductVisibility
      * @param Product\Attribute\Source\Status $catalogProductStatus
@@ -264,6 +269,7 @@ class Product extends \Magento\Catalog\Model\AbstractModel implements
      * @param Indexer\Product\Eav\Processor $productEavIndexerProcessor
      * @param CategoryRepositoryInterface $categoryRepository
      * @param Product\Image\CacheFactory $imageCacheFactory
+     * @param \Magento\Framework\Api\DataObjectHelper $dataObjectHelper
      * @param array $data
      *
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
@@ -277,7 +283,7 @@ public function __construct(
         Product\Url $url,
         Product\Link $productLink,
         \Magento\Catalog\Model\Product\Configuration\Item\OptionFactory $itemOptionFactory,
-        \Magento\CatalogInventory\Api\Data\StockItemDataBuilder $stockItemBuilder,
+        \Magento\CatalogInventory\Api\Data\StockItemInterfaceFactory $stockItemFactory,
         \Magento\Catalog\Model\Product\Option $catalogProductOption,
         \Magento\Catalog\Model\Product\Visibility $catalogProductVisibility,
         \Magento\Catalog\Model\Product\Attribute\Source\Status $catalogProductStatus,
@@ -295,10 +301,11 @@ public function __construct(
         \Magento\Catalog\Model\Indexer\Product\Eav\Processor $productEavIndexerProcessor,
         CategoryRepositoryInterface $categoryRepository,
         Product\Image\CacheFactory $imageCacheFactory,
+        \Magento\Framework\Api\DataObjectHelper $dataObjectHelper,
         array $data = []
     ) {
         $this->_itemOptionFactory = $itemOptionFactory;
-        $this->_stockItemBuilder = $stockItemBuilder;
+        $this->_stockItemFactory = $stockItemFactory;
         $this->_optionInstance = $catalogProductOption;
         $this->_catalogProductVisibility = $catalogProductVisibility;
         $this->_catalogProductStatus = $catalogProductStatus;
@@ -316,6 +323,7 @@ public function __construct(
         $this->_productEavIndexerProcessor = $productEavIndexerProcessor;
         $this->categoryRepository = $categoryRepository;
         $this->imageCacheFactory = $imageCacheFactory;
+        $this->dataObjectHelper = $dataObjectHelper;
         parent::__construct(
             $context,
             $registry,
@@ -1560,7 +1568,12 @@ public function fromArray(array $data)
     {
         if (isset($data['stock_item'])) {
             if ($this->moduleManager->isEnabled('Magento_CatalogInventory')) {
-                $stockItem = $this->_stockItemBuilder->populateWithArray($data['stock_item'])->create();
+                $stockItem = $this->_stockItemFactory->create();
+                $this->dataObjectHelper->populateWithArray(
+                    $stockItem,
+                    $data['stock_item'],
+                    '\Magento\CatalogInventory\Api\Data\StockItemInterface'
+                );
                 $stockItem->setProduct($this);
                 $this->setStockItem($stockItem);
             }

app/code/Magento/CatalogInventory/Api/Data/StockInterface.php

@@ -25,17 +25,41 @@ interface StockInterface extends ExtensibleDataInterface
      */
     public function getStockId();
 
+    /**
+     * Set stock identifier
+     *
+     * @param int $stockId
+     * @return $this
+     */
+    public function setStockId($stockId);
+
     /**
      * Retrieve website identifier
      *
      * @return int
      */
     public function getWebsiteId();
 
+    /**
+     * Retrieve website identifier
+     *
+     * @param int $websiteId
+     * @return $this
+     */
+    public function setWebsiteId($websiteId);
+
     /**
      * Retrieve stock name
      *
      * @return string
      */
     public function getStockName();
+
+    /**
+     * Set stock name
+     *
+     * @param string $stockName
+     * @return $this
+     */
+    public function setStockName($stockName);
 }