FEATURE: Expose clauseType for comparation methods

Author: daniellienert

Classes/Eel/ElasticSearchQueryBuilder.php

@@ -238,55 +238,59 @@ public function exactMatch($propertyName, $value)
      *
      * @param string $propertyName Name of the property
      * @param mixed $value Value for comparison
+     * @param string $clauseType one of must, should, must_not
      * @return ElasticSearchQueryBuilder
-     * @api
      * @throws QueryBuildingException
+     * @api
      */
-    public function greaterThan($propertyName, $value)
+    public function greaterThan($propertyName, $value, string $clauseType = 'must')
     {
-        return $this->queryFilter('range', [$propertyName => ['gt' => $this->convertValue($value)]]);
+        return $this->queryFilter('range', [$propertyName => ['gt' => $this->convertValue($value)]], $clauseType);
     }
 
     /**
      * add a range filter (gte) for the given property
      *
      * @param string $propertyName Name of the property
      * @param mixed $value Value for comparison
+     * @param string $clauseType one of must, should, must_not
      * @return ElasticSearchQueryBuilder
      * @throws QueryBuildingException
      * @api
      */
-    public function greaterThanOrEqual($propertyName, $value)
+    public function greaterThanOrEqual($propertyName, $value, string $clauseType = 'must')
     {
-        return $this->queryFilter('range', [$propertyName => ['gte' => $this->convertValue($value)]]);
+        return $this->queryFilter('range', [$propertyName => ['gte' => $this->convertValue($value)]], $clauseType);
     }
 
     /**
      * add a range filter (lt) for the given property
      *
      * @param string $propertyName Name of the property
      * @param mixed $value Value for comparison
+     * @param string $clauseType one of must, should, must_not
      * @return ElasticSearchQueryBuilder
      * @api
      * @throws QueryBuildingException
      */
-    public function lessThan($propertyName, $value)
+    public function lessThan($propertyName, $value, string $clauseType = 'must')
     {
-        return $this->queryFilter('range', [$propertyName => ['lt' => $this->convertValue($value)]]);
+        return $this->queryFilter('range', [$propertyName => ['lt' => $this->convertValue($value)]], $clauseType);
     }
 
     /**
      * add a range filter (lte) for the given property
      *
      * @param string $propertyName Name of the property
      * @param mixed $value Value for comparison
+     * @param string $clauseType one of must, should, must_not
      * @return ElasticSearchQueryBuilder
      * @throws QueryBuildingException
      * @api
      */
-    public function lessThanOrEqual($propertyName, $value)
+    public function lessThanOrEqual($propertyName, $value, string $clauseType = 'must')
     {
-        return $this->queryFilter('range', [$propertyName => ['lte' => $this->convertValue($value)]]);
+        return $this->queryFilter('range', [$propertyName => ['lte' => $this->convertValue($value)]], $clauseType);
     }
 
     /**
@@ -299,11 +303,11 @@ public function lessThanOrEqual($propertyName, $value)
      * @param string $filterType
      * @param mixed $filterOptions
      * @param string $clauseType one of must, should, must_not
-     * @throws \Flowpack\ElasticSearch\ContentRepositoryAdaptor\Exception\QueryBuildingException
+     * @throws QueryBuildingException
      * @return ElasticSearchQueryBuilder
      * @api
      */
-    public function queryFilter($filterType, $filterOptions, $clauseType = 'must')
+    public function queryFilter($filterType, $filterOptions, string $clauseType = 'must')
     {
         $this->request->queryFilter($filterType, $filterOptions, $clauseType);
 
@@ -317,7 +321,7 @@ public function queryFilter($filterType, $filterOptions, $clauseType = 'must')
      *
      * @param string $path
      * @param array $data
-     * @throws \Flowpack\ElasticSearch\ContentRepositoryAdaptor\Exception\QueryBuildingException
+     * @throws QueryBuildingException
      * @return ElasticSearchQueryBuilder
      */
     public function appendAtPath($path, array $data)

README.md

@@ -123,10 +123,10 @@ Furthermore, the following operators are supported:
 
 * `nodeType('Your.Node:Type')`
 * `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
+* `greaterThan('propertyName', value, [clauseType])` -- range filter with property values greater than the given value
+* `greaterThanOrEqual('propertyName', value, [clauseType])` -- range filter with property values greater than or equal to the given value
+* `lessThan('propertyName', value, [clauseType])` -- range filter with property values less than the given value
+* `lessThanOrEqual('propertyName', value, [clauseType])` -- 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)
@@ -135,7 +135,9 @@ Furthermore, the following operators are supported:
 
 Furthermore, there is a more low-level operator which can be used to add arbitrary Elasticsearch filters:
 
-* `queryFilter("filterType", {option1: "value1"})`
+* `queryFilter("filterType", {option1: "value1"}, [clauseType])`
+
+The optional argument `clauseType` defaults to "must" and can be used to specify the boolean operator of the [bool query](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-bool-query.html). It has to be one of `must`, `should`, `must_not` or `filter`.	
 
 At lowest level, there is the `request` operator which allows to modify the request in arbitrary manner. Note that the existing request is merged with the passed-in type in case it is an array: