FEATURE: Add a eel helper for searchterm processing

Author: daniellienert

Classes/Controller/SuggestController.php

@@ -116,7 +116,7 @@ protected function buildRequestForTerm(string $term, string $contextNodeIdentifi
 
         // The suggest function only works well with one word
         // special search characters are escaped
-        $suggestTerm = SearchTerm::sanitizeSearchInput(explode(' ', $term)[0]);
+        $suggestTerm = SearchTerm::sanitize(explode(' ', $term)[0]);
 
         if (!$this->elasticSearchQueryTemplateCache->has($cacheKey)) {
             $contentContext = $this->createContentContext('live', $dimensionCombination ? json_decode($dimensionCombination, true) : []);

Classes/EelHelper/SearchArrayHelper.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 namespace Flowpack\SearchPlugin\EelHelper;
 
 /*

Classes/EelHelper/SearchTermHelper.php

@@ -0,0 +1,31 @@
+<?php
+declare(strict_types=1);
+
+namespace Flowpack\SearchPlugin\EelHelper;
+
+/*
+ * This file is part of the Flowpack.SearchPlugin package.
+ *
+ * (c) Contributors of the Flowpack Team - flowpack.org
+ *
+ * This package is Open Source Software. For the full copyright and license
+ * information, please view the LICENSE file which was distributed with this
+ * source code.
+ */
+
+use Flowpack\SearchPlugin\Utility\SearchTerm;
+use Neos\Eel\ProtectedContextAwareInterface;
+
+class SearchTermHelper implements ProtectedContextAwareInterface
+{
+
+    public function sanitize(string $term): string
+    {
+        return SearchTerm::sanitize($term);
+    }
+
+    public function allowsCallOfMethod($methodName)
+    {
+        return true;
+    }
+}

Classes/EelHelper/SuggestionIndexHelper.php

@@ -48,7 +48,7 @@ protected function prepareInput($input): ?array
     {
         $process = static function (?string $input) {
             $input = preg_replace("/\r|\n/", '', $input);
-            return array_values(array_filter(explode(' ', SearchTerm::sanitizeSearchInput(strip_tags($input)))));
+            return array_values(array_filter(explode(' ', SearchTerm::sanitize(strip_tags($input)))));
         };
 
         if (\is_string($input)) {

Classes/Utility/SearchTerm.php

@@ -15,10 +15,8 @@
 
 class SearchTerm
 {
-
-    public static function sanitizeSearchInput(string $input): string
+    public static function sanitize(string $input): string
     {
         return str_replace(['=', '>', '<', '(', ')', '{', '}', '[', ']', '^', '"', '~', '*', '?', ':', '\\', '/'], ['', '', '', '(', '\)', '\{', '\}', '\[', '\]', '\^', '\"', '\~', '\*', '\?', '\:', '\\\\', '\/'], $input);
     }
-
 }

Configuration/NodeTypes.Mixin.Suggestable.yaml

@@ -13,5 +13,9 @@
             -
               name: 'parent_path'
               type: category
-              path: 'neos_parent_path '
+              path: 'neos_parent_path'
+            -
+              name: 'hidden'
+              type: category
+              path: 'neos_hidden'
         indexing: "${Flowpack.SearchPlugin.Suggestion.build(q(node).property('title') ? q(node).property('title') : '', 20)}"

Configuration/Settings.Neos.yaml

@@ -7,6 +7,7 @@ Neos:
   Fusion:
     defaultContext:
       Flowpack.SearchPlugin.Array: Flowpack\SearchPlugin\EelHelper\SearchArrayHelper
+      Flowpack.SearchPlugin.SearchTerm: Flowpack\SearchPlugin\EelHelper\SearchTermHelper
   Neos:
     fusion:
       autoInclude: