[Improvement]: Distinguish relation conditions applied as preconditions

doc/03_Installation/01_Upgrade_Notes.md

@@ -1,4 +1,6 @@
 # Upgrade Notes
+#### v2.1.0
+Added the possibility to distinguish relations conditions applied as preconditions.
 
 #### v2.0.0
 Added `bool` as possible type to `$condition` parameter of `addCondition` function in `ProductListInterface` (and all implementing classes).
@@ -8,4 +10,4 @@ Added `bool` as possible type to `$condition` parameter of `addCondition` functi
   please check if custom CSS/JS code added by `pimcore_head_script` and `pimcore_head_link` is still working. 
 
 #### v2.0.0
-- `AbstractOfferToolProduct` now only accepts int as the `$id` parameter.
+- `AbstractOfferToolProduct` now only accepts int as the `$id` parameter.

src/FilterService/FilterType/AbstractFilterType.php

@@ -26,6 +26,8 @@ abstract class AbstractFilterType
 {
     const EMPTY_STRING = '$$EMPTY$$';
 
+    public const PREFIX_PRECONDITION = 'PRECONDITION_';
+
     protected TranslatorInterface $translator;
 
     protected EngineInterface $templatingEngine;
@@ -68,6 +70,11 @@ protected function getField(AbstractFilterDefinitionType $filterDefinition): str
         return $field;
     }
 
+    protected function getConditionField(string $field, bool $isPrecondition): string
+    {
+        return $isPrecondition ? self::PREFIX_PRECONDITION . $field : $field;
+    }
+
     protected function getTemplate(AbstractFilterDefinitionType $filterDefinition): ?string
     {
         $template = $this->template;

src/FilterService/FilterType/Findologic/MultiSelectRelation.php

@@ -121,7 +121,7 @@ public function addCondition(AbstractFilterDefinitionType $filterDefinition, Pro
         $currentFilter[$field] = $value;
 
         if (!empty($value)) {
-            $productList->addRelationCondition($field, $value);
+            $productList->addRelationCondition($this->getConditionField($field, $isPrecondition), $value);
         }
 
         return $currentFilter;

src/FilterService/FilterType/Findologic/NumberRange.php

@@ -100,7 +100,7 @@ public function addCondition(AbstractFilterDefinitionType $filterDefinition, Pro
             } else {
                 $v['max'] = 9999999999999999;       // findologic won't accept only one of max or min, always needs both
             }
-            $productList->addCondition($v, $field);
+            $productList->addCondition($v, $this->getConditionField($field, $isPrecondition));
         }
 
         return $currentFilter;

src/FilterService/FilterType/Findologic/NumberRangeSelection.php

@@ -123,7 +123,7 @@ public function addCondition(AbstractFilterDefinitionType $filterDefinition, Pro
             } else {
                 $v['max'] = 9999999999999999;       // findologic won't accept only one of max or min, always needs both
             }
-            $productList->addCondition($v, $field);
+            $productList->addCondition($v, $this->getConditionField($field, $isPrecondition));
         }
 
         return $currentFilter;

src/FilterService/FilterType/Findologic/Select.php

@@ -47,7 +47,7 @@ public function addCondition(AbstractFilterDefinitionType $filterDefinition, Pro
         $currentFilter[$field] = $value;
 
         if (!empty($value)) {
-            $productList->addCondition([$value], $field);
+            $productList->addCondition([$value], $this->getConditionField($field, $isPrecondition));
         }
 
         return $currentFilter;

src/FilterService/FilterType/Findologic/SelectRelation.php

@@ -86,7 +86,7 @@ public function addCondition(AbstractFilterDefinitionType $filterDefinition, Pro
         $currentFilter[$field] = $value;
 
         if (!empty($value)) {
-            $productList->addCondition([$value], $field);
+            $productList->addCondition([$value], $this->getConditionField($field, $isPrecondition));
         }
 
         return $currentFilter;

src/FilterService/FilterType/Input.php

@@ -51,11 +51,10 @@ public function addCondition(AbstractFilterDefinitionType $filterDefinition, Pro
 
         if (!empty($value)) {
             $db = Db::get();
-            if ($isPrecondition) {
-                $productList->addCondition('TRIM(`' . $field . '`) LIKE ' . $db->quote('%' . $value . '%'), 'PRECONDITION_' . $field);
-            } else {
-                $productList->addCondition('TRIM(`' . $field . '`) LIKE ' . $db->quote('%' . $value . '%'), $field);
-            }
+            $productList->addCondition(
+                'TRIM(`' . $field . '`) LIKE ' . $db->quote('%' . $value . '%'),
+                $this->getConditionField($field, $isPrecondition)
+            );
         }
 
         return $currentFilter;

src/FilterService/FilterType/MultiSelect.php

@@ -81,18 +81,16 @@ public function addCondition(AbstractFilterDefinitionType $filterDefinition, Pro
 
                 if ($filterDefinition->getUseAndCondition()) {
                     foreach ($quotedValues as $value) {
-                        if ($isPrecondition) {
-                            $productList->addCondition($field . ' = ' . $value, 'PRECONDITION_' . $field);
-                        } else {
-                            $productList->addCondition($field . ' = ' . $value, $field);
-                        }
+                        $productList->addCondition(
+                            $field . ' = ' . $value,
+                            $this->getConditionField($field, $isPrecondition)
+                        );
                     }
                 } else {
-                    if ($isPrecondition) {
-                        $productList->addCondition($field . ' IN (' . implode(',', $quotedValues) . ')', 'PRECONDITION_' . $field);
-                    } else {
-                        $productList->addCondition($field . ' IN (' . implode(',', $quotedValues) . ')', $field);
-                    }
+                    $productList->addCondition(
+                        $field . ' IN (' . implode(',', $quotedValues) . ')',
+                        $this->getConditionField($field, $isPrecondition)
+                    );
                 }
             }
         }

src/FilterService/FilterType/MultiSelectCategory.php

@@ -69,7 +69,8 @@ public function getFilterValues(AbstractFilterDefinitionType $filterDefinition,
 
     public function addCondition(AbstractFilterDefinitionType $filterDefinition, ProductListInterface $productList, array $currentFilter, array $params, bool $isPrecondition = false): array
     {
-        $value = $params[$filterDefinition->getField()] ?? null;
+        $field = $this->getField($filterDefinition);
+        $value = $params[$field] ?? null;
         $isReload = $params['is_reload'] ?? null;
 
         if ($value == AbstractFilterType::EMPTY_STRING) {
@@ -83,7 +84,7 @@ public function addCondition(AbstractFilterDefinitionType $filterDefinition, Pro
             $value = $preSelect;
         }
 
-        $currentFilter[$filterDefinition->getField()] = $value;
+        $currentFilter[$field] = $value;
 
         $conditions = [];
         if (!empty($value)) {
@@ -95,7 +96,7 @@ public function addCondition(AbstractFilterDefinitionType $filterDefinition, Pro
 
                 $category = '%,' . trim((string)$category) . ',%';
 
-                $conditions[] = $filterDefinition->getField() . ' LIKE ' . $db->quote($category);
+                $conditions[] = $field . ' LIKE ' . $db->quote($category);
             }
         }
 
@@ -111,11 +112,7 @@ public function addCondition(AbstractFilterDefinitionType $filterDefinition, Pro
                 $conditions = '(' . implode(' OR ', $conditions) . ')';
             }
 
-            if ($isPrecondition) {
-                $productList->addCondition($conditions, 'PRECONDITION_' . $filterDefinition->getField());
-            } else {
-                $productList->addCondition($conditions, $filterDefinition->getField());
-            }
+            $productList->addCondition($conditions, $this->getConditionField($field, $isPrecondition));
         }
 
         return $currentFilter;

src/FilterService/FilterType/MultiSelectFromMultiSelect.php

@@ -115,11 +115,7 @@ public function addCondition(AbstractFilterDefinitionType $filterDefinition, Pro
             }
             $quotedValues = '('.$quotedValues.')';
 
-            if ($isPrecondition) {
-                $productList->addCondition($quotedValues, 'PRECONDITION_' . $field);
-            } else {
-                $productList->addCondition($quotedValues, $field);
-            }
+            $productList->addCondition($quotedValues, $this->getConditionField($field, $isPrecondition));
         }
 
         return $currentFilter;

src/FilterService/FilterType/MultiSelectRelation.php

@@ -124,10 +124,16 @@ public function addCondition(AbstractFilterDefinitionType $filterDefinition, Pro
             if (!empty($quotedValues)) {
                 if ($filterDefinition->getUseAndCondition()) {
                     foreach ($quotedValues as $value) {
-                        $productList->addRelationCondition($field, 'dest = ' . $value);
+                        $productList->addRelationCondition(
+                            $this->getConditionField($field, $isPrecondition),
+                            'dest = ' . $value
+                        );
                     }
                 } else {
-                    $productList->addRelationCondition($field, 'dest IN (' . implode(',', $quotedValues) . ')');
+                    $productList->addRelationCondition(
+                        $this->getConditionField($field, $isPrecondition),
+                        'dest IN (' . implode(',', $quotedValues) . ')'
+                    );
                 }
             }
         }

src/FilterService/FilterType/NumberRange.php

@@ -47,19 +47,20 @@ public function addCondition(AbstractFilterDefinitionType $filterDefinition, Pro
 
         $db = Db::get();
 
-        if (!empty($value['from'])) {
-            if ($isPrecondition) {
-                $productList->addCondition($this->getField($filterDefinition) . ' >= ' . $db->quote($value['from']), 'PRECONDITION_' . $this->getField($filterDefinition));
-            } elseif ($value['from'] != AbstractFilterType::EMPTY_STRING) {
-                $productList->addCondition($this->getField($filterDefinition) . ' >= ' . $db->quote($value['from']), $this->getField($filterDefinition));
-            }
+        $from = $value['from'] ?? null;
+        $to = $value['to'] ?? null;
+
+        if ($from && $from !== AbstractFilterType::EMPTY_STRING) {
+            $productList->addCondition(
+                $field . ' >= ' . $db->quote((string)$from),
+                $this->getConditionField($field, $isPrecondition)
+            );
         }
-        if (!empty($value['to'])) {
-            if ($isPrecondition) {
-                $productList->addCondition($this->getField($filterDefinition) . ' <= ' . $db->quote($value['to']), 'PRECONDITION_' . $this->getField($filterDefinition));
-            } elseif ($value['to'] != AbstractFilterType::EMPTY_STRING) {
-                $productList->addCondition($this->getField($filterDefinition) . ' <= ' . $db->quote($value['to']), $this->getField($filterDefinition));
-            }
+        if ($to && $to !== AbstractFilterType::EMPTY_STRING) {
+            $productList->addCondition(
+                $field . ' <= ' . $db->quote((string)$to),
+                $this->getConditionField($field, $isPrecondition)
+            );
         }
 
         return $currentFilter;

src/FilterService/FilterType/NumberRangeSelection.php

@@ -122,18 +122,16 @@ public function addCondition(AbstractFilterDefinitionType $filterDefinition, Pro
 
         if (!empty($value)) {
             if (!empty($value['from'])) {
-                if ($isPrecondition) {
-                    $productList->addCondition($field . ' >= ' . $db->quote($value['from']), 'PRECONDITION_' . $field);
-                } else {
-                    $productList->addCondition($field . ' >= ' . $db->quote($value['from']), $field);
-                }
+                $productList->addCondition(
+                    $field . ' >= ' . $db->quote((string)$value['from']),
+                    $this->getConditionField($field, $isPrecondition)
+                );
             }
             if (!empty($value['to'])) {
-                if ($isPrecondition) {
-                    $productList->addCondition($field . ' <= ' . $db->quote($value['to']), 'PRECONDITION_' . $field);
-                } else {
-                    $productList->addCondition($field . ' < ' . $db->quote($value['to']), $field);
-                }
+                $productList->addCondition(
+                    $field . ' < ' . $db->quote((string)$value['to']),
+                    $this->getConditionField($field, $isPrecondition)
+                );
             }
         }
 

src/FilterService/FilterType/SearchIndex/Input.php

@@ -47,7 +47,10 @@ public function addCondition(AbstractFilterDefinitionType $filterDefinition, Pro
 
         if (!empty($value)) {
             $value = '.*"' . $value .  '".*';
-            $productList->addCondition(['regexp' => ['attributes.' . $field => $value]], $field);
+            $productList->addCondition(
+                ['regexp' => ['attributes.' . $field => $value]],
+                $this->getConditionField($field, $isPrecondition)
+            );
         }
 
         return $currentFilter;

src/FilterService/FilterType/SearchIndex/MultiSelect.php

@@ -83,10 +83,13 @@ public function addCondition(AbstractFilterDefinitionType $filterDefinition, Pro
             if (!empty($quotedValues)) {
                 if ($filterDefinition->getUseAndCondition()) {
                     foreach ($quotedValues as $value) {
-                        $productList->addCondition($value, $field);
+                        $productList->addCondition($value, $this->getConditionField($field, $isPrecondition));
                     }
                 } else {
-                    $productList->addCondition(['terms' => ['attributes.' . $field => $quotedValues]], $field);
+                    $productList->addCondition(
+                        ['terms' => ['attributes.' . $field => $quotedValues]],
+                        $this->getConditionField($field, $isPrecondition)
+                    );
                 }
             }
         }

src/FilterService/FilterType/SearchIndex/MultiSelectFromMultiSelect.php

@@ -72,15 +72,21 @@ public function addCondition(AbstractFilterDefinitionType $filterDefinition, Pro
 
             if ($filterDefinition->getUseAndCondition()) {
                 foreach ($value as $entry) {
-                    $productList->addCondition(['term' => ['attributes.' . $field => $entry]], $field);
+                    $productList->addCondition(
+                        ['term' => ['attributes.' . $field => $entry]],
+                        $this->getConditionField($field, $isPrecondition)
+                    );
                 }
             } else {
                 $boolArray = [];
                 foreach ($value as $entry) {
                     $boolArray[] = ['term' => ['attributes.' . $field => $entry]];
                 }
 
-                $productList->addCondition(['bool' => ['should' => $boolArray, 'minimum_should_match' => 1]], $field);
+                $productList->addCondition(
+                    ['bool' => ['should' => $boolArray, 'minimum_should_match' => 1]],
+                    $this->getConditionField($field, $isPrecondition)
+                );
             }
         }
 

src/FilterService/FilterType/SearchIndex/MultiSelectRelation.php

@@ -75,10 +75,13 @@ public function addCondition(AbstractFilterDefinitionType $filterDefinition, Pro
             if (!empty($quotedValues)) {
                 if ($filterDefinition->getUseAndCondition()) {
                     foreach ($quotedValues as $value) {
-                        $productList->addRelationCondition($field, $value);
+                        $productList->addRelationCondition($this->getConditionField($field, $isPrecondition), $value);
                     }
                 } else {
-                    $productList->addRelationCondition($field, ['terms' => ['relations.' . $field => $quotedValues]]);
+                    $productList->addRelationCondition(
+                        $this->getConditionField($field, $isPrecondition),
+                        ['terms' => ['relations.' . $field => $quotedValues]]
+                    );
                 }
             }
         }

src/FilterService/FilterType/SearchIndex/NumberRange.php

@@ -48,7 +48,10 @@ public function addCondition(AbstractFilterDefinitionType $filterDefinition, Pro
             if (strlen($value['to']) > 0) {
                 $range['lte'] = $value['to'];
             }
-            $productList->addCondition(['range' => ['attributes.' . $field => $range]], $field);
+            $productList->addCondition(
+                ['range' => ['attributes.' . $field => $range]],
+                $this->getConditionField($field, $isPrecondition),
+            );
         }
 
         return $currentFilter;

src/FilterService/FilterType/SearchIndex/NumberRangeSelection.php

@@ -55,7 +55,10 @@ public function addCondition(AbstractFilterDefinitionType $filterDefinition, Pro
             if (!empty($value['to'])) {
                 $range['lte'] = $value['to'];
             }
-            $productList->addCondition(['range' => ['attributes.' . $field => $range]], $field);
+            $productList->addCondition(
+                ['range' => ['attributes.' . $field => $range]],
+                $this->getConditionField($field, $isPrecondition)
+            );
         }
 
         return $currentFilter;

src/FilterService/FilterType/SearchIndex/Select.php

@@ -42,7 +42,7 @@ public function addCondition(AbstractFilterDefinitionType $filterDefinition, Pro
         $currentFilter[$field] = $value;
 
         if (!empty($value)) {
-            $productList->addCondition(trim($value), $field);
+            $productList->addCondition(trim($value), $this->getConditionField($field, $isPrecondition));
         }
 
         return $currentFilter;

src/FilterService/FilterType/SearchIndex/SelectCategory.php

@@ -55,7 +55,8 @@ public function getFilterValues(AbstractFilterDefinitionType $filterDefinition,
 
     public function addCondition(AbstractFilterDefinitionType $filterDefinition, ProductListInterface $productList, array $currentFilter, array $params, bool $isPrecondition = false): array
     {
-        $value = $params[$filterDefinition->getField()] ?? null;
+        $field = $this->getField($filterDefinition);
+        $value = $params[$field] ?? null;
         $isReload = $params['is_reload'] ?? null;
 
         if ($value == AbstractFilterType::EMPTY_STRING) {
@@ -67,11 +68,11 @@ public function addCondition(AbstractFilterDefinitionType $filterDefinition, Pro
             }
         }
 
-        $currentFilter[$filterDefinition->getField()] = $value;
+        $currentFilter[$field] = $value;
 
         if (!empty($value)) {
             $value = trim((string)$value);
-            $productList->addCondition($value, $filterDefinition->getField());
+            $productList->addCondition($value, $this->getConditionField($field, $isPrecondition));
         }
 
         return $currentFilter;

src/FilterService/FilterType/SearchIndex/SelectClassificationStoreAttributes.php

@@ -133,7 +133,7 @@ public function addCondition(AbstractFilterDefinitionType $filterDefinition, Pro
                     $currentFilter[$field][$keyId] = $filterValue;
 
                     $valueField = $nestedPath . '.' . $keyId . '.keyword';
-                    $productList->addCondition($filterValue, $valueField);
+                    $productList->addCondition($filterValue, $this->getConditionField($valueField, $isPrecondition));
                 }
             }
         }