[BUGFIX] Add aggregation and fieldBasedAggregation function

This change implements a new generuc aggregation function as well as a new fieldBasedAggregation function that replaces addSimpleAggregation

Author: johannessteu

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

@@ -404,29 +404,42 @@ public function queryFilterMultiple($data, $clauseType = 'must') {
 	}
 
 	/**
-	 * Adds a simple aggregation with only filed set as configuration
+	 * This method adds a field based aggregation configuration. This can be used for simple
+	 * aggregations like terms
 	 *
 	 * @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 (
+	public function fieldBasedAggregation($name, $field, $type = "terms", $parentPath = NULL) {
+		$aggregationDefinition = array(
+			$type => array(
 				'field' => $field
 			)
 		);
 
+		$this->aggregation($name, $aggregationDefinition, $parentPath);
+		return $this;
+	}
+
+	/**
+	 * @param string $name
+	 * @param array $aggregationDefinition
+	 * @param null $parentPath
+	 * @return $this
+	 * @throws QueryBuildingException
+	 */
+	public function aggregation($name, array $aggregationDefinition, $parentPath = NULL) {
+		if(!array_key_exists("aggregations", $this->request)) {
+			$this->request['aggregations'] = array();
+		}
+
 		if($parentPath !== NULL) {
-			$this->addSubAggregation($parentPath, $name, $aggregation);
+			$this->addSubAggregation($parentPath, $name, $aggregationDefinition);
 		} else {
-			$this->request['aggregations'][$name] = $aggregation;
+			$this->request['aggregations'][$name] = $aggregationDefinition;
 		}
 
 		return $this;

Tests/Unit/Eel/ElasticSearchQueryBuilderTest.php

@@ -228,7 +228,7 @@ public function anSimpleAggregationCanBeAddedToTheRequest($type, $name, $field)
 			)
 		);
 
-		$this->queryBuilder->addSimpleAggregation($name, $field, $type);
+		$this->queryBuilder->fieldBasedAggregation($name, $field, $type);
 		$actual = $this->queryBuilder->getRequest();
 
 		$this->assertInArray($expected, $actual);
@@ -238,9 +238,9 @@ public function anSimpleAggregationCanBeAddedToTheRequest($type, $name, $field)
 	 * @test
 	 */
 	public function anAggregationCanBeSubbedUnderAPath() {
-		$this->queryBuilder->addSimpleAggregation("foo", "bar");
-		$this->queryBuilder->addSimpleAggregation("bar", "bar", "terms", "foo");
-		$this->queryBuilder->addSimpleAggregation("baz", "bar", "terms", "foo.bar");
+		$this->queryBuilder->fieldBasedAggregation("foo", "bar");
+		$this->queryBuilder->fieldBasedAggregation("bar", "bar", "terms", "foo");
+		$this->queryBuilder->fieldBasedAggregation("baz", "bar", "terms", "foo.bar");
 
 		$expected = array(
 			"foo" => array(
@@ -267,17 +267,35 @@ public function anAggregationCanBeSubbedUnderAPath() {
 	 * @expectedException \Flowpack\ElasticSearch\ContentRepositoryAdaptor\Exception\QueryBuildingException
 	 */
 	public function ifTheParentPathDoesNotExistAnExceptionisThrown() {
-		$this->queryBuilder->addSimpleAggregation("foo", "bar");
-		$this->queryBuilder->addSimpleAggregation("bar", "bar", "terms", "doesNotExist");
+		$this->queryBuilder->fieldBasedAggregation("foo", "bar");
+		$this->queryBuilder->fieldBasedAggregation("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");
+		$this->queryBuilder->fieldBasedAggregation("foo", "bar");
+		$this->queryBuilder->fieldBasedAggregation("bar", "bar", "terms", "foo.doesNotExist");
+	}
+
+	/**
+	 * @test
+	 */
+	public function aCustomAggregationDefinitionCanBeApplied() {
+		$expected = array(
+			"foo" => array(
+				"some" => array("field" => "bar"),
+				"custom" => array("field" => "bar"),
+				"arrays" => array("field" => "bar")
+			)
+		);
+
+		$this->queryBuilder->aggregation("foo", $expected['foo']);
+		$actual = $this->queryBuilder->getRequest();
+
+		$this->assertInArray($expected, $actual);
 	}
 
 	/**