TASK: Polished code after migrations

Author: ComiR

Classes/Controller/AjaxSearchController.php

@@ -11,30 +11,29 @@
  * source code.
  */
 
+use Neos\ContentRepository\Domain\Model\NodeInterface;
 use Neos\Flow\Annotations as Flow;
 use Neos\Flow\Mvc\Controller\ActionController;
-use Neos\ContentRepository\Domain\Model\NodeInterface;
+use Neos\Neos\View\FusionView;
 
-/**
- * Class AjaxSearchController
- */
 class AjaxSearchController extends ActionController
 {
     /**
-     * Override the default view from the ActionController to output TypoScript directly
+     * Override the default view from the ActionController to output Fusion directly
      *
      * @var string
      * @api
      */
-    protected $defaultViewObjectName = \Neos\Neos\View\FusionView::class;
+    protected $defaultViewObjectName = FusionView::class;
 
     /**
      * @param NodeInterface $node
+     *
      * @return void
      */
     public function searchAction(NodeInterface $node)
     {
-        /* @var $view \Neos\Neos\View\FusionView */
+        /* @var FusionView $view */
         $view = $this->view;
         $view->setFusionPath('ajaxSearch');
         $view->assign('value', $node);

Classes/Controller/SuggestController.php

@@ -11,29 +11,29 @@
  * source code.
  */
 
+use Flowpack\ElasticSearch\ContentRepositoryAdaptor\ElasticSearchClient;
 use Neos\Flow\Annotations as Flow;
 use Neos\Flow\Mvc\Controller\ActionController;
+use Neos\Flow\Mvc\View\JsonView;
 
-/**
- * Class SuggestController
- */
 class SuggestController extends ActionController
 {
     /**
      * @Flow\Inject
-     * @var \Flowpack\ElasticSearch\ContentRepositoryAdaptor\ElasticSearchClient
+     * @var ElasticSearchClient
      */
     protected $elasticSearchClient;
 
     /**
      * @var array
      */
     protected $viewFormatToObjectNameMap = [
-        'json' => 'Neos\Flow\Mvc\View\JsonView'
+        'json' => JsonView::class
     ];
 
     /**
      * @param string $term
+     *
      * @return void
      */
     public function indexAction($term)

Classes/EelHelper/SearchArrayHelper.php

@@ -25,6 +25,7 @@ class SearchArrayHelper implements ProtectedContextAwareInterface
      * Concatenate arrays or values to a new array
      *
      * @param array|mixed $arrays First array or value
+     *
      * @return array The array with concatenated arrays or values
      */
     public function flatten($arrays)
@@ -43,6 +44,7 @@ public function flatten($arrays)
      * All methods are considered safe
      *
      * @param string $methodName
+     *
      * @return boolean
      */
     public function allowsCallOfMethod($methodName)

Classes/FusionObjects/CanRenderImplementation.php

@@ -14,29 +14,25 @@
 use Neos\Flow\Annotations as Flow;
 use Neos\Fusion\FusionObjects\AbstractFusionObject;
 
-/**
- * Class CanRenderImplementation
- *
- */
 class CanRenderImplementation extends AbstractFusionObject
 {
     /**
-     * TypoScript Type which shall be rendered
+     * Evaluate this Fusion object and return the result
      *
-     * @return string
+     * @return mixed
      */
-    public function getType()
+    public function evaluate()
     {
-        return $this->tsValue('type');
+        return $this->runtime->canRender('/type<' . $this->getType() . '>');
     }
 
     /**
-     * Evaluate this TypoScript object and return the result
+     * Fusion Type which shall be rendered
      *
-     * @return mixed
+     * @return string
      */
-    public function evaluate()
+    public function getType()
     {
-        return $this->tsRuntime->canRender('/type<' . $this->getType() . '>');
+        return $this->fusionValue('type');
     }
 }

Configuration/Policy.yaml

@@ -13,4 +13,4 @@ roles:
         permission: GRANT
       -
         privilegeTarget: Flowpack_SearchPlugin_Controller_AjaxSearchController
-        permission: GRANT
+        permission: GRANT

Configuration/Routes.yaml

@@ -7,7 +7,7 @@
     '@controller': 'Suggest'
     '@action':     'index'
     '@format':     'json'
-  appendExceedingArguments: TRUE
+  appendExceedingArguments: true
   httpMethods: ['GET']
 -
   name: 'flowpack/searchplugin - SuggestController->ajax'
@@ -17,5 +17,5 @@
     '@controller': 'AjaxSearch'
     '@action':     'search'
     '@format':     'html'
-  appendExceedingArguments: TRUE
-  httpMethods: ['GET']
+  appendExceedingArguments: true
+  httpMethods: ['GET']

Configuration/Settings.yaml

@@ -1,9 +1,13 @@
-
 Neos:
+  Flow:
+    mvc:
+      routes:
+        'Flowpack.SearchPlugin':
+          position: 'before Neos.Neos'
+  Fusion:
+    defaultContext:
+      Flowpack.SearchPlugin.Array: Flowpack\SearchPlugin\EelHelper\SearchArrayHelper
   Neos:
     fusion:
       autoInclude:
         Flowpack.SearchPlugin: true
-  Fusion:
-    defaultContext:
-      Flowpack.SearchPlugin.Array: Flowpack\SearchPlugin\EelHelper\SearchArrayHelper

README.md

@@ -1,39 +1,33 @@
 # Flowpack.SearchPlugin
 
-This plugin is just a very bare-bones basis for a Search-Plugin, to be used together with
-Flowpack.ElasticSearch.ContentRepositoryAdaptor or Flowpack.SimpleSearch.ContentRepositoryAdaptor.
+This plugin is just a very bare-bones basis for 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).
 
 ## Installation
 
-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'
+Inclusion of the routes from this package into your main `Configuration/Routes.yaml` is no longer needed as of Flow 4.0.
 
 ## Configuration
 
 
 ### Pagination 
 
-The pagination search results can be configured via TypoScript. The following shows the defaults:
+The pagination search results can be configured via Fusion. The following shows the defaults:
 
     prototype(Flowpack.SearchPlugin:Search).configuration {
         itemsPerPage = 25
-        insertAbove = ${false}
-        insertBelow = ${true}
+        insertAbove = false
+        insertBelow = true
         maximumNumberOfLinks = 10
     }
 
 ### Custom result rendering
 
-The result list is rendered using a TypoScript object of type `nodeType + 'SearchResult'` for each hit.
+The result list is rendered using a Fusion 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) {
+    prototype(Acme.AcmeCom:ProductSearchResult) < prototype(Neos.Neos:DocumentSearchResult) {
         templatePath = 'resource://Acme.AcmeCom/Private/Templates/SearchResult/ProductSearchResult.html'
     }
 
@@ -57,6 +51,6 @@ The plugin comes with a controller that can be reached like this per default, us
 
     {f:uri.action(action: 'index', controller: 'AjaxSearch', package: 'Flowpack.SearchPlugin', absolute: 1)}
 
-It expects the search term as a parameter named `q` (as defined in `AjaxSearch.ts2`). This controller
+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.

Resources/Private/Fusion/AjaxSearch.ts2 …sources/Private/Fusion/AjaxSearch.fusionResources/Private/Fusion/AjaxSearch.ts2 renamed to Resources/Private/Fusion/AjaxSearch.fusion Resources/Private/Fusion/AjaxSearch.ts2 renamed to Resources/Private/Fusion/AjaxSearch.fusion

@@ -1,6 +1,7 @@
 prototype(Flowpack.SearchPlugin:AjaxSearch) < prototype(Neos.Fusion:Template) {
     templatePath = 'resource://Flowpack.SearchPlugin/Private/Templates/NodeTypes/AjaxSearch.html'
+
     searchResultRenderer = Flowpack.SearchPlugin:SearchResultRenderer {
         @context.searchResults = ${Search.query(site).fulltext(request.arguments.q).execute()}
     }
-}
+}

…urces/Private/Fusion/ResultRendering.ts2 …es/Private/Fusion/ResultRendering.fusionResources/Private/Fusion/ResultRendering.ts2 renamed to Resources/Private/Fusion/ResultRendering.fusion Resources/Private/Fusion/ResultRendering.ts2 renamed to Resources/Private/Fusion/ResultRendering.fusion

@@ -7,7 +7,7 @@ prototype(Flowpack.SearchPlugin:SingleResult) < prototype(Neos.Fusion:Case) {
     }
 
     fallback {
-        condition = TRUE
+        condition = true
         type = 'Neos.Neos:DocumentSearchResult'
     }
 }