Merge pull request #15 from magefan/12599-add-custom-position

magefan · web-flow · commit 3a40589fdca4 · 2025-01-23T09:02:40.000-05:00
12599 added ability to create custom positions and use them in rules
diff --git a/Block/Adminhtml/System/Config/Form/DynamicRow.php b/Block/Adminhtml/System/Config/Form/DynamicRow.php
@@ -0,0 +1,26 @@
+<?php
+/**
+ * Copyright © Magefan (support@magefan.com). All rights reserved.
+ * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
+ *
+ * Glory to Ukraine! Glory to the heroes!
+ */
+
+declare(strict_types=1);
+
+namespace Magefan\ProductLabel\Block\Adminhtml\System\Config\Form;
+
+use Magento\Config\Block\System\Config\Form\Field\FieldArray\AbstractFieldArray;
+
+class DynamicRow extends AbstractFieldArray
+{
+    /**
+     * Prepare rendering the new field by adding all the needed columns
+     */
+    protected function _prepareToRender()
+    {
+        $this->addColumn('position', ['label' => __('Position')]);
+        $this->_addAfter = false;
+        $this->_addButtonLabel = __('Add');
+    }
+}
diff --git a/Model/Config.php b/Model/Config.php
@@ -9,6 +9,7 @@
 
 use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Store\Model\ScopeInterface;
+use Magento\Framework\Serialize\SerializerInterface;
 
 /**
  * Class Config
@@ -20,6 +21,16 @@ class Config
      */
     protected $scopeConfig;
 
+    /**
+     * @var SerializerInterface
+     */
+    protected $serializer;
+
+    /**
+     * @var null
+     */
+    protected $customPositions = null;
+
     /**
      * Extension enabled config path
      */
@@ -35,14 +46,20 @@ class Config
 
     const XML_PATH_EXCLUDE_PAGE_TYPES = 'mfproductlabel/general/exclude_page_types';
 
+    const XML_PATH_CUSTOM_POSITIONS = 'mfproductlabel/general/custom_positions';
+
+    const SPLITTERS_FOR_CUSTOM_POSITIONS = '<!--mfcp_splitter--!>';
+
     /**
-     * Config constructor.
      * @param ScopeConfigInterface $scopeConfig
+     * @param SerializerInterface $serializer
      */
     public function __construct(
-        ScopeConfigInterface $scopeConfig
+        ScopeConfigInterface $scopeConfig,
+        SerializerInterface $serializer
     ) {
         $this->scopeConfig = $scopeConfig;
+        $this->serializer = $serializer;
     }
 
     /**
@@ -100,4 +117,25 @@ public function getExcludePageTypes(): array
         return explode(',', $pageTypes);
     }
 
+    /**
+     * @return array
+     */
+    public function getCustomPositions(): array
+    {
+        if (null == $this->customPositions) {
+            $this->customPositions = [];
+
+            try {
+                $customPositions = $this->serializer->unserialize($this->getConfig(self::XML_PATH_CUSTOM_POSITIONS));
+            } catch (\InvalidArgumentException $e) {
+                return $this->customPositions;
+            }
+
+            foreach ($customPositions as $positionData) {
+                $this->customPositions[$positionData['position']] = $positionData['position'];
+            }
+        }
+
+        return $this->customPositions;
+    }
 }
diff --git a/Model/GetLabels.php b/Model/GetLabels.php
@@ -95,6 +95,9 @@ public function execute(array $productIds, array $productIdsForProductPage = [])
 
             $productLabels = $this->getAvailableProductLabels($rules, $productRuleIds, $forProductPage);
 
+            $productLabelsForCustomPosition = $productLabels['custom'] ?? [];
+            unset($productLabels['custom']);
+
             $htmlToReplace = $this->layout
                 ->createBlock(\Magefan\ProductLabel\Block\Label::class)
                 ->setProductLabels($productLabels)
@@ -104,6 +107,21 @@ public function execute(array $productIds, array $productIdsForProductPage = [])
             if ($htmlToReplace) {
                 $replaceMap[$productId] = $htmlToReplace;
             }
+
+            if ($productLabelsForCustomPosition) {
+                foreach ($productLabelsForCustomPosition as $customPositionName => $productLabelsForCustomPosition) {
+                    $htmlToReplace = $this->layout
+                        ->createBlock(\Magefan\ProductLabel\Block\Label::class)
+                        ->setProductLabels([$customPositionName => $productLabelsForCustomPosition])
+                        ->setAdditionalCssClass($forProductPage ? 'mfpl-product-page' : '')
+                        ->setIsCustomPosition(true)
+                        ->toHtml();
+
+                    if ($htmlToReplace) {
+                        $replaceMap[$productId] .= Config::SPLITTERS_FOR_CUSTOM_POSITIONS . $htmlToReplace;
+                    }
+                }
+            }
         }
 
         if (null !== $this->labelProcessor) {
@@ -137,7 +155,12 @@ public function getAvailableProductLabels($rules, $productRuleIds, $forProductPa
                 }
 
                 if (!isset($discardRulePerPosition[$position])) {
-                    $productLabels[$position][] = $rule->getLabelData($forProductPage);
+                    if ($position == 'custom') {
+                        $customPosition = $forProductPage ? $rule->getData('pp_custom_position') : $rule->getData('custom_position');
+                        $productLabels[$position][$customPosition][] = $rule->getLabelData($forProductPage);
+                    } else {
+                        $productLabels[$position][] = $rule->getLabelData($forProductPage);
+                    }
                 }
 
                 if ($rule->getDiscardSubsequentRules()) {
diff --git a/Model/Parser/Html.php b/Model/Parser/Html.php
@@ -9,17 +9,20 @@
 namespace Magefan\ProductLabel\Model\Parser;
 
 use Magefan\ProductLabel\Model\GetLabels;
+use Magefan\ProductLabel\Model\Config;
 
 class Html
 {
     const COMMENT_PREFIX = '<!--mf_product_label_comment_';
     const COMMENT_PREFIX_GALLERY = '<!--mf_product_label_gallery_comment_';
     const COMMENT_SUFFIX = '-->';
 
+
     /**
      * @var GetLabels
      */
     protected $getLabels;
+    protected $mapProductToCustomPosition = [];
 
     public function __construct(
         GetLabels $getLabels
@@ -35,8 +38,8 @@ public function __construct(
     public function execute(string $output): string
     {
         $isOutputIsJson = $this->json_validate($output);
-
         $productIds = $this->getProductIds($output);
+
         $currentPageProductId = $this->getCurrentPageProductId($output);
         $productIdsForProductPage = [];
 
@@ -50,6 +53,9 @@ public function execute(string $output): string
         foreach ($replaceMap as $productId => $replace) {
             $replace = $isOutputIsJson ? trim(json_encode($replace),'"') : $replace;
 
+            // should be above regular replace
+            $this->replaceForCustomPosition($output, $replace, $productId);
+
             $output = ($currentPageProductId && $currentPageProductId == $productId)
                 ? str_replace(self::COMMENT_PREFIX_GALLERY . $productId . self::COMMENT_SUFFIX, $replace, $output)
                 : str_replace(self::COMMENT_PREFIX         . $productId . self::COMMENT_SUFFIX, $replace, $output);
@@ -58,6 +64,36 @@ public function execute(string $output): string
         return $output;
     }
 
+    /**
+     * @param string $output
+     * @param string $replace
+     * @param $productId
+     * @return void
+     */
+    private function replaceForCustomPosition(string &$output, string &$replace, $productId)
+    {
+        $customPositions = $this->mapProductToCustomPosition[$productId] ?? [];
+
+        if (strpos($replace, Config::SPLITTERS_FOR_CUSTOM_POSITIONS) !== false) {
+            if ($customPositions) {
+                $customPositionsLabels = explode(Config::SPLITTERS_FOR_CUSTOM_POSITIONS, $replace);
+                $replace = $customPositionsLabels[0];
+                unset($customPositionsLabels[0]);
+
+                foreach ($customPositionsLabels as $label) {
+                    foreach ($customPositions as $customPosition) {
+                        if (strpos($label, $customPosition) !== false) {
+                            $output = str_replace(self::COMMENT_PREFIX . $productId . '____' . $customPosition .  self::COMMENT_SUFFIX, $label, $output);
+                        }
+                    }
+                }
+            } else {
+                // leave only labels with regular positions
+                $replace = explode(Config::SPLITTERS_FOR_CUSTOM_POSITIONS, $replace);
+                $replace = $replace[0];
+            }
+        }
+    }
 
     /**
      * @param string $html
@@ -68,7 +104,6 @@ private function getCurrentPageProductId(string $html): int
         $pattern = '/' . self::COMMENT_PREFIX_GALLERY . '(.*?)' . self::COMMENT_SUFFIX . '/';
         preg_match_all($pattern, $html, $matches);
 
-
         foreach ($matches[1] as $commentData) {
             $productId = (int)$commentData;
 
@@ -91,9 +126,18 @@ private function getProductIds(string $html): array
         $productIds = [];
 
         foreach ($matches[1] as $commentData) {
-            $productId = (int)$commentData; //for now commentData=productId
+            /* $commentData = '3____product_list' | '3'*/
+
+            if (is_numeric($commentData)) {
+                $productId = (int)$commentData;
+            } else {
+                [$productId, $customPositionName] = explode('____', $commentData);
+                $productId = (int)$productId;
+                $this->mapProductToCustomPosition[$productId][$customPositionName] = $customPositionName;
+            }
+
             if ($productId) {
-                $productIds[] = $productId;
+                $productIds[$productId] = $productId;
             }
         }
 
diff --git a/Model/ProductLabelAction.php b/Model/ProductLabelAction.php
@@ -10,7 +10,7 @@
 
 use Magefan\ProductLabel\Model\ResourceModel\Rule\CollectionFactory as RuleCollectionFactory;
 use Magefan\ProductLabel\Model\CacheManager;
-use Magento\Catalog\Model\ResourceModel\Product\CollectionFactory as ProductCollectionFactory;
+use Magefan\Community\Model\Magento\Product\CollectionOptimizedForSqlValidatorFactory as ProductCollectionFactory;
 use Magento\CatalogRule\Model\RuleFactory as CatalogRuleFactory;
 use Magento\Framework\App\ResourceConnection;
 use Magefan\Community\Model\Magento\Rule\Model\Condition\Sql\Builder as SqlBuilder;
diff --git a/etc/adminhtml/system.xml b/etc/adminhtml/system.xml
@@ -46,6 +46,15 @@
                     <source_model>Magefan\ProductLabel\Model\Config\Source\PageType</source_model>
                     <can_be_empty>1</can_be_empty>
                 </field>
+
+                <field id="custom_positions" showInDefault="1" showInStore="1" showInWebsite="1" sortOrder="70" translate="label" type="textarea" canRestore="1">
+                    <label>Custom Positions (Plus)</label>
+                    <frontend_model>Magefan\ProductLabel\Block\Adminhtml\System\Config\Form\DynamicRow</frontend_model>
+                    <backend_model>Magento\Config\Model\Config\Backend\Serialized\ArraySerialized</backend_model>
+                    <comment><![CDATA[
+                        These positions will be available in the rule, when you choose position "Custom". There you can select the position from this list.
+                        ]]></comment>
+                </field>
             </group>
         </section>
     </system>
diff --git a/etc/config.xml b/etc/config.xml
@@ -17,6 +17,15 @@
                 <pp_selector>.fotorama__stage__shaft</pp_selector>
                 <pl_selector>.product-image-wrapper</pl_selector>
                 <exclude_page_types></exclude_page_types>
+                <custom_positions>
+                    {
+                        "_1736868521129_129":{"position":"product_list_before_name"},
+                        "_1736868522601_601":{"position":"product_list_after_price"},
+                        "_1736868553357_357":{"position":"product_page_before_price"},
+                        "_1736868660176_176":{"position":"product_page_after_reviews"}
+                    }
+                </custom_positions>
+
             </general>
         </mfproductlabel>
 
diff --git a/view/adminhtml/templates/form/css.phtml b/view/adminhtml/templates/form/css.phtml
@@ -23,13 +23,19 @@
     body.use_the_same_label_for_product_page [data-index="product_page"] [data-index="container_image"],
     body.use_the_same_label_for_product_page [data-index="product_page"] [data-index="pp_label_type"],
     body.use_the_same_label_for_product_page [data-index="product_page"] [data-index="container_shape"],
-    body.use_the_same_label_for_product_page [data-index="product_page"] .html-preview
+    body.use_the_same_label_for_product_page [data-index="product_page"] .html-preview,
+    body.use_the_same_label_for_product_page [data-index="product_page"] [data-index="pp_custom_position"]
     {display: none !important;}
 </style>
 
 <style>
+    [data-index="custom_position"],
+    [data-index="pp_custom_position"],
     .custom_position_description {display: none;}
 
+    body[position="custom"] [data-index="custom_position"],
+    body[pp_position="custom"] [data-index="pp_custom_position"] {display: block;}
+
     body[position="custom"]  [data-index="position"] .custom_position_description,
     body[pp_position="custom"] [data-index="pp_position"] .custom_position_description {
         display: block;
diff --git a/view/adminhtml/ui_component/mfproductlabel_rule_form.xml b/view/adminhtml/ui_component/mfproductlabel_rule_form.xml
@@ -287,11 +287,11 @@
                             <![CDATA[
                                 <div class="custom_position_description">
                                     <p>To insert label in custom position need to add next string in your template:<br><br>
-                                        <code style="font-size: 12px"> &lt;?= '&lt;!--mf_product_label_comment_' . $product-&gt;getId() . '--&gt;' ?&gt;</code>
+                                        <code style="font-size: 12px"> &lt;?= '&lt;!--mf_product_label_comment_' . $product-&gt;getId() . '____your_position--&gt;' ?&gt;</code>
                                         <br>
                                         <br>
                                         <hr>
-                                        &lt;!--mf_product_label_comment_7--&gt;  &nbsp; (7 - product id)
+                                         &lt;!--mf_product_label_comment_7____product_list_after_price--&gt;  &nbsp; (7 - product id, product_list_after_price - selected position)
                                     </p>
                                 </div>
                             ]]>
@@ -460,11 +460,11 @@
                             <![CDATA[
                                 <div class="custom_position_description">
                                     <p>To insert label in custom position need to add next string in your template:<br><br>
-                                        <code style="font-size: 12px"> &lt;?= '&lt;!--mf_product_label_comment_' . $product-&gt;getId() . '--&gt;' ?&gt;</code>
+                                        <code style="font-size: 12px"> &lt;?= '&lt;!--mf_product_label_comment_' . $product-&gt;getId() . '____your_position--&gt;' ?&gt;</code>
                                         <br>
                                         <br>
                                         <hr>
-                                        &lt;!--mf_product_label_comment_7--&gt;  &nbsp; (7 - product id)
+                                        &lt;!--mf_product_label_comment_7____product_list_after_price--&gt;  &nbsp; (7 - product id, product_list_after_price - selected position)
                                     </p>
                                 </div>
                             ]]>
