Merge pull request #2267 from magento-engcom/MSI-2182-Source-Entity-e…

…xpansion-with-Pickup-Location-attributes Msi 2182 source entity expansion with pickup location attributes
magento · Jun 5, 2019 · 608ba9e · 608ba9e
2 parents 46479a6 + 2488b17
commit 608ba9e
Show file tree

Hide file tree

Showing 21 changed files with 448 additions and 169 deletions.
diff --git a/InventoryInStorePickup/Model/PickupLocation.php b/InventoryInStorePickup/Model/PickupLocation.php
@@ -91,11 +91,6 @@ class PickupLocation implements PickupLocationInterface
      */
     private $phone;
 
-    /**
-     * @var string[]|null
-     */
-    private $openHours;
-
     /**
      * @var string|null
      */
@@ -117,7 +112,6 @@ class PickupLocation implements PickupLocationInterface
      * @param string|null $street
      * @param string|null $postcode
      * @param string|null $phone
-     * @param string[]|null $openHours
      * @param PickupLocationExtensionInterface|null $extensionAttributes
      */
     public function __construct(
@@ -136,7 +130,6 @@ public function __construct(
         ?string $street = null,
         ?string $postcode = null,
         ?string $phone = null,
-        ?array $openHours = null,
         ?PickupLocationExtensionInterface $extensionAttributes = null
     ) {
         $this->sourceCode = $sourceCode;
@@ -154,7 +147,6 @@ public function __construct(
         $this->street = $street;
         $this->postcode = $postcode;
         $this->phone = $phone;
-        $this->openHours = $openHours;
         $this->extensionAttributes = $extensionAttributes;
     }
 
@@ -278,14 +270,6 @@ public function getPhone(): ?string
         return $this->phone;
     }
 
-    /**
-     * @inheritdoc
-     */
-    public function getOpenHours(): ?array
-    {
-        return $this->openHours;
-    }
-
     /**
      * @inheritdoc
      */

diff --git a/InventoryInStorePickup/Model/PickupLocation/Mapper/CreateFromSource.php b/InventoryInStorePickup/Model/PickupLocation/Mapper/CreateFromSource.php
@@ -13,6 +13,7 @@
 use Magento\InventoryInStorePickupApi\Api\Data\PickupLocationInterface;
 use Magento\InventoryInStorePickupApi\Api\Data\PickupLocationInterfaceFactory;
 use Magento\InventoryInStorePickupApi\Model\Mapper\CreateFromSourceInterface;
+use Magento\InventoryInStorePickupApi\Model\Mapper\PreProcessorInterface;
 
 /**
  * @inheritdoc
@@ -47,28 +48,49 @@ public function __construct(
      * @inheritdoc
      * @throws \InvalidArgumentException
      */
-    public function execute(SourceInterface $source, array $map): PickupLocationInterface
+    public function execute(SourceInterface $source, array $map, array $preProcessors): PickupLocationInterface
     {
-        $mappedData = $this->extractDataFromSource($source, $map);
-        $data = $this->preparePickupLocationFields($mappedData);
+        $data = $this->extractDataFromSource($source, $map);
+        $data = $this->preProcessData($source, $data, $preProcessors);
+        $data = $this->preparePickupLocationFields($data, $map);
 
         return $this->pickupLocationFactory->create($data);
     }
 
     /**
-     * @param array $mappedData
+     * @param SourceInterface $source
+     * @param array $data
+     * @param PreProcessorInterface[] $preProcessors
      *
      * @return array
      */
-    private function preparePickupLocationFields(array $mappedData): array
+    private function preProcessData(SourceInterface $source, array $data, array $preProcessors)
+    {
+        foreach ($preProcessors as $field => $processor) {
+            if (array_key_exists($field, $data)) {
+                $data[$field] = $processor->process($source, $data[$field]);
+            }
+        }
+
+        return $data;
+    }
+
+    /**
+     * @param array $sourceData
+     * @param array $map
+     *
+     * @return array
+     */
+    private function preparePickupLocationFields(array $sourceData, array $map): array
     {
         $pickupLocationExtension = $this->extensionAttributesFactory->create(PickupLocationInterface::class);
         $pickupLocationMethods = get_class_methods(PickupLocationInterface::class);
         $data = [
             'extensionAttributes' => $pickupLocationExtension
         ];
 
-        foreach ($mappedData as $pickupLocationField => $value) {
+        foreach ($sourceData as $sourceField => $value) {
+            $pickupLocationField = $map[$sourceField];
             if ($this->isExtensionAttributeField($pickupLocationField)) {
                 $methodName = $this->getSetterMethodName($this->getExtensionAttributeFieldName($pickupLocationField));
 
@@ -91,15 +113,15 @@ private function preparePickupLocationFields(array $mappedData): array
     /**
      * Extract values from Source according to the provided map.
      *
-     * @param \Magento\InventoryApi\Api\Data\SourceInterface $source
+     * @param SourceInterface $source
      * @param string[] $map
      *
      * @return array
      */
     private function extractDataFromSource(SourceInterface $source, array $map): array
     {
-        $mappedData = [];
-        foreach ($map as $sourceField => $pickupLocationField) {
+        $sourceData = [];
+        foreach (array_keys($map) as $sourceField) {
             if ($this->isExtensionAttributeField($sourceField)) {
                 $methodName = $this->getGetterMethodName($this->getExtensionAttributeFieldName($sourceField));
                 $entity = $source->getExtensionAttributes();
@@ -112,10 +134,10 @@ private function extractDataFromSource(SourceInterface $source, array $map): arr
                 $this->throwException(SourceInterface::class, $sourceField);
             }
 
-            $mappedData[$pickupLocationField] = $entity->{$methodName}();
+            $sourceData[$sourceField] = $entity->{$methodName}();
         }
 
-        return $mappedData;
+        return $sourceData;
     }
 
     /**

diff --git a/InventoryInStorePickup/Model/PickupLocation/Mapper/PreProcessor/FrontendName.php b/InventoryInStorePickup/Model/PickupLocation/Mapper/PreProcessor/FrontendName.php
@@ -0,0 +1,33 @@
+<?php
+/**
+ *  Copyright © Magento, Inc. All rights reserved.
+ *  See COPYING.txt for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Magento\InventoryInStorePickup\Model\PickupLocation\Mapper\PreProcessor;
+
+use Magento\InventoryApi\Api\Data\SourceInterface;
+use Magento\InventoryInStorePickupApi\Model\Mapper\PreProcessorInterface;
+
+class FrontendName implements PreProcessorInterface
+{
+
+    /**
+     * Process Source Field before pass it to Pickup Location
+     *
+     * @param SourceInterface $source
+     * @param string $value Frontend Name Extension Attribute value
+     *
+     * @return string
+     */
+    public function process(SourceInterface $source, $value): string
+    {
+        if (empty($value)) {
+            $value = $source->getName();
+        }
+
+        return $value;
+    }
+}
diff --git a/InventoryInStorePickup/Model/Source/InitPickupLocationExtensionAttributes.php b/InventoryInStorePickup/Model/Source/InitPickupLocationExtensionAttributes.php
@@ -0,0 +1,58 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Magento\InventoryInStorePickup\Model\Source;
+
+use Magento\Framework\Api\ExtensionAttributesFactory;
+use Magento\Framework\DataObject;
+use Magento\InventoryApi\Api\Data\SourceInterface;
+use Magento\InventoryInStorePickupApi\Api\Data\PickupLocationInterface;
+
+/**
+ * Set store-pickup related source extension attributes
+ */
+class InitPickupLocationExtensionAttributes
+{
+    /**
+     * @var ExtensionAttributesFactory
+     */
+    private $extensionAttributesFactory;
+
+    /**
+     * @param ExtensionAttributesFactory $extensionAttributesFactory
+     */
+    public function __construct(ExtensionAttributesFactory $extensionAttributesFactory)
+    {
+        $this->extensionAttributesFactory = $extensionAttributesFactory;
+    }
+    /**
+     * @param SourceInterface $source
+     */
+    public function execute(SourceInterface $source): void
+    {
+        if (!$source instanceof DataObject) {
+            return;
+        }
+        $pickupAvailable = $source->getData(PickupLocationInterface::IS_PICKUP_LOCATION_ACTIVE);
+        $frontendName = $source->getData(PickupLocationInterface::FRONTEND_NAME);
+        $frontendDescription = $source->getData(PickupLocationInterface::FRONTEND_DESCRIPTION);
+
+        $extensionAttributes = $source->getExtensionAttributes();
+
+        if ($extensionAttributes === null) {
+            $extensionAttributes = $this->extensionAttributesFactory->create(SourceInterface::class);
+            /** @noinspection PhpParamsInspection */
+            $source->setExtensionAttributes($extensionAttributes);
+        }
+
+        $extensionAttributes
+            ->setIsPickupLocationActive((bool)$pickupAvailable)
+            ->setFrontendName($frontendName)
+            ->setFrontendDescription($frontendDescription);
+    }
+}
diff --git a/...ryInStorePickup/Plugin/InventoryApi/SourceRepository/LoadInStorePickupOnGetListPlugin.php b/...ryInStorePickup/Plugin/InventoryApi/SourceRepository/LoadInStorePickupOnGetListPlugin.php
@@ -7,25 +7,24 @@
 
 namespace Magento\InventoryInStorePickup\Plugin\InventoryApi\SourceRepository;
 
-use Magento\Framework\Api\ExtensionAttributesFactory;
-use Magento\InventoryApi\Api\Data\SourceInterface;
 use Magento\InventoryApi\Api\Data\SourceSearchResultsInterface;
 use Magento\InventoryApi\Api\SourceRepositoryInterface;
-use Magento\InventoryInStorePickupApi\Api\Data\PickupLocationInterface;
+use Magento\InventoryInStorePickup\Model\Source\InitPickupLocationExtensionAttributes;
 
 class LoadInStorePickupOnGetListPlugin
 {
     /**
-     * @var ExtensionAttributesFactory
+     * @var InitPickupLocationExtensionAttributes
      */
-    private $extensionAttributesFactory;
+    private $setExtensionAttributes;
 
     /**
-     * @param ExtensionAttributesFactory $extensionAttributesFactory
+     * @param InitPickupLocationExtensionAttributes $setExtensionAttributes
      */
-    public function __construct(ExtensionAttributesFactory $extensionAttributesFactory)
-    {
-        $this->extensionAttributesFactory = $extensionAttributesFactory;
+    public function __construct(
+        InitPickupLocationExtensionAttributes $setExtensionAttributes
+    ) {
+        $this->setExtensionAttributes = $setExtensionAttributes;
     }
 
     /**
@@ -40,18 +39,12 @@ public function __construct(ExtensionAttributesFactory $extensionAttributesFacto
     public function afterGetList(
         SourceRepositoryInterface $subject,
         SourceSearchResultsInterface $sourceSearchResults
-    ):SourceSearchResultsInterface {
-        foreach ($sourceSearchResults->getItems() as $source) {
-            $extensionAttributes = $source->getExtensionAttributes();
-
-            if ($extensionAttributes === null) {
-                $extensionAttributes = $this->extensionAttributesFactory->create(SourceInterface::class);
-                $source->setExtensionAttributes($extensionAttributes);
-            }
-
-            $pickupAvailable = $source->getData(PickupLocationInterface::IS_PICKUP_LOCATION_ACTIVE);
-            $extensionAttributes->setIsPickupLocationActive((bool)$pickupAvailable);
-        }
+    ): SourceSearchResultsInterface {
+        $items = $sourceSearchResults->getItems();
+        array_walk(
+            $items,
+            [$this->setExtensionAttributes, 'execute']
+        );
 
         return $sourceSearchResults;
     }

diff --git a/InventoryInStorePickup/Plugin/InventoryApi/SourceRepository/LoadInStorePickupOnGetPlugin.php b/InventoryInStorePickup/Plugin/InventoryApi/SourceRepository/LoadInStorePickupOnGetPlugin.php
@@ -7,24 +7,25 @@
 
 namespace Magento\InventoryInStorePickup\Plugin\InventoryApi\SourceRepository;
 
-use Magento\Framework\Api\ExtensionAttributesFactory;
+use Magento\Framework\DataObject;
 use Magento\InventoryApi\Api\Data\SourceInterface;
 use Magento\InventoryApi\Api\SourceRepositoryInterface;
-use Magento\InventoryInStorePickupApi\Api\Data\PickupLocationInterface;
+use Magento\InventoryInStorePickup\Model\Source\InitPickupLocationExtensionAttributes;
 
 class LoadInStorePickupOnGetPlugin
 {
     /**
-     * @var \Magento\Framework\Api\ExtensionAttributesFactory
+     * @var InitPickupLocationExtensionAttributes
      */
-    private $extensionAttributesFactory;
+    private $setExtensionAttributes;
 
     /**
-     * @param \Magento\Framework\Api\ExtensionAttributesFactory $extensionAttributesFactory
+     * @param InitPickupLocationExtensionAttributes $setExtensionAttributes
      */
-    public function __construct(ExtensionAttributesFactory $extensionAttributesFactory)
-    {
-        $this->extensionAttributesFactory = $extensionAttributesFactory;
+    public function __construct(
+        InitPickupLocationExtensionAttributes $setExtensionAttributes
+    ) {
+        $this->setExtensionAttributes = $setExtensionAttributes;
     }
 
     /**
@@ -39,17 +40,8 @@ public function __construct(ExtensionAttributesFactory $extensionAttributesFacto
     public function afterGet(
         SourceRepositoryInterface $subject,
         SourceInterface $source
-    ):SourceInterface {
-        $pickupAvailable = $source->getData(PickupLocationInterface::IS_PICKUP_LOCATION_ACTIVE);
-
-        $extensionAttributes = $source->getExtensionAttributes();
-
-        if ($extensionAttributes === null) {
-            $extensionAttributes = $this->extensionAttributesFactory->create(SourceInterface::class);
-            $source->setExtensionAttributes($extensionAttributes);
-        }
-
-        $extensionAttributes->setIsPickupLocationActive((bool)$pickupAvailable);
+    ): SourceInterface {
+        $this->setExtensionAttributes->execute($source);
 
         return $source;
     }

diff --git a/InventoryInStorePickup/Plugin/InventoryApi/SourceRepository/SaveInStorePickupPlugin.php b/InventoryInStorePickup/Plugin/InventoryApi/SourceRepository/SaveInStorePickupPlugin.php
@@ -7,9 +7,15 @@
 
 namespace Magento\InventoryInStorePickup\Plugin\InventoryApi\SourceRepository;
 
+use Magento\Framework\DataObject;
 use Magento\InventoryApi\Api\Data\SourceInterface;
 use Magento\InventoryApi\Api\SourceRepositoryInterface;
+use Magento\InventoryInStorePickupApi\Api\Data\PickupLocationInterface as Location;
 
+/**
+ * Set data to Source itself from its extension attributes to save
+ * these values to `inventory_source` DB table
+ */
 class SaveInStorePickupPlugin
 {
     /**
@@ -24,11 +30,13 @@ class SaveInStorePickupPlugin
     public function beforeSave(
         SourceRepositoryInterface $subject,
         SourceInterface $source
-    ):array {
+    ): array {
         $extensionAttributes = $source->getExtensionAttributes();
 
-        if ($extensionAttributes !== null && $extensionAttributes->getIsPickupLocationActive() !== null) {
-            $source->setIsPickupLocationActive($extensionAttributes->getIsPickupLocationActive());
+        if ($extensionAttributes !== null && $source instanceof  DataObject) {
+            $source->setData(Location::IS_PICKUP_LOCATION_ACTIVE, $extensionAttributes->getIsPickupLocationActive());
+            $source->setData(Location::FRONTEND_NAME, $extensionAttributes->getFrontendName());
+            $source->setData(Location::FRONTEND_DESCRIPTION, $extensionAttributes->getFrontendDescription());
         }
 
         return [$source];