Add filter to retrieve only the exactly matched columns

Author: raviks789

library/Icingadb/Web/Control/SearchBar/ObjectSuggestions.php

@@ -221,13 +221,14 @@ protected function fetchColumnSuggestions($searchTerm)
         $model = $this->getModel();
         $query = $model::on($this->getDb());
 
-        // Collect custom variables
         $parsedArrayVars = [];
-        $varSuggestions = [];
         $exactSearchTerm = trim($searchTerm, ' *');
+        $exactVarMatches = [];
         $titleAdded = false;
+
+        // Suggest exact custom variable matches first
         if ($exactSearchTerm !== '') {
-            foreach ($this->getDb()->select($this->queryCustomvarConfig($searchTerm)) as $customVar) {
+            foreach ($this->getDb()->select($this->queryCustomvarConfig($exactSearchTerm, true)) as $customVar) {
                 $search = $name = $customVar->flatname;
                 if (preg_match('/\w+(?:\[(\d*)])+$/', $search, $matches)) {
                     $name = substr($search, 0, -(strlen($matches[1]) + 2));
@@ -242,23 +243,19 @@ protected function fetchColumnSuggestions($searchTerm)
                 foreach ($this->customVarSources as $relation => $label) {
                     if (isset($customVar->$relation)) {
                         $varRelation = $relation . '.vars.' . $search;
-                        $varLabel = sprintf($label, $name);
-                        // Suggest exact custom variable matches first
-                        if ($name === $exactSearchTerm) {
-                            if ($titleAdded === false) {
-                                $this->addHtml(HtmlElement::create(
-                                    'li',
-                                    ['class' => static::SUGGESTION_TITLE_CLASS],
-                                    t('Best Suggestions')
-                                ));
-
-                                $titleAdded = true;
-                            }
-
-                            yield $varRelation => $varLabel;
-                        } else {
-                            $varSuggestions[$varRelation] = $varLabel;
+                        if ($titleAdded === false) {
+                            $this->addHtml(HtmlElement::create(
+                                'li',
+                                ['class' => static::SUGGESTION_TITLE_CLASS],
+                                t('Best Suggestions')
+                            ));
+
+                            $titleAdded = true;
                         }
+
+                        $exactVarMatches[] = $varRelation;
+
+                        yield $varRelation => sprintf($label, $name);
                     }
                 }
             }
@@ -285,19 +282,40 @@ protected function fetchColumnSuggestions($searchTerm)
 
         // Finally, the other custom variable suggestions
         $titleAdded = false;
-        foreach ($varSuggestions as $relation => $label) {
-            if ($this->matchSuggestion($relation, $label, $searchTerm)) {
-                if ($titleAdded === false) {
-                    $this->addHtml(HtmlElement::create(
-                        'li',
-                        ['class' => static::SUGGESTION_TITLE_CLASS],
-                        t('Custom Variables')
-                    ));
-
-                    $titleAdded = true;
+        foreach ($this->getDb()->select($this->queryCustomvarConfig($searchTerm)) as $customVar) {
+            $search = $name = $customVar->flatname;
+            if (preg_match('/\w+(?:\[(\d*)])+$/', $search, $matches)) {
+                $name = substr($search, 0, -(strlen($matches[1]) + 2));
+                if (isset($parsedArrayVars[$name])) {
+                    continue;
                 }
 
-                yield $relation => $label;
+                $parsedArrayVars[$name] = true;
+                $search = $name . '[*]';
+            }
+
+            foreach ($this->customVarSources as $relation => $label) {
+                if (isset($customVar->$relation)) {
+                    $varRelation = $relation . '.vars.' . $search;
+                    $varLabel = sprintf($label, $name);
+                    // Suggest exact custom variable matches first
+                    if (
+                        ! in_array($varRelation, $exactVarMatches)
+                        && $this->matchSuggestion($varRelation, $varLabel, $searchTerm)
+                    ) {
+                        if ($titleAdded === false) {
+                            $this->addHtml(HtmlElement::create(
+                                'li',
+                                ['class' => static::SUGGESTION_TITLE_CLASS],
+                                t('Custom Variables')
+                            ));
+
+                            $titleAdded = true;
+                        }
+
+                        yield $varRelation => $varLabel;
+                    }
+                }
             }
         }
     }
@@ -317,10 +335,11 @@ protected function matchSuggestion($path, $label, $searchTerm)
      * Create a query to fetch all available custom variables matching the given term
      *
      * @param string $searchTerm
+     * @param bool $exactMatch
      *
      * @return Select
      */
-    protected function queryCustomvarConfig(string $searchTerm): Select
+    protected function queryCustomvarConfig(string $searchTerm, bool $exactMatch = false): Select
     {
         $customVars = CustomvarFlat::on($this->getDb());
         $tableName = $customVars->getModel()->getTableName();
@@ -346,7 +365,12 @@ protected function queryCustomvarConfig(string $searchTerm): Select
 
         $customVars->columns('flatname');
         $this->applyRestrictions($customVars);
-        $customVars->filter(Filter::like('flatname', $searchTerm));
+        if ($exactMatch) {
+            $customVars->filter(Filter::equal('flatname', $searchTerm));
+        } else {
+            $customVars->filter(Filter::like('flatname', $searchTerm));
+        }
+
         $idColumn = $resolver->qualifyColumn('id', $resolver->getAlias($customVars->getModel()));
         $customVars = $customVars->assembleSelect();