Merge pull request #48 from networkteam/range-queries

[FEATURE] Support greaterThan and lessThan for range filters

Author: Christian Müller

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

@@ -229,16 +229,61 @@ public function from($from) {
 	/**
 	 * add an exact-match query for a given property
 	 *
-	 * @param $propertyName
-	 * @param $propertyValue
+	 * @param string $propertyName Name of the property
+	 * @param mixed $value Value for comparison
 	 * @return ElasticSearchQueryBuilder
 	 */
-	public function exactMatch($propertyName, $propertyValue) {
-		if ($propertyValue instanceof NodeInterface) {
-			$propertyValue = $propertyValue->getIdentifier();
+	public function exactMatch($propertyName, $value) {
+		if ($value instanceof NodeInterface) {
+			$value = $value->getIdentifier();
 		}
 
-		return $this->queryFilter('term', array($propertyName => $propertyValue));
+		return $this->queryFilter('term', array($propertyName => $value));
+	}
+
+	/**
+	 * add a range filter (gt) for the given property
+	 *
+	 * @param string $propertyName Name of the property
+	 * @param mixed $value Value for comparison
+	 * @return ElasticSearchQueryBuilder
+	 */
+	public function greaterThan($propertyName, $value) {
+		return $this->queryFilter('range', array($propertyName => array('gt' => $value)));
+	}
+
+	/**
+	 * add a range filter (gte) for the given property
+	 *
+	 * @param string $propertyName Name of the property
+	 * @param mixed $value Value for comparison
+	 * @return ElasticSearchQueryBuilder
+	 */
+	public function greaterThanOrEqual($propertyName, $value) {
+		return $this->queryFilter('range', array($propertyName => array('gte' => $value)));
+	}
+
+	/**
+	 * add a range filter (lt) for the given property
+	 *
+	 * @param string $propertyName Name of the property
+	 * @param mixed $value Value for comparison
+	 * @return ElasticSearchQueryBuilder
+	 */
+	public function lessThan($propertyName, $value) {
+		return $this->queryFilter('range', array($propertyName => array('lt' => $value)));
+	}
+
+
+	/**
+	 * add a range filter (lte) for the given property
+	 *
+	 * @param string $propertyName Name of the property
+	 * @param mixed $value Value for comparison
+	 * @return ElasticSearchQueryBuilder
+	 */
+	public function lessThanOrEqual($propertyName, $value) {
+		return $this->queryFilter('range', array($propertyName => array('lte' => $value)));
 	}
 
 	/**

README.md

@@ -172,7 +172,11 @@ search underneath the current site node (like in the example above).
 Furthermore, the following operators are supported:
 
 * `nodeType("Your.Node:Type")`
-* `exactMatch(key, value)`; supports simple types: `exactMatch('tag', 'foo')`, or node references: `exactMatch('author', authorNode)`
+* `exactMatch('propertyName', value)`; supports simple types: `exactMatch('tag', 'foo')`, or node references: `exactMatch('author', authorNode)`
+* `greaterThan('propertyName', value)` -- range filter with property values greater than the given value
+* `greaterThanOrEqual('propertyName', value)` -- range filter with property values greater than or equal to the given value
+* `lessThan('propertyName', value)` -- range filter with property values less than the given value
+* `lessThanOrEqual('propertyName', value)` -- range filter with property values less than or equal to the given value
 * `sortAsc('propertyName')` and `sortDesc('propertyName')` -- can also be used multiple times, e.g. `sortAsc('tag').sortDesc(`date')` will first sort by tag ascending, and then by date descending.
 * `limit(5)` -- only return five results. If not specified, the default limit by ElasticSearch applies (which is at 10 by default)
 * `from(5)` -- return the results starting from the 6th one
@@ -347,4 +351,4 @@ In order to understand what's going on, the following commands are helpful:
 
 * use `./flow nodeindex:showMapping` to show the currently defined ElasticSearch Mapping
 * use the `.log()` statement inside queries to dump them to the ElasticSearch Log
-* the logfile `Data/Logs/ElasticSearch.log` contains loads of helpful information.
+* the logfile `Data/Logs/ElasticSearch.log` contains loads of helpful information.

Tests/Unit/Eel/ElasticSearchQueryBuilderTest.php

@@ -160,7 +160,6 @@ public function limitWorks() {
 		$this->assertSame(2, $actual['size']);
 	}
 
-
 	/**
 	 * @test
 	 */
@@ -175,6 +174,30 @@ public function sortDescWorks() {
 		$this->assertSame($expected, $actual['sort']);
 	}
 
+	public function rangeConstraintExamples() {
+		return array(
+			array('greaterThan', 'gt', 10),
+			array('greaterThanOrEqual', 'gte', 20),
+			array('lessThan', 'lt', 'now'),
+			array('lessThanOrEqual', 'lte', 40)
+		);
+	}
+
+	/**
+	 * @test
+	 * @dataProvider rangeConstraintExamples
+	 */
+	public function rangeConstraintsWork($constraint, $operator, $value) {
+		$this->queryBuilder->$constraint('fieldName', $value);
+		$expected = array(
+			'range' => array(
+				'fieldName' => array($operator => $value)
+			)
+		);
+		$actual = $this->queryBuilder->getRequest();
+		$this->assertInArray($expected, $actual['query']['filtered']['filter']['bool']['must']);
+	}
+
 	/**
 	 * Test helper
 	 *