SearchEditor: Store additional user defined condition meta-data

Author: sukhwinder33445

src/Control/SearchEditor.php

@@ -55,6 +55,9 @@ class SearchEditor extends Form
     /** @var bool */
     protected $cleared = false;
 
+    /** @var string[] The Condition's meta-data fields to add */
+    protected array $metaDataFields = [];
+
     /**
      * Set the filter query string to populate the form with
      *
@@ -95,6 +98,13 @@ public function setSuggestionUrl(Url $url)
         return $this;
     }
 
+    public function setMetaDataFields(array $fields): static
+    {
+        $this->metaDataFields = $fields;
+
+        return $this;
+    }
+
     /**
      * Get the query string parser being used
      *
@@ -551,6 +561,19 @@ protected function createCondition(Filter\Condition $condition, $identifier)
             }]
         ]);
 
+        $metaFields = new HtmlDocument();
+        foreach ($this->metaDataFields as $fieldNameSuffix) {
+            $name = $identifier . '-column-'. $fieldNameSuffix;
+            $columnMetaInput = $this->createElement('hidden', $name, [
+                'value' => $condition->metaData()->get($fieldNameSuffix)
+            ]);
+            $this->registerElement($columnMetaInput);
+
+            $condition->metaData()->set($fieldNameSuffix, $this->getPopulatedValue($name));
+
+            $metaFields->addHtml($columnMetaInput);
+        }
+
         $operatorInput = $this->createElement('select', $identifier . '-operator', [
             'options'   => [
                 '~'     => '~',
@@ -588,6 +611,7 @@ protected function createCondition(Filter\Condition $condition, $identifier)
             $columnInput,
             $columnFakeInput,
             $columnSearchInput,
+            $metaFields,
             $operatorInput,
             $valueInput
         );