Merge pull request #9 from beheist/master

[FEATURE] Add support for search via AJAX

Author: skurfuerst

Classes/Flowpack/SearchPlugin/Controller/AjaxSearchController.php

@@ -0,0 +1,45 @@
+<?php
+namespace Flowpack\SearchPlugin\Controller;
+
+/*                                                                                                  *
+ * This script belongs to the TYPO3 Flow package "Flowpack.SearchPlugin".                           *
+ *                                                                                                  *
+ * It is free software; you can redistribute it and/or modify it under                              *
+ * the terms of the GNU Lesser General Public License, either version 3                             *
+ *  of the License, or (at your option) any later version.                                          *
+ *                                                                                                  *
+ * The TYPO3 project - inspiring people to share!                                                   *
+ *                                                                                                  */
+
+use TYPO3\Flow\Annotations as Flow;
+use TYPO3\Flow\Mvc\Controller\ActionController;
+use TYPO3\TYPO3CR\Domain\Model\NodeInterface;
+
+/**
+ * Class AjaxSearchController
+ *
+ * @author Sebastian Kurfürst <sk@sandstorm.de>
+ * @author Bastian Heist <bh@sandstorm.de>
+ * @package Flowpack\SearchPlugin\Controller
+ */
+class AjaxSearchController extends ActionController {
+
+	/**
+	 * Override the default view from the ActionController to output TypoScript directly
+	 *
+	 * @var string
+	 * @api
+	 */
+	protected $defaultViewObjectName = \TYPO3\Neos\View\TypoScriptView::class;
+
+	/**
+	 * @param NodeInterface $node
+	 */
+	public function searchAction(NodeInterface $node) {
+		/* @var $view \TYPO3\Neos\View\TypoScriptView */
+		$view = $this->view;
+		$view->setTypoScriptPath('ajaxSearch');
+		$view->assign('value', $node);
+	}
+
+}

Configuration/Policy.yaml

@@ -2,10 +2,15 @@ privilegeTargets:
   TYPO3\Flow\Security\Authorization\Privilege\Method\MethodPrivilege:
     Flowpack_SearchPlugin_Controller_SuggestController:
       matcher: method(Flowpack\SearchPlugin\Controller\SuggestController->indexAction())
+    Flowpack_SearchPlugin_Controller_AjaxSearchController:
+      matcher: method(Flowpack\SearchPlugin\Controller\AjaxSearchController->searchAction())
 
 roles:
   'TYPO3.Flow:Everybody':
     privileges:
       -
         privilegeTarget: Flowpack_SearchPlugin_Controller_SuggestController
+        permission: GRANT
+      -
+        privilegeTarget: Flowpack_SearchPlugin_Controller_AjaxSearchController
         permission: GRANT

Configuration/Routes.yaml

@@ -8,4 +8,14 @@
     '@action':     'index'
     '@format':     'json'
   appendExceedingArguments: TRUE
+  httpMethods: ['GET']
+-
+  name: 'flowpack/searchplugin - SuggestController->ajax'
+  uriPattern: 'flowpack/ajaxsearch'
+  defaults:
+    '@package':    'Flowpack.SearchPlugin'
+    '@controller': 'AjaxSearch'
+    '@action':     'search'
+    '@format':     'html'
+  appendExceedingArguments: TRUE
   httpMethods: ['GET']

Resources/Private/Templates/NodeTypes/AjaxSearch.html

@@ -0,0 +1,3 @@
+<div{attributes -> f:format.raw()}>
+	{searchResultRenderer -> f:format.raw()}
+</div>

Resources/Private/TypoScript/AjaxSearch.ts2

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

Resources/Private/TypoScript/Root.ts2

@@ -2,3 +2,6 @@ prototype(Flowpack.SearchPlugin:CanRender).@class = 'Flowpack\\SearchPlugin\\Typ
 
 include: SearchPlugin.ts2
 include: ResultRendering.ts2
+include: AjaxSearch.ts2
+
+ajaxSearch = Flowpack.SearchPlugin:AjaxSearch

Resources/Private/TypoScript/SearchPlugin.ts2

@@ -7,16 +7,9 @@ prototype(Flowpack.SearchPlugin:Search) {
 
 	searchForm = Flowpack.SearchPlugin:Search.Form
 
-	searchResultRenderer = TYPO3.TypoScript:Collection {
-		// the "searchResults" are filled from the <search:widget.paginate> ViewHelper.
-		collection = ${searchResults}
-		itemRenderer = Flowpack.SearchPlugin:SingleResult
-		itemName = 'node'
-		// we also make the full ElasticSearch hit available to nested rendering, if possible
-		itemRenderer.@override.searchHit = ${searchResults.searchHitForNode(node)}
-	}
+	searchResultRenderer = Flowpack.SearchPlugin:SearchResultRenderer
 
-	searchResultRenderer.@process.wrap = ${'<ol>' + value + '</ol>'}
+    searchResultRenderer.@process.wrap = ${'<ol>' + value + '</ol>'}
 	prototype(Flowpack.SearchPlugin:SingleResult).@process.wrap = ${'<li>' + value + '</li>'}
 
 	@cache {
@@ -33,4 +26,13 @@ prototype(Flowpack.SearchPlugin:Search.Form) < prototype(TYPO3.TypoScript:Templa
 	node = ${site}
 	templatePath = 'resource://Flowpack.SearchPlugin/Private/Templates/NodeTypes/Search.Form.html'
 	searchWord = ${request.arguments.search}
+}
+
+prototype(Flowpack.SearchPlugin:SearchResultRenderer) < prototype(TYPO3.TypoScript:Collection) {
+    // the "searchResults" are filled from the <search:widget.paginate> ViewHelper.
+    collection = ${searchResults}
+    itemRenderer = Flowpack.SearchPlugin:SingleResult
+    itemName = 'node'
+    // we also make the full ElasticSearch hit available to nested rendering, if possible
+    itemRenderer.@override.searchHit = ${searchResults.searchHitForNode(node)}
 }