[FEATURE] allow to access the raw ElasticSearch Hit given a node

This feature is the basis for Result Highlighting.

Author: skurfuerst

Classes/Flowpack/ElasticSearch/ContentRepositoryAdaptor/Eel/ElasticSearchQueryBuilder.php

@@ -75,6 +75,16 @@ class ElasticSearchQueryBuilder implements QueryBuilderInterface, ProtectedConte
 	 */
 	protected $totalItems;
 
+	/**
+	 * This (internal) array stores, for the last search request, a mapping from Node Identifiers
+	 * to the full ElasticSearch Hit which was returned.
+	 *
+	 * This is needed to e.g. use result highlighting.
+	 *
+	 * @var array
+	 */
+	protected $elasticSearchHitsIndexedByNodeFromLastRequest;
+
 	/**
 	 * The ElasticSearch request, as it is being built up.
 	 * @var array
@@ -430,6 +440,19 @@ public function getFrom() {
 		return $this->from;
 	}
 
+	/**
+	 * This low-level method can be used to look up the full ElasticSearch hit given a certain node.
+	 *
+	 * @param NodeInterface $node
+	 * @return array the ElasticSearch hit for the node as array, or NULL if it does not exist.
+	 */
+	public function getFullElasticSearchHitForNode(NodeInterface $node) {
+		if (isset($this->elasticSearchHitsIndexedByNodeFromLastRequest[$node->getIdentifier()])) {
+			return $this->elasticSearchHitsIndexedByNodeFromLastRequest[$node->getIdentifier()];
+		}
+		return NULL;
+	}
+
 	/**
 	 * Execute the query and return the list of nodes as result.
 	 *
@@ -456,6 +479,7 @@ public function fetch() {
 		}
 
 		$nodes = array();
+		$elasticSearchHitPerNode = array();
 
 		/**
 		 * TODO: This code below is not fully correct yet:
@@ -482,6 +506,7 @@ public function fetch() {
 			$node = $this->contextNode->getNode($nodePath);
 			if ($node instanceof NodeInterface) {
 				$nodes[$node->getIdentifier()] = $node;
+				$elasticSearchHitPerNode[$node->getIdentifier()] = $hit;
 				if ($this->limit > 0 && count($nodes) >= $this->limit) {
 					break;
 				}
@@ -492,6 +517,8 @@ public function fetch() {
 			$this->logger->log('Query Log (' . $this->logMessage . ') Number of returned results: ' . count($nodes), LOG_DEBUG);
 		}
 
+		$this->elasticSearchHitsIndexedByNodeFromLastRequest = $elasticSearchHitPerNode;
+
 		return array_values($nodes);
 	}
 

Classes/Flowpack/ElasticSearch/ContentRepositoryAdaptor/Eel/ElasticSearchQueryResult.php

@@ -11,9 +11,11 @@
  * The TYPO3 project - inspiring people to share!                                                   *
  *                                                                                                  */
 
+use TYPO3\Eel\ProtectedContextAwareInterface;
 use TYPO3\Flow\Persistence\QueryResultInterface;
+use TYPO3\TYPO3CR\Domain\Model\NodeInterface;
 
-class ElasticSearchQueryResult implements QueryResultInterface {
+class ElasticSearchQueryResult implements QueryResultInterface, ProtectedContextAwareInterface {
 
 	/**
 	 * @var ElasticSearchQuery
@@ -152,4 +154,26 @@ public function count() {
 
 		return $this->count;
 	}
+
+	/**
+	 * Returns the ElasticSearch "hit" (e.g. the raw content being transferred back from ElasticSearch)
+	 * for the given node.
+	 *
+	 * Can be used for example to access highlighting information.
+	 *
+	 * @param NodeInterface $node
+	 * @return array the ElasticSearch hit, or NULL if it does not exist.
+	 * @api
+	 */
+	public function searchHitForNode(NodeInterface $node) {
+		return $this->elasticSearchQuery->getQueryBuilder()->getFullElasticSearchHitForNode($node);
+	}
+
+	/**
+	 * @param string $methodName
+	 * @return boolean
+	 */
+	public function allowsCallOfMethod($methodName) {
+		return TRUE;
+	}
 }