SearchEditor: Enhance to configure user-defined condition metadata

Completer.js: Unset values of suggestion-based fields on manual input

Author: sukhwinder33445

asset/js/widget/Completer.js

@@ -730,6 +730,10 @@ define(["../notjQuery"], function ($) {
                 dataElement.value = input.value;
             }
 
+            input.form.querySelectorAll(
+                `input[type="hidden"][name^="${input.name}-"]:not([name$="search"])`
+            ).forEach(i => i.value = '');
+
             let [value, data] = this.prepareCompletionData(input);
             this.completedInput = input;
             this.completedValue = value;

src/Control/SearchEditor.php

@@ -2,6 +2,7 @@
 
 namespace ipl\Web\Control;
 
+use Icinga\Exception\ConfigurationError;
 use ipl\Html\Attributes;
 use ipl\Html\Form;
 use ipl\Html\FormDecorator\CallbackDecorator;
@@ -55,6 +56,9 @@ class SearchEditor extends Form
     /** @var bool */
     protected $cleared = false;
 
+    /** @var string[] Additional `metadata` fields for the condition */
+    protected array $metadataFields = [];
+
     /**
      * Set the filter query string to populate the form with
      *
@@ -95,6 +99,26 @@ public function setSuggestionUrl(Url $url)
         return $this;
     }
 
+    /**
+     * Set additional `metadata` fields for the condition
+     *
+     * The value of these fields is populated to condition's `metadata`
+     *
+     * @param array $fields
+     *
+     * @return $this
+     */
+    public function setMetadataFields(array $fields): static
+    {
+        if (in_array('search', $fields, true)) {
+            throw new ConfigurationError("'search' is a reserved keyword and cannot be used as a metadata field");
+        }
+
+        $this->metadataFields = $fields;
+
+        return $this;
+    }
+
     /**
      * Get the query string parser being used
      *
@@ -195,6 +219,10 @@ protected function applyChanges(Filter\Rule $rule, array &$values, array $path =
             } else {
                 // Make sure we don't forget to present the column labels again
                 $rule->metaData()->set('columnLabel', $this->popKey($values, $identifier . '-column'));
+
+                foreach ($this->metadataFields as $fieldName) {
+                    $rule->metaData()->set($fieldName, $this->popKey($values, $identifier . '-column-' . $fieldName));
+                }
             }
 
             if ($newColumn !== null && $rule->getColumn() !== $newColumn) {
@@ -551,6 +579,16 @@ protected function createCondition(Filter\Condition $condition, $identifier)
             }]
         ]);
 
+        $metadataFields = new HtmlDocument();
+        foreach ($this->metadataFields as $fieldNameSuffix) {
+            $columnMetaInput = $this->createElement('hidden', $identifier . '-column-' . $fieldNameSuffix, [
+                'value' => $condition->metaData()->get($fieldNameSuffix)
+            ]);
+            $this->registerElement($columnMetaInput);
+
+            $metadataFields->addHtml($columnMetaInput);
+        }
+
         $operatorInput = $this->createElement('select', $identifier . '-operator', [
             'options'   => [
                 '~'     => '~',
@@ -588,6 +626,7 @@ protected function createCondition(Filter\Condition $condition, $identifier)
             $columnInput,
             $columnFakeInput,
             $columnSearchInput,
+            $metadataFields,
             $operatorInput,
             $valueInput
         );