FEATURE: Extended highlight configuration

Previously you only could define the highlighting for all fields
and no_match_size was automatically active. Now teh parameters can be configured
individually by field.

Author: daniellienert

Classes/Driver/AbstractQuery.php

@@ -180,22 +180,19 @@ public function suggestions(string $name, array $suggestionDefinition): void
     /**
      * {@inheritdoc}
      */
-    public function highlight($fragmentSize, int $fragmentCount = null): void
+    public function highlight($fragmentSize, int $fragmentCount = null, int $noMatchSize = 150, string $field = 'neos_fulltext.*'): void
     {
         if ($fragmentSize === false) {
             // Highlighting is disabled.
             unset($this->request['highlight']);
-        } else {
-            $this->request['highlight'] = [
-                'fields' => [
-                    'neos_fulltext*' => [
-                        'fragment_size' => $fragmentSize,
-                        'no_match_size' => $fragmentSize,
-                        'number_of_fragments' => $fragmentCount
-                    ]
-                ]
-            ];
+            return;
         }
+
+        $this->request['highlight']['fields'][$field] = [
+            'fragment_size' => $fragmentSize,
+            'no_match_size' => $noMatchSize,
+            'number_of_fragments' => $fragmentCount
+        ];
     }
 
     /**

Classes/Driver/QueryInterface.php

@@ -86,11 +86,13 @@ public function fulltext(string $searchWord, array $options = []): void;
      * It can be disabled by calling "highlight(FALSE)".
      *
      * @param integer|boolean $fragmentSize The result fragment size for highlight snippets. If this parameter is FALSE, highlighting will be disabled.
-     * @param integer $fragmentCount The number of highlight fragments to show.
+     * @param int|null $fragmentCount The number of highlight fragments to show.
+     * @param int $noMatchSize
+     * @param string $field
      * @return void
      * @api
      */
-    public function highlight($fragmentSize, int $fragmentCount = null): void;
+    public function highlight($fragmentSize, int $fragmentCount = null, int $noMatchSize = 150, string $field = 'neos_fulltext.*'): void;
 
     /**
      * This method is used to create any kind of aggregation.

Classes/Eel/ElasticSearchQueryBuilder.php

@@ -730,14 +730,16 @@ public function geoDistance(string $propertyName, $geoPoint, string $distance, s
      * Configure Result Highlighting. Only makes sense in combination with fulltext(). By default, highlighting is enabled.
      * It can be disabled by calling "highlight(FALSE)".
      *
-     * @param integer|boolean $fragmentSize The result fragment size for highlight snippets. If this parameter is FALSE, highlighting will be disabled.
-     * @param integer $fragmentCount The number of highlight fragments to show.
+     * @param int|bool $fragmentSize The result fragment size for highlight snippets. If this parameter is FALSE, highlighting will be disabled.
+     * @param int|null $fragmentCount The number of highlight fragments to show.
+     * @param int $noMatchSize
+     * @param string $field
      * @return ElasticSearchQueryBuilder
      * @api
      */
-    public function highlight($fragmentSize, int $fragmentCount = null): ElasticSearchQueryBuilder
+    public function highlight($fragmentSize, int $fragmentCount = null, int $noMatchSize = 150, string $field = 'neos_fulltext.*'): ElasticSearchQueryBuilder
     {
-        $this->request->highlight($fragmentSize, $fragmentCount);
+        $this->request->highlight($fragmentSize, $fragmentCount, $noMatchSize, $field);
 
         return $this;
     }