MERGE: Merge branch 'master' into instructions-custom-index-name

Author: kdambekalns

Classes/Controller/SuggestController.php

@@ -178,10 +178,8 @@ protected function extractCompletions($response)
      */
     protected function extractSuggestions($response)
     {
-        if ($this->elasticSearchClient === null) {
-            throw new \RuntimeException('The SuggestController needs an ElasticSearchClient, it seems you run without the flowpack/elasticsearch-contentrepositoryadaptor package, though.', 1487189823);
-        }
         $suggestionOptions = isset($response['suggest']) ? $response['suggest'] : [];
+
         if (count($suggestionOptions['suggestions'][0]['options']) > 0) {
             return $suggestionOptions['suggestions'][0]['options'];
         }

Configuration/NodeTypes.Mixins.yaml

@@ -16,7 +16,7 @@
             dimensionCombinationHash:
               type: category
               path: '__dimensionCombinationHash'
-        indexing: "${Flowpack.SearchPlugin.Suggestion.build(q(node).property('title'), q(node).is('[instanceof Neos.Neos:Document]') ? node.identifier : q(node).parents('[instanceof Neos.Neos:Document]').get(0).identifier, {nodeIdentifier: node.identifier}, 20)}"
+        indexing: "${Flowpack.SearchPlugin.Suggestion.build(q(node).property('title') ? q(node).property('title') : '', q(node).is('[instanceof Neos.Neos:Document]') ? node.identifier : q(node).parents('[instanceof Neos.Neos:Document]').get(0).identifier, {nodeIdentifier: node.identifier}, 20)}"
 
 'Flowpack.SearchPlugin:AutocompletableMixin':
   abstract: true

README.md

@@ -1,6 +1,7 @@
 # Flowpack.SearchPlugin
 
 This plugin is a Search Plugin, to be used together with
+
 * [Flowpack.ElasticSearch.ContentRepositoryAdaptor](https://github.com/Flowpack/Flowpack.ElasticSearch.ContentRepositoryAdaptor) or 
 * [Flowpack.SimpleSearch.ContentRepositoryAdaptor](https://github.com/Flowpack/Flowpack.SimpleSearch.ContentRepositoryAdaptor).
 
@@ -76,7 +77,7 @@ Thus you can easily adjust the rendering per type like this for an imaginary `Ac
 
 Feel free to use the `DocumentSearchResult.html` in the Flowpack.SearchPlugin as an example.
 
-## Search suggestions
+## Search completions and 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
@@ -86,14 +87,67 @@ the `_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)}
+    {f:uri.action(action: 'index', controller: 'Suggest', package: 'Flowpack.SearchPlugin', format: 'json', absolute: 1, arguments: {contextNodeIdentifier: node.identifier, dimensionCombination: dimensionCombination})}
+
+The returned JSON looks like this (with a `term` of "content" after indexing the Neos demo site):
+
+    {
+      "completions": [
+        "content",
+        "content element",
+        "content in",
+        "content in neos",
+        "content in neos because",
+        "content in neos because you",
+        "content repository"
+      ],
+      "suggestions": [
+        {
+          "text": "995c9174-ddd6-4d5c-cfc0-1ffc82184677",
+          "score": 20,
+          "payload": {
+            "nodeIdentifier": "d17caff2-f50c-d30b-b735-9b9216de02e9"
+          }
+        },
+        {
+          "text": "a66ec7db-3459-b67b-7bcb-16e2508a89f0",
+          "score": 20,
+          "payload": {
+            "nodeIdentifier": "fd283257-9b12-8412-f922-6643ac818294"
+          }
+        },
+        {
+          "text": "a3474e1d-dd60-4a84-82b1-18d2f21891a3",
+          "score": 20,
+          "payload": {
+            "nodeIdentifier": "7eee2ee6-2a4e-5240-3674-2fb84a51900b"
+          }
+        }
+      ]
+    }
+
+The `completions` can be used to suggest search terms to the user. The `suggestions` contains
+"top search results" for the given term, the document they refer to is given in the `payload`.
 
 ## AJAX search
 
 The plugin comes with a controller that can be reached like this per default, using `GET`:
 
-    {f:uri.action(action: 'index', controller: 'AjaxSearch', package: 'Flowpack.SearchPlugin', absolute: 1)}
+    {f:uri.action(action: 'search', controller: 'AjaxSearch', package: 'Flowpack.SearchPlugin', arguments: {node: node, q: ''}, absolute: 1)}
 
 It expects the search term as a parameter named `q` (as defined in `AjaxSearch.fusion`). This controller
 renders the search results and returns them as HTML without any of the page template. It can therefore
 be used to request search results via AJAX and display the result by adding it to the DOM as needed.
+
+## Removing special chars from search term
+
+You might need to remove special chars to prevent search errors. Some chars are reserved in Elasticsearch
+and you can replace them before submitting the search like this:
+
+    prototype(Flowpack.SearchPlugin:Search) {
+        searchTerm = ${request.arguments.search}
+        searchTerm.@process.removeSpecialChars = ${String.pregReplace(value, "/[^a-zA-Z0-9äöüÄÖÜß]/", "")}
+    }
+
+Keep in mind, that this blocks the explicit use of wildcards (`*`) and phrase search (`"search exactly this"`)
+for your users, in case you want to support that.

composer.json

@@ -4,12 +4,12 @@
     "type": "neos-package",
     "description": "Plugin for search integration via content node",
     "require": {
-        "neos/content-repository": "^3.0",
-        "neos/content-repository-search": "^3.0",
-        "neos/eel": "^4.0",
-        "neos/flow": "^4.0",
-        "neos/fusion": "^3.0",
-        "neos/neos": "^3.0"
+        "neos/content-repository": "^3.0 || ^4.0 || dev-master",
+        "neos/content-repository-search": "^3.0 || ^4.0 || dev-master",
+        "neos/eel": "^4.0 || ^5.0 || dev-master",
+        "neos/flow": "^4.0 || ^5.0 || dev-master",
+        "neos/fusion": "^3.0 || ^4.0 || dev-master",
+        "neos/neos": "^3.0 || ^4.0 || dev-master"
     },
     "suggest": {
         "flowpack/elasticsearch-contentrepositoryadaptor": "Provides search using Elasticsearch",