Interface changes for SearchService & Suggestions. Support spelling suggestions (#21)

Author: chrispenny

.editorconfig

@@ -10,7 +10,7 @@ indent_style = space
 insert_final_newline = true
 trim_trailing_whitespace = true
 
-[{*.yml}]
+[*.yml]
 indent_size = 2
 indent_style = space
 

_config/adaptors.yml

@@ -0,0 +1,12 @@
+---
+Name: discoverer-adaptors
+---
+SilverStripe\Core\Injector\Injector:
+  SilverStripe\Discoverer\Service\Interfaces\ProcessAnalyticsAdaptor:
+    class: SilverStripe\Discoverer\Service\Adaptors\ProcessAnalyticsAdaptor
+  SilverStripe\Discoverer\Service\Interfaces\QuerySuggestionAdaptor:
+    class: SilverStripe\Discoverer\Service\Adaptors\QuerySuggestionAdaptor
+  SilverStripe\Discoverer\Service\Interfaces\SearchAdaptor:
+    class: SilverStripe\Discoverer\Service\Adaptors\SearchAdaptor
+  SilverStripe\Discoverer\Service\Interfaces\SpellingSuggestionAdaptor:
+    class: SilverStripe\Discoverer\Service\Adaptors\SpellingSuggestionAdaptor

_config/analytics.yml

@@ -1,5 +1,5 @@
 ---
-Name: search-analytics
+Name: discoverer-analytics
 After:
   - requestprocessors
 Only:

src/Query/Suggestion.php

@@ -9,8 +9,12 @@ class Suggestion
 
     use Injectable;
 
-    public function __construct(private string $queryString, private ?int $limit = null, private array $fields = [])
-    {
+    public function __construct(
+        private string $queryString,
+        private ?int $limit = null,
+        private array $fields = [],
+        private bool $formatted = false
+    ) {
     }
 
     public function getQueryString(): string
@@ -54,4 +58,16 @@ public function addField(string $fieldName): self
         return $this;
     }
 
+    public function isFormatted(): bool
+    {
+        return $this->formatted;
+    }
+
+    public function setFormatted(bool $formatted): Suggestion
+    {
+        $this->formatted = $formatted;
+
+        return $this;
+    }
+
 }

src/Service/Adaptors/ProcessAnalyticsAdaptor.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace SilverStripe\Discoverer\Service\Adaptors;
+
+use BadMethodCallException;
+use SilverStripe\Discoverer\Analytics\AnalyticsData;
+use SilverStripe\Discoverer\Service\Interfaces\ProcessAnalyticsAdaptor as ProcessAnalyticsAdaptorInterface;
+
+class ProcessAnalyticsAdaptor implements ProcessAnalyticsAdaptorInterface
+{
+
+    public function process(AnalyticsData $analyticsData): void
+    {
+        throw new BadMethodCallException('Analytics adaptor has not been implemented');
+    }
+
+}

src/Service/Adaptors/QuerySuggestionAdaptor.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace SilverStripe\Discoverer\Service\Adaptors;
+
+use BadMethodCallException;
+use SilverStripe\Discoverer\Query\Suggestion;
+use SilverStripe\Discoverer\Service\Interfaces\QuerySuggestionAdaptor as QuerySuggestionAdaptorInterface;
+use SilverStripe\Discoverer\Service\Results\Suggestions;
+
+class QuerySuggestionAdaptor implements QuerySuggestionAdaptorInterface
+{
+
+    public function process(Suggestion $suggestion, string $indexName): Suggestions
+    {
+        throw new BadMethodCallException('Query suggestion adaptor has not been implemented');
+    }
+
+}

src/Service/Adaptors/SearchAdaptor.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace SilverStripe\Discoverer\Service\Adaptors;
+
+use BadMethodCallException;
+use SilverStripe\Discoverer\Query\Query;
+use SilverStripe\Discoverer\Service\Interfaces\SearchAdaptor as SearchAdaptorInterface;
+use SilverStripe\Discoverer\Service\Results\Results;
+
+class SearchAdaptor implements SearchAdaptorInterface
+{
+
+    public function process(Query $query, string $indexName): Results
+    {
+        throw new BadMethodCallException('Search adaptor has not been implemented');
+    }
+
+}

src/Service/Adaptors/SpellingSuggestionAdaptor.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace SilverStripe\Discoverer\Service\Adaptors;
+
+use BadMethodCallException;
+use SilverStripe\Discoverer\Query\Suggestion;
+use SilverStripe\Discoverer\Service\Interfaces\SpellingSuggestionAdaptor as SpellingSuggestionAdaptorInterface;
+use SilverStripe\Discoverer\Service\Results\Suggestions;
+
+class SpellingSuggestionAdaptor implements SpellingSuggestionAdaptorInterface
+{
+
+    public function process(Suggestion $suggestion, string $indexName): Suggestions
+    {
+        throw new BadMethodCallException('Spelling suggestion adaptor has not been implemented');
+    }
+
+}

src/Service/Interfaces/ProcessAnalyticsAdaptor.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace SilverStripe\Discoverer\Service\Interfaces;
+
+use SilverStripe\Discoverer\Analytics\AnalyticsData;
+
+interface ProcessAnalyticsAdaptor
+{
+
+    public function process(AnalyticsData $analyticsData): void;
+
+}

src/Service/Interfaces/QuerySuggestionAdaptor.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace SilverStripe\Discoverer\Service\Interfaces;
+
+use SilverStripe\Discoverer\Query\Suggestion;
+use SilverStripe\Discoverer\Service\Results\Suggestions;
+
+interface QuerySuggestionAdaptor
+{
+
+    public function process(Suggestion $suggestion, string $indexName): Suggestions;
+
+}