!!! TASK: Adjust the result of getSuggestions

Before the result of getSuggestions returned the suggestion of a search term if the term only consisted of one word. When the search term conisted of two words it returned the complete array. This is an absolutely unexpected behaviour. It was also only possible to acces the first defined suggest term.

This change now reurns the complete suggestion array, so it behaves like the comparable aggregation getter.

Author: daniellienert

Classes/Flowpack/ElasticSearch/ContentRepositoryAdaptor/Eel/ElasticSearchQueryBuilder.php

@@ -422,7 +422,7 @@ public function aggregation($name, array $aggregationDefinition, $parentPath = n
      *
      * nodes = ${Search....termSuggestions("aTerm")}
      *
-     * Access all suggestions data with {nodes.suggestions} in your fluid template
+     * Access all suggestions data with ${Search....getSuggestions()}
      *
      * @param string $text
      * @param string $field

Classes/Flowpack/ElasticSearch/ContentRepositoryAdaptor/Eel/ElasticSearchQueryResult.php

@@ -208,20 +208,32 @@ public function getAggregations()
     }
 
     /**
+     * Returns an array of type
+     * [
+     *     <suggestionName> => [
+     *         'text' => <term>
+     *         'options' => [
+     *              [
+     *               'text' => <suggestionText>
+     *               'score' => <score>
+     *              ],
+     *              [
+     *              ...
+     *              ]
+     *         ]
+     *     ]
+     * ]
+     *
      * @return array
      */
     public function getSuggestions()
     {
         $this->initialize();
-        if (count($this->result['suggest']) === 1) {
-            $suggestArray = current($this->result['suggest']);
-
-            if (count($suggestArray) === 1) {
-                return current($suggestArray);
-            }
+        if (array_key_exists('suggest', $this->result)) {
+            return $this->result['suggest'];
         }
 
-        return $this->result['suggest'];
+        return [];
     }
 
     /**

Tests/Functional/Eel/ElasticSearchQueryTest.php

@@ -213,19 +213,23 @@ public function fieldBasedAggregations()
      */
     public function termSuggestion()
     {
-        $titleSuggestionKey = "chickn";
+        $titleSuggestionKey = 'chickn';
 
         $result = $this->getQueryBuilder()
             ->log($this->getLogMessagePrefix(__METHOD__))
-            ->termSuggestions($titleSuggestionKey, "title")
+            ->termSuggestions($titleSuggestionKey, 'title')
             ->execute()
             ->getSuggestions();
 
-        $this->assertArrayHasKey("options", $result);
+        $this->assertArrayHasKey('suggestions', $result);
+        $this->assertTrue(is_array($result['suggestions']), 'Suggestions must be an array.');
+        $firstSuggestion = current($result['suggestions']);
 
-        $this->assertCount(1, $result['options']);
+        $this->assertArrayHasKey('options', $firstSuggestion);
 
-        $this->assertEquals('chicken', $result['options'][0]['text']);
+        $this->assertCount(1, $firstSuggestion['options']);
+
+        $this->assertEquals('chicken', $firstSuggestion['options'][0]['text']);
     }
 
     /**