Merge pull request #13 from scaleflex/develop

add ignore blocks

Author: dangscaleflex

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to this project will be documented in this file.
 
+## [2.0.5] - 2022-08-01
+
+* Support ignore blocks
+
 ## [2.0.4] - 2022-08-01
 
 * Support ```params``` options with Library option 

Helper/Config.php

@@ -37,6 +37,7 @@ class Config extends AbstractHelper
     const XML_PATH_SCALEFLEX_CLOUDIMAGE_ADVANCED_FOTORAMA_COMPATIBILITY = 'scaleflex_cloudimage/advanced/fortorama_compatibility';
     const XML_PATH_SCALEFLEX_CLOUDIMAGE_ADVANCED_DEVICEPIXELRATIO = 'scaleflex_cloudimage/advanced/devicepixelratio';
     const XML_PATH_SCALEFLEX_CLOUDIMAGE_OPTIONS_ORG_IF_SML = 'scaleflex_cloudimage/advanced/orgifsml';
+    const XML_PATH_SCALEFLEX_CLOUDIMAGE_IGNORE_BLOCKS = 'scaleflex_cloudimage/advanced/ignore_blocks';
 
     /**
      * @return bool
@@ -59,6 +60,29 @@ public function getToken()
         );
     }
 
+    /**
+     * Get ignore blocks
+     *
+     * @return array
+     */
+    public function getIgnoreBlocks()
+    {
+        $ignoreList   = [];
+        $ignoreBlocks =  $this->scopeConfig->getValue(
+            self::XML_PATH_SCALEFLEX_CLOUDIMAGE_IGNORE_BLOCKS,
+            ScopeInterface::SCOPE_STORE
+        );
+        if (!empty($ignoreBlocks)) {
+            $ignoreBlocks   = trim($ignoreBlocks);
+            $explodedBlocks = explode(",", $ignoreBlocks);
+            foreach ($explodedBlocks as $item) {
+                $ignoreList[] = trim($item);
+            }
+        }
+
+        return $ignoreList;
+    }
+
     /**
      * Get Scaleflex Cloudimage plugin configuration
      *

Observer/ProcessImages.php

@@ -32,7 +32,7 @@ class ProcessImages implements ObserverInterface
      * ProcessImages constructor.
      *
      * @param Config $config
-     * @param Images $images
+     * @param Images $imagesz
      */
     public function __construct(
         Config $config,
@@ -51,11 +51,41 @@ public function execute(Observer $observer)
             return;
         }
         $transport = $observer->getData('transport');
+        $block     = $observer->getData('block');
+
+        if ($this->isIgnoreBlock($block)) {
+            return;
+        }
+
         if (stripos($transport->getHtml(), '<img') !== false) {
             $newHtml = $this->images->processHtml($transport->getHtml());
             if ($transport->getHtml() !== $newHtml) {
                 $transport->setData('html', $newHtml);
             }
         }
     }
+
+    /**
+     * Check ignored block
+     * @param $block
+     * @return bool
+     */
+    private function isIgnoreBlock($block)
+    {
+        $blockName          = $block->getNameInLayout();
+        $blockChildNames    = $block->getChildNames();
+        $ignoreBlocks       = $this->config->getIgnoreBlocks();
+
+        if (in_array($blockName, $ignoreBlocks)) {
+            return true;
+        }
+
+        foreach ($blockChildNames as $childName) {
+            if (in_array($childName, $ignoreBlocks)) {
+                return true;
+            }
+        }
+
+        return false;
+    }
 }

README.md

@@ -64,15 +64,15 @@ Once the steps listed above are completed enter your Cloudimage token into the S
 Stores > Configuration > Cloudimage By Scaleflex > Cloudimage
 ```
 
-![Scaleflex Cloudimage Plugin Configuration](doc/images/cloudimage_plugin_config_2.0.3.png "Scaleflex Cloudimage Configuration Page")
+![Scaleflex Cloudimage Plugin Configuration](doc/images/2.0.5.png "Scaleflex Cloudimage Configuration Page")
 
 Expand the `General` section and activate the module by selecting `Yes` in the `Scaleflex Cloudimage Active` dropdown. Enter your Cloudimage token and configure the Options.
 
 After saving the configuration, you will be asked to flush your Magento cache.
 
 ## Options
 
-**(New) Support multiple websites and store views, now you can have difference token for each website.**
+**Support multiple websites and store views, now you can have difference token for each website.**
 
 Following options are available: 
 
@@ -102,12 +102,13 @@ This setting is for advanced users only and allows to inject a custom JS functio
 
 **Maximum "Pixel ratio"**: List of supported device pixel ratios, default is 2, eg: 2 for Retina devices
 
-**(New)Prevent Image Resize**: If you set Maximum "Pixel ratio" equal to 2, but some of your assets does not have min retina size(at least 2560x960), please enable this to prevent image resized
+**Prevent Image Resize**: If you set Maximum "Pixel ratio" equal to 2, but some of your assets does not have min retina size(at least 2560x960), please enable this to prevent image resized
 
 **Custom Library Options**: Those optional parameters will be added to the request for each URL going through the Cloudimage acceleration infrastructure. It can allow you to force image formats, apply automatic transformations or watermarking, and might be used for troubleshooting purposes. (for advanced users only, please refer to the official [Cloudimage documentation here](https://docs/cloudimage.io) for the list of possible parameters)
 
 **Remove v7**: Removes the "/v7" part in URL format. Activate for token created after October 20th 2021.
 
+**Ignore blocks(New)**: Cloudimage will not affect on these blocks, separate by comma. For example: product.info.description, product.info.attribute.
 
 ## 2. Integration "on-the-fly" in Magento templates
 

composer.json

@@ -7,7 +7,7 @@
         "ext-libxml": "*"
     },
     "type": "magento2-module",
-    "version": "2.0.4",
+    "version": "2.0.5",
     "license": "BSD-3-Clause",
     "authors": [
         {

doc/images/2.0.5.png

@@ -80,16 +80,16 @@
                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
                     <comment><![CDATA[By default, yes.]]></comment>
                 </field>
-                 <field id="fortorama_compatibility" translate="label" type="select" sortOrder="40" showInDefault="1" showInWebsite="1" showInStore="1">
-                     <label>Fotorama Compatibility Mode</label>
-                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
-                     <comment><![CDATA[Fotorama compatibility mode, default no]]></comment>
-                 </field>
-                 <field id="devicepixelratio" translate="label" type="select" sortOrder="50" showInDefault="1" showInWebsite="1" showInStore="1">
+                <field id="fortorama_compatibility" translate="label" type="select" sortOrder="40" showInDefault="1" showInWebsite="1" showInStore="1">
+                    <label>Fotorama Compatibility Mode</label>
+                    <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
+                    <comment><![CDATA[Fotorama compatibility mode, default no]]></comment>
+                </field>
+                <field id="devicepixelratio" translate="label" type="select" sortOrder="50" showInDefault="1" showInWebsite="1" showInStore="1">
                     <label>Maximum "Pixel ratio"</label>
                     <source_model>Scaleflex\Cloudimage\Model\Config\Source\PixelRatio</source_model>
                     <comment><![CDATA[List of supported device pixel ratios, eg: 2 for Retina devices]]></comment>
-                 </field>
+                </field>
                 <field id="orgifsml" translate="label" type="select" sortOrder="50" showInDefault="1" showInWebsite="1" showInStore="1">
                     <label>Prevent Image Resize</label>
                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
@@ -104,6 +104,10 @@
                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
                     <comment><![CDATA[Removes the "/v7" part in URL format. Activate for token created after October 20th 2021.]]></comment>
                 </field>
+                <field id="ignore_blocks" translate="label" type="text" sortOrder="80" showInDefault="1" showInWebsite="1" showInStore="1">
+                    <label>Ignore blocks</label>
+                    <comment><![CDATA[Cloudimage will not affect on these blocks, separate by comma. For example: product.info.description, product.info.attribute]]></comment>
+                </field>
             </group>
         </section>
     </system>

etc/adminhtml/system.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0"?>
 <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
-    <module name="Scaleflex_Cloudimage" setup_version="2.0.4">
+    <module name="Scaleflex_Cloudimage" setup_version="2.0.5">
         <sequence>
             <module name="Magento_Catalog"/>
         </sequence>