Make mapping more flexible (based on DivanteLtd#25)

icmaa · Nov 14, 2019 · 2c46678 · 2c46678
1 parent e10dd2f
commit 2c46678
Show file tree

Hide file tree

Showing 17 changed files with 147 additions and 0 deletions.
diff --git a/magento1-module/app/code/local/Divante/VueStorefrontBridge/Helper/Mapper/Abstract.php b/magento1-module/app/code/local/Divante/VueStorefrontBridge/Helper/Mapper/Abstract.php
@@ -62,9 +62,24 @@ final public function filterDto($initialDto)
             }
         }
 
+        $this->callMapperExtensions($dto);
+
         return $dto;
     }
 
+    /**
+     * Allow to extend the mappers using config.xml
+     *
+     * @param array $dto
+     * @return array
+     */
+    protected function callMapperExtensions(&$dto)
+    {
+        /** @var Divante_VueStorefrontBridge_Model_Config_Mapper $model */
+        $model = Mage::getModel('vsbridge/config_mapper');
+        return $model->applyExtendedMapping(self::MAPPER_IDENTIFIER, $dto);
+    }
+
     /**
      * Apply custom dto filtering
      *

diff --git a/magento1-module/app/code/local/Divante/VueStorefrontBridge/Helper/Mapper/Address.php b/magento1-module/app/code/local/Divante/VueStorefrontBridge/Helper/Mapper/Address.php
@@ -11,6 +11,11 @@
  */
 class Divante_VueStorefrontBridge_Helper_Mapper_Address extends Divante_VueStorefrontBridge_Helper_Mapper_Abstract
 {
+    /**
+     * Name to address custom mappers via config.xml
+     */
+    const MAPPER_IDENTIFIER = 'address';
+
     /**
      * @inheritdoc
      */

diff --git a/magento1-module/app/code/local/Divante/VueStorefrontBridge/Helper/Mapper/Category.php b/magento1-module/app/code/local/Divante/VueStorefrontBridge/Helper/Mapper/Category.php
@@ -11,6 +11,11 @@
  */
 class Divante_VueStorefrontBridge_Helper_Mapper_Category extends Divante_VueStorefrontBridge_Helper_Mapper_Abstract
 {
+    /**
+     * Name to address custom mappers via config.xml
+     */
+    const MAPPER_IDENTIFIER = 'category';
+
     /**
      * @inheritdoc
      */

diff --git a/magento1-module/app/code/local/Divante/VueStorefrontBridge/Helper/Mapper/Customer.php b/magento1-module/app/code/local/Divante/VueStorefrontBridge/Helper/Mapper/Customer.php
@@ -11,6 +11,11 @@
  */
 class Divante_VueStorefrontBridge_Helper_Mapper_Customer extends Divante_VueStorefrontBridge_Helper_Mapper_Abstract
 {
+    /**
+     * Name to address custom mappers via config.xml
+     */
+    const MAPPER_IDENTIFIER = 'customer';
+
     /**
      * @inheritdoc
      */

diff --git a/magento1-module/app/code/local/Divante/VueStorefrontBridge/Helper/Mapper/Order.php b/magento1-module/app/code/local/Divante/VueStorefrontBridge/Helper/Mapper/Order.php
@@ -11,6 +11,11 @@
  */
 class Divante_VueStorefrontBridge_Helper_Mapper_Order extends Divante_VueStorefrontBridge_Helper_Mapper_Abstract
 {
+    /**
+     * Name to address custom mappers via config.xml
+     */
+    const MAPPER_IDENTIFIER = 'order';
+
     /**
      * @inheritdoc
      */

diff --git a/magento1-module/app/code/local/Divante/VueStorefrontBridge/Helper/Mapper/OrderItem.php b/magento1-module/app/code/local/Divante/VueStorefrontBridge/Helper/Mapper/OrderItem.php
@@ -11,6 +11,11 @@
  */
 class Divante_VueStorefrontBridge_Helper_Mapper_OrderItem extends Divante_VueStorefrontBridge_Helper_Mapper_Abstract
 {
+    /**
+     * Name to address custom mappers via config.xml
+     */
+    const MAPPER_IDENTIFIER = 'order_item';
+
     /**
      * @inheritdoc
      */

diff --git a/magento1-module/app/code/local/Divante/VueStorefrontBridge/Helper/Mapper/Payment.php b/magento1-module/app/code/local/Divante/VueStorefrontBridge/Helper/Mapper/Payment.php
@@ -11,4 +11,8 @@
  */
 class Divante_VueStorefrontBridge_Helper_Mapper_Payment extends Divante_VueStorefrontBridge_Helper_Mapper_Abstract
 {
+    /**
+     * Name to address custom mappers via config.xml
+     */
+    const MAPPER_IDENTIFIER = 'payment';
 }
diff --git a/magento1-module/app/code/local/Divante/VueStorefrontBridge/Helper/Mapper/Product.php b/magento1-module/app/code/local/Divante/VueStorefrontBridge/Helper/Mapper/Product.php
@@ -11,4 +11,8 @@
  */
 class Divante_VueStorefrontBridge_Helper_Mapper_Product extends Divante_VueStorefrontBridge_Helper_Mapper_Abstract
 {
+    /**
+     * Name to address custom mappers via config.xml
+     */
+    const MAPPER_IDENTIFIER = 'product';
 }
diff --git a/...nto1-module/app/code/local/Divante/VueStorefrontBridge/Helper/Mapper/ProductAttribute.php b/...nto1-module/app/code/local/Divante/VueStorefrontBridge/Helper/Mapper/ProductAttribute.php
@@ -11,6 +11,11 @@
  */
 class Divante_VueStorefrontBridge_Helper_Mapper_ProductAttribute extends Divante_VueStorefrontBridge_Helper_Mapper_Abstract
 {
+    /**
+     * Name to address custom mappers via config.xml
+     */
+    const MAPPER_IDENTIFIER = 'product_attribute';
+
     /**
      * @inheritdoc
      */

diff --git a/magento1-module/app/code/local/Divante/VueStorefrontBridge/Helper/Mapper/ProductChild.php b/magento1-module/app/code/local/Divante/VueStorefrontBridge/Helper/Mapper/ProductChild.php
@@ -11,6 +11,11 @@
  */
 class Divante_VueStorefrontBridge_Helper_Mapper_ProductChild extends Divante_VueStorefrontBridge_Helper_Mapper_Abstract
 {
+    /**
+     * Name to address custom mappers via config.xml
+     */
+    const MAPPER_IDENTIFIER = 'product_child';
+
     /**
      * @inheritdoc
      */

diff --git a/magento1-module/app/code/local/Divante/VueStorefrontBridge/Helper/Mapper/QuoteItem.php b/magento1-module/app/code/local/Divante/VueStorefrontBridge/Helper/Mapper/QuoteItem.php
@@ -11,6 +11,11 @@
  */
 class Divante_VueStorefrontBridge_Helper_Mapper_QuoteItem extends Divante_VueStorefrontBridge_Helper_Mapper_Abstract
 {
+    /**
+     * Name to address custom mappers via config.xml
+     */
+    const MAPPER_IDENTIFIER = 'quote_item';
+
     /**
      * @inheritdoc
      */

diff --git a/magento1-module/app/code/local/Divante/VueStorefrontBridge/Helper/Mapper/Stock.php b/magento1-module/app/code/local/Divante/VueStorefrontBridge/Helper/Mapper/Stock.php
@@ -11,6 +11,11 @@
  */
 class Divante_VueStorefrontBridge_Helper_Mapper_Stock extends Divante_VueStorefrontBridge_Helper_Mapper_Abstract
 {
+    /**
+     * Name to address custom mappers via config.xml
+     */
+    const MAPPER_IDENTIFIER = 'stock';
+
     /**
      * @inheritdoc
      */

diff --git a/magento1-module/app/code/local/Divante/VueStorefrontBridge/Helper/Mapper/Taxrule.php b/magento1-module/app/code/local/Divante/VueStorefrontBridge/Helper/Mapper/Taxrule.php
@@ -11,6 +11,11 @@
  */
 class Divante_VueStorefrontBridge_Helper_Mapper_Taxrule extends Divante_VueStorefrontBridge_Helper_Mapper_Abstract
 {
+    /**
+     * Name to address custom mappers via config.xml
+     */
+    const MAPPER_IDENTIFIER = 'taxrule';
+
     /**
      * @inheritdoc
      */

diff --git a/magento1-module/app/code/local/Divante/VueStorefrontBridge/Helper/Mapper/TaxruleRate.php b/magento1-module/app/code/local/Divante/VueStorefrontBridge/Helper/Mapper/TaxruleRate.php
@@ -11,6 +11,11 @@
  */
 class Divante_VueStorefrontBridge_Helper_Mapper_TaxruleRate extends Divante_VueStorefrontBridge_Helper_Mapper_Abstract
 {
+    /**
+     * Name to address custom mappers via config.xml
+     */
+    const MAPPER_IDENTIFIER = 'taxrule_rate';
+
     /**
      * @inheritdoc
      */

diff --git a/magento1-module/app/code/local/Divante/VueStorefrontBridge/Helper/Mapper/WhishListItem.php b/magento1-module/app/code/local/Divante/VueStorefrontBridge/Helper/Mapper/WhishListItem.php
@@ -11,4 +11,8 @@
  */
 class Divante_VueStorefrontBridge_Helper_Mapper_WhishListItem extends Divante_VueStorefrontBridge_Helper_Mapper_Abstract
 {
+    /**
+     * Name to address custom mappers via config.xml
+     */
+    const MAPPER_IDENTIFIER = 'whishlist_item';
 }
diff --git a/magento1-module/app/code/local/Divante/VueStorefrontBridge/Model/Config/Mapper.php b/magento1-module/app/code/local/Divante/VueStorefrontBridge/Model/Config/Mapper.php
@@ -0,0 +1,53 @@
+<?php
+
+/**
+ * Class Divante_VueStorefrontBridge_Model_Config_Mapper
+ */
+class Divante_VueStorefrontBridge_Model_Config_Mapper
+{
+    /**
+     * Mapper xml config path
+     */
+    const MAPPER_CONFIG_ROOT_NODE  = 'global/vsf_bridge/mapper/types';
+
+    /**
+     * @var array
+     */
+    protected $config = array();
+
+    /**
+     * @return array
+     */
+    public function __construct()
+    {
+        $mappingConfigTypes = Mage::getConfig()->getNode(self::MAPPER_CONFIG_ROOT_NODE)->asArray();
+        foreach ($mappingConfigTypes as $mappingIdentifier => $mapper) {
+            $this->config[$mappingIdentifier] =  $mapper['mapper'];
+        }
+
+        return $this->config;
+    }
+
+    /**
+     * @param string $type
+     * @param array $initialDto
+     * @return array
+     */
+    public function applyExtendedMapping($type, &$initialDto)
+    {
+        if ($this->config[$type] && !empty($this->config[$type])) {
+            foreach ($this->config[$type] as $name => $className) {
+                $model = Mage::getModel($className);
+                if (!$model || !$model instanceof Divante_VueStorefrontBridge_Helper_Mapper_Abstract) {
+                    $error = 'Class "%s" is not an instance on "Divante_VueStorefrontBridge_Helper_Mapper_Abstract".';
+                    Mage::log(sprintf($error, $className), 'system.log', true);
+                    continue;
+                }
+
+                $initialDto = $model->filterDto($initialDto);
+            }
+        }
+
+        return $initialDto;
+    }
+}
diff --git a/magento1-module/app/code/local/Divante/VueStorefrontBridge/etc/config.xml b/magento1-module/app/code/local/Divante/VueStorefrontBridge/etc/config.xml
@@ -30,6 +30,18 @@
                 <class>Divante_VueStorefrontBridge_Helper_Mapper</class>
             </vsbridge_mapper>
         </helpers>
+        <vsf_bridge>
+            <mapper>
+                <types>
+                    <!--address>
+                        <mapper>
+                            <add_custom_attribute_mapping>Divante_VueStorefrontIndexer_Helper_Mapper_CustomClass</add_custom_attribute_mapping>
+                            <filter_another_attribute>Divante_VueStorefrontIndexer_Helper_Mapper_SecondCustomClass</filter_another_attribute>
+                        </mapper>
+                    </address-->
+                </type>
+            </mapper>
+        </vsf_bridge>
     </global>
     <default>
         <vsbridge>