Add total hits relation in ResultSelt (#1694)

Author: deguif

CHANGELOG.md

@@ -5,9 +5,15 @@ All notable changes to this project will be documented in this file based on the
 
 ### Backward Compatibility Breaks
 
+* The class `\Elastica\QueryBuilder\Version\Version240` has been moved to `\Elastica\QueryBuilder\Version\Version700` [#1693](https://github.com/ruflin/Elastica/pull/1693)
+
 ### Bugfixes
 
+* The `\Elastica\Query\GeoPolygon::count()` method now returns the count of points passed to the filter [#1696](https://github.com/ruflin/Elastica/pull/1696)
+
 ### Added
+
+* Added `\Elastica\ResultSet::getTotalHitsRelation()` to get relation for total hits [#1694](https://github.com/ruflin/Elastica/pull/1694)
 * Added `Sampler` aggregation [#1688](https://github.com/ruflin/Elastica/pull/1688)
 
 ### Improvements
@@ -19,7 +25,6 @@ All notable changes to this project will be documented in this file based on the
 
 ### Backward Compatibility Breaks
 * The class `\Elastica\Type\Mapping` has been moved to `\Elastica\Mapping` [#1666](https://github.com/ruflin/Elastica/pull/1666)
-* The class `\Elastica\QueryBuilder\Version\Version240` has been moved to `\Elastica\QueryBuilder\Version\Version700` and type query was removed [#1693](https://github.com/ruflin/Elastica/pull/1693)
 * The `\Elastica\Query::$_suggest` property has been renamed to `$hasSuggest` and is now private, it should not be used from extending classes [#1679](https://github.com/ruflin/Elastica/pull/1679)
 * `\Elastica\Document` expects a string as ID, not an int [#1672](https://github.com/ruflin/Elastica/pull/1672).
 * Removed `\Elastica\Query\GeohashCell` query, use `\Elastica\Query\GeoBoundingBox` instead [#1672](https://github.com/ruflin/Elastica/pull/1672).
@@ -50,7 +55,6 @@ All notable changes to this project will be documented in this file based on the
 
 ### Bugfixes
 
-* The `\Elastica\Query\GeoPolygon::count()` method now returns the count of points passed to the filter [#1696](https://github.com/ruflin/Elastica/pull/1696)
 * Always set the Guzzle `base_uri` to support connecting to multiple ES hosts. [#1618](https://github.com/ruflin/Elastica/pull/1618)
 * Properly handle underscore prefixes in options and bulk request metadata ([cf upstream](https://github.com/elastic/elasticsearch/issues/26886). [#1621](https://github.com/ruflin/Elastica/pull/1621)
 * Preserve zeros while doing float serialization to JSON. [#1635](https://github.com/ruflin/Elastica/pull/1635)

lib/Elastica/ResultSet.php

@@ -160,6 +160,16 @@ public function getTotalHits()
         return (int) ($data['hits']['total']['value'] ?? 0);
     }
 
+    /**
+     * Returns the total number relation of found hits.
+     */
+    public function getTotalHitsRelation(): string
+    {
+        $data = $this->_response->getData();
+
+        return $data['hits']['total']['relation'] ?? 'eq';
+    }
+
     /**
      * Returns the max score of the results found.
      *

test/Elastica/QueryTest.php

@@ -572,13 +572,16 @@ public function testSetTrackTotalHits()
 
         $resultSet = $index->search($query);
         $this->assertEquals(50, $resultSet->getTotalHits());
+        $this->assertEquals('eq', $resultSet->getTotalHitsRelation());
 
         $query->setTrackTotalHits(false);
         $resultSet = $index->search($query);
         $this->assertEquals(0, $resultSet->getTotalHits());
+        $this->assertEquals('eq', $resultSet->getTotalHitsRelation());
 
         $query->setTrackTotalHits(25);
         $resultSet = $index->search($query);
         $this->assertEquals(25, $resultSet->getTotalHits());
+        $this->assertEquals('gte', $resultSet->getTotalHitsRelation());
     }
 }

test/Elastica/ResultSetTest.php

@@ -27,6 +27,7 @@ public function testGetters()
 
         $this->assertInstanceOf(ResultSet::class, $resultSet);
         $this->assertEquals(3, $resultSet->getTotalHits());
+        $this->assertEquals('eq', $resultSet->getTotalHitsRelation());
         $this->assertGreaterThan(0, $resultSet->getMaxScore());
         $this->assertNotTrue($resultSet->hasTimedOut());
         $this->assertNotTrue($resultSet->hasAggregations());