TASK: Clean up SuggestController, add docs

Author: kdambekalns

Classes/Flowpack/SearchPlugin/Controller/SuggestController.php

@@ -13,7 +13,6 @@
 
 use TYPO3\Flow\Annotations as Flow;
 use TYPO3\Flow\Mvc\Controller\ActionController;
-use TYPO3\TYPO3CR\Domain\Model\NodeInterface;
 
 /**
  * Class SuggestController
@@ -26,29 +25,6 @@ class SuggestController extends ActionController
      */
     protected $elasticSearchClient;
 
-    /**
-     * The node inside which searching should happen
-     *
-     * @var NodeInterface
-     */
-    protected $contextNode;
-
-    /**
-     * @Flow\Inject
-     * @var \Flowpack\ElasticSearch\ContentRepositoryAdaptor\LoggerInterface
-     */
-    protected $logger;
-
-    /**
-     * @var boolean
-     */
-    protected $logThisQuery = false;
-
-    /**
-     * @var string
-     */
-    protected $logMessage;
-
     /**
      * @var array
      */
@@ -57,11 +33,10 @@ class SuggestController extends ActionController
     ];
 
     /**
-     * @param NodeInterface $node
      * @param string $term
      * @return void
      */
-    public function indexAction(NodeInterface $node, $term)
+    public function indexAction($term)
     {
         $request = [
             'suggests' => [
@@ -72,7 +47,7 @@ public function indexAction(NodeInterface $node, $term)
             ]
         ];
 
-        $response = $this->elasticSearchClient->getIndex()->request('GET', '/_suggest', [], json_encode($request))->getTreatedContent();
+        $response = $this->elasticSearchClient->getIndex()->request('POST', '/_suggest', [], json_encode($request))->getTreatedContent();
         $suggestions = array_map(function ($option) {
             return $option['text'];
         }, $response['suggests'][0]['options']);

README.md

@@ -7,24 +7,32 @@ Flowpack.ElasticSearch.ContentRepositoryAdaptor or Flowpack.SimpleSearch.Content
 
 Make sure to include the Routes from this package into your main `Configuration/Routes.yaml` by the following snippet:
 
-```
--
-  name: 'Flowpack.SearchPlugin'
-  uriPattern: '<SearchSubroutes>'
-  subRoutes:
-    'SearchSubroutes':
-      package: 'Flowpack.SearchPlugin'
-```
+    -
+      name: 'Flowpack.SearchPlugin'
+      uriPattern: '<SearchSubroutes>'
+      subRoutes:
+        'SearchSubroutes':
+          package: 'Flowpack.SearchPlugin'
 
 ## Custom result rendering
 
 The result list is rendered using a TypoScript object of type `nodeType + 'SearchResult'` for each hit.
 Thus you can easily adjust the rendering per type like this for an imaginary `Acme.AcmeCom:Product` nodetype:
 
-```
-prototype(Acme.AcmeCom:ProductSearchResult) < prototype(TYPO3.Neos:DocumentSearchResult) {
-    templatePath = 'resource://Acme.AcmeCom/Private/Templates/SearchResult/ProductSearchResult.html'
-}
-```
+    prototype(Acme.AcmeCom:ProductSearchResult) < prototype(TYPO3.Neos:DocumentSearchResult) {
+        templatePath = 'resource://Acme.AcmeCom/Private/Templates/SearchResult/ProductSearchResult.html'
+    }
 
 Feel free to use the `DocumentSearchResult.html` in the Flowpack.SearchPlugin as an example.
+
+## Search suggestions
+
+The default search form template comes with a `data-autocomplete-source` attribute pointing to the 
+`SuggestController` of this package. Fed with a `term` parameter via a `GET` request, it returns a
+JSON-encoded array of suggestions from Elasticsearch. These are fetched with a term suggester from
+`_all` field, i.e. "the fulltext index".
+
+These can be used to provide autocompletion on the search input using a JS library of your choice.
+In case you need to build the URI to the suggest controller yourself, this is what the form uses:
+
+    {f:uri.action(action: 'index', controller: 'Suggest', package: 'Flowpack.SearchPlugin', format: 'json', absolute: 1)}

Resources/Private/Templates/NodeTypes/Search.Form.html

@@ -1,4 +1,4 @@
 <form method="GET">
-    <input type="search" name="search" value="{searchWord}" placeholder="{f:translate(id: 'search', package: 'Flowpack.SearchPlugin')}" data-autocomplete-source="{f:uri.action(action: 'index', controller: 'Suggest', package: 'Flowpack.SearchPlugin', format: 'json' absolute: 1, arguments: {node: node})}"/>
+    <input type="search" name="search" value="{searchWord}" placeholder="{f:translate(id: 'search', package: 'Flowpack.SearchPlugin')}" data-autocomplete-source="{f:uri.action(action: 'index', controller: 'Suggest', package: 'Flowpack.SearchPlugin', format: 'json', absolute: 1)}"/>
     <button type="submit">{f:translate(id: 'search', package: 'Flowpack.SearchPlugin')}</button>
 </form>