[TASK] Add simple aggregation functionality

This change implements a new function addSimpleAggregation() and a new low-level function addSubAggregation to add (sub-) aggregatons to a elasticsearch request.

Usage to get aggregation for property "color" in a node Vendor.Name:NodeType:
`nodes = $Search.query(site).nodeType("Vendor.Name:NodeType").addSimpleAggregation("color", "color").execute() `
To get your aggregationResults access {nodes.aggregations} in your fluid template.

This change also allows you to add sub-aggregations:
`nodes = $Search.query(site).nodeType("Vendor.Name:NodeType").addSimpleAggregation("color", "color").addSimpleAggregation("type", "type", "terms", "color" ).execute() `

Author: johannessteu

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

@@ -66,7 +66,7 @@ class ElasticSearchQueryBuilder implements QueryBuilderInterface, ProtectedConte
 	 *
 	 * @var array
 	 */
-	protected $unsupportedFieldsInCountRequest = array('fields', 'sort', 'from', 'size', 'highlight');
+	protected $unsupportedFieldsInCountRequest = array('fields', 'sort', 'from', 'size', 'highlight', 'aggs', 'aggregations');
 
 	/**
 	 * Amount of total items in response without limit
@@ -85,6 +85,13 @@ class ElasticSearchQueryBuilder implements QueryBuilderInterface, ProtectedConte
 	 */
 	protected $elasticSearchHitsIndexedByNodeFromLastRequest;
 
+	/**
+	 * This (internal) array stores all aggregation results for the last search request
+	 *
+	 * @var array
+	 */
+	protected $elasticSearchAggregationsFromLastRequest;
+
 	/**
 	 * The ElasticSearch request, as it is being built up.
 	 * @var array
@@ -396,6 +403,62 @@ public function queryFilterMultiple($data, $clauseType = 'must') {
 		return $this;
 	}
 
+	/**
+	 * Adds a simple aggregation with only filed set as configuration
+	 *
+	 * @param $name
+	 * @param $field
+	 * @param string $type
+	 * @param null $parentPath
+	 * @return $this
+	 */
+	public function addSimpleAggregation($name, $field, $type = 'terms', $parentPath = NULL) {
+		if(!array_key_exists("aggregations", $this->request)) {
+			$this->request['aggregations'] = array();
+		}
+
+		$aggregation = array (
+			$type => array (
+				'field' => $field
+			)
+		);
+
+		if($parentPath !== NULL) {
+			$this->addSubAggregation($parentPath, $name, $aggregation);
+		} else {
+			$this->request['aggregations'][$name] = $aggregation;
+		}
+
+		return $this;
+	}
+
+	/**
+	 * This is an low level method for internal usage.
+	 * You can add a custom $aggregationConfiguration under a given $parentPath. The $parentPath foo.bar would
+	 * insert your $aggregationConfiguration under
+	 * $this->request['aggregations']['foo']['aggregations']['bar']['aggregations'][$name]
+	 *
+	 * @param $parentPath
+	 * @param $name
+	 * @param array $aggregationConfiguration
+	 * @return $this
+	 * @throws QueryBuildingException
+	 */
+	public function addSubAggregation($parentPath, $name, $aggregationConfiguration) {
+		// Find the parentPath
+		$path =& $this->request['aggregations'];
+
+		foreach(explode(".", $parentPath) as $subPart) {
+			if($path == NULL || !array_key_exists($subPart, $path)) {
+				throw new QueryBuildingException("The parent path ".$subPart." could not be found when adding a sub aggregation");
+			}
+			$path =& $path[$subPart]['aggregations'];
+		}
+
+		$path[$name] = $aggregationConfiguration;
+		return $this;
+	}
+
 	/**
 	 * Get the ElasticSearch request as we need it
 	 *
@@ -519,6 +582,10 @@ public function fetch() {
 
 		$this->elasticSearchHitsIndexedByNodeFromLastRequest = $elasticSearchHitPerNode;
 
+		if(array_key_exists("aggregations", $treatedContent)) {
+			$this->elasticSearchAggregationsFromLastRequest = $treatedContent['aggregations'];
+		}
+
 		return array_values($nodes);
 	}
 
@@ -534,6 +601,13 @@ public function execute() {
 		return $result;
 	}
 
+	/**
+	* @return array
+	*/
+	public function getElasticSearchAggregationsFromLastRequest() {
+		return $this->elasticSearchAggregationsFromLastRequest;
+	}
+
 	/**
 	 * Return the total number of hits for the query.
 	 *

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

@@ -164,6 +164,14 @@ public function getAccessibleCount() {
 		return count($this->results);
 	}
 
+	/**
+	 * @return array
+	 */
+	public function getAggregations() {
+		$this->initialize();
+		return $this->elasticSearchQuery->getQueryBuilder()->getElasticSearchAggregationsFromLastRequest();
+	}
+
 	/**
 	 * Returns the ElasticSearch "hit" (e.g. the raw content being transferred back from ElasticSearch)
 	 * for the given node.

Tests/Unit/Eel/ElasticSearchQueryBuilderTest.php

@@ -175,6 +175,9 @@ public function sortDescWorks() {
 		$this->assertSame($expected, $actual['sort']);
 	}
 
+	/**
+	 * @return array
+	 */
 	public function rangeConstraintExamples() {
 		return array(
 			array('greaterThan', 'gt', 10),
@@ -199,6 +202,84 @@ public function rangeConstraintsWork($constraint, $operator, $value) {
 		$this->assertInArray($expected, $actual['query']['filtered']['filter']['bool']['must']);
 	}
 
+	/**
+	 * @return array
+	 */
+	public function simpleAggregationExamples() {
+		return array(
+			array('min', 'foo', 'bar'),
+			array('terms', 'foo', 'bar'),
+			array('sum', 'foo', 'bar'),
+			array('stats', 'foo', 'bar'),
+			array('value_count', 'foo', 'bar')
+		);
+	}
+
+	/**
+	 * @test
+	 * @dataProvider simpleAggregationExamples
+	 */
+	public function anSimpleAggregationCanBeAddedToTheRequest($type, $name, $field) {
+		$expected = array(
+			$name => array(
+				$type => array(
+					'field' => $field
+				)
+			)
+		);
+
+		$this->queryBuilder->addSimpleAggregation($name, $field, $type);
+		$actual = $this->queryBuilder->getRequest();
+
+		$this->assertInArray($expected, $actual);
+	}
+
+	/**
+	 * @test
+	 */
+	public function anAggregationCanBeSubbedUnderAPath() {
+		$this->queryBuilder->addSimpleAggregation("foo", "bar");
+		$this->queryBuilder->addSimpleAggregation("bar", "bar", "terms", "foo");
+		$this->queryBuilder->addSimpleAggregation("baz", "bar", "terms", "foo.bar");
+
+		$expected = array(
+			"foo" => array(
+				"terms" => array("field" => "bar"),
+				"aggregations" => array(
+					"bar" => array(
+						"terms" => array("field" => "bar"),
+						"aggregations" => array(
+							"baz" => array(
+								"terms" => array("field" => "bar")
+							)
+						)
+					)
+				)
+			)
+		);
+
+		$actual = $this->queryBuilder->getRequest();
+		$this->assertInArray($expected, $actual);
+	}
+
+	/**
+	 * @test
+	 * @expectedException \Flowpack\ElasticSearch\ContentRepositoryAdaptor\Exception\QueryBuildingException
+	 */
+	public function ifTheParentPathDoesNotExistAnExceptionisThrown() {
+		$this->queryBuilder->addSimpleAggregation("foo", "bar");
+		$this->queryBuilder->addSimpleAggregation("bar", "bar", "terms", "doesNotExist");
+	}
+
+	/**
+	 * @test
+	 * @expectedException \Flowpack\ElasticSearch\ContentRepositoryAdaptor\Exception\QueryBuildingException
+	 */
+	public function ifSubbedParentPathDoesNotExistAnExceptionisThrown() {
+		$this->queryBuilder->addSimpleAggregation("foo", "bar");
+		$this->queryBuilder->addSimpleAggregation("bar", "bar", "terms", "foo.doesNotExist");
+	}
+
 	/**
 	 * Test helper
 	 *