Add highlight methods to search and search builder (#348)

Author: alexander-schranz

packages/seal/src/Search/Search.php

@@ -20,13 +20,17 @@ final class Search
     /**
      * @param object[] $filters
      * @param array<string, 'asc'|'desc'> $sortBys
+     * @param array<string> $highlightFields
      */
     public function __construct(
         public readonly Index $index,
         public readonly array $filters = [],
         public readonly array $sortBys = [],
         public readonly int|null $limit = null,
         public readonly int $offset = 0,
+        public readonly array $highlightFields = [],
+        public readonly string $highlightPreTag = '<mark>',
+        public readonly string $highlightPostTag = '</mark>',
     ) {
     }
 }

packages/seal/src/Search/SearchBuilder.php

@@ -35,6 +35,15 @@ final class SearchBuilder
 
     private int|null $limit = null;
 
+    /**
+     * @var array<string>
+     */
+    private array $highlightFields = [];
+
+    private string $highlightPreTag = '<mark>';
+
+    private string $highlightPostTag = '</mark>';
+
     public function __construct(
         readonly private Schema $schema,
         readonly private SearcherInterface $searcher,
@@ -79,6 +88,23 @@ public function offset(int $offset): static
         return $this;
     }
 
+    /**
+     * @param array<string> $fields
+     */
+    public function highlight(array $fields, string $preTag = '<mark>', string $postTag = '</mark>'): static
+    {
+        $this->highlightFields = $fields;
+        $this->highlightPreTag = $preTag;
+        $this->highlightPostTag = $postTag;
+
+        return $this;
+    }
+
+    public function getSearcher(): SearcherInterface
+    {
+        return $this->searcher;
+    }
+
     public function getSearch(): Search
     {
         return new Search(
@@ -87,6 +113,9 @@ public function getSearch(): Search
             $this->sortBys,
             $this->limit,
             $this->offset,
+            $this->highlightFields,
+            $this->highlightPreTag,
+            $this->highlightPostTag,
         );
     }
 

packages/seal/src/Testing/AbstractSearcherTestCase.php

@@ -131,6 +131,72 @@ public function testSearchCondition(): void
         }
     }
 
+    public function testSearchConditionWithHighlight(): void
+    {
+        $documents = TestingHelper::createComplexFixtures();
+
+        $schema = self::getSchema();
+
+        foreach ($documents as $document) {
+            self::$taskHelper->tasks[] = self::$indexer->save(
+                $schema->indexes[TestingHelper::INDEX_COMPLEX],
+                $document,
+                ['return_slow_promise_result' => true],
+            );
+        }
+        self::$taskHelper->waitForAll();
+
+        $search = new SearchBuilder($schema, self::$searcher);
+        $search->index(TestingHelper::INDEX_COMPLEX);
+        $search->addFilter(new Condition\SearchCondition('Blog'));
+        $search->highlight(['title'], '<mark>', '</mark>');
+
+        $expectedDocumentA = $documents[0];
+        $expectedDocumentA['_formatted']['title'] = \str_replace(
+            'Blog',
+            '<mark>Blog</mark>',
+            $expectedDocumentA['title'] ?? '',
+        );
+        $expectedDocumentB = $documents[1];
+        $expectedDocumentB['_formatted']['title'] = \str_replace(
+            'Blog',
+            '<mark>Blog</mark>',
+            $expectedDocumentB['title'] ?? '',
+        );
+
+        $expectedDocumentsVariantA = [
+            $expectedDocumentA,
+            $expectedDocumentB,
+        ];
+        $expectedDocumentsVariantB = [
+            $expectedDocumentB,
+            $expectedDocumentA,
+        ];
+
+        $loadedDocuments = [...$search->getResult()];
+        $this->assertCount(2, $loadedDocuments);
+
+        $this->assertTrue(
+            $expectedDocumentsVariantA === $loadedDocuments
+            || $expectedDocumentsVariantB === $loadedDocuments,
+            'Not correct documents where found.',
+        );
+
+        $search = new SearchBuilder($schema, self::$searcher);
+        $search->index(TestingHelper::INDEX_COMPLEX);
+        $search->addFilter(new Condition\SearchCondition('Thing'));
+
+        $this->assertSame([$documents[2]], [...$search->getResult()]);
+
+        foreach ($documents as $document) {
+            self::$taskHelper->tasks[] = self::$indexer->delete(
+                $schema->indexes[TestingHelper::INDEX_COMPLEX],
+                $document['uuid'],
+                ['return_slow_promise_result' => true],
+            );
+        }
+    }
+
     public function testNoneSearchableFields(): void
     {
         $documents = TestingHelper::createComplexFixtures();