new public method geocodeReverse and geocodeReverseAsync

Author: mtmail

README.md

@@ -59,7 +59,7 @@ print_r($result);
 
 ```php
 $geocoder = new \OpenCage\Geocoder\Geocoder('YOUR-API-KEY');
-$result = $geocoder->geocode('43.831,4.360'); # latitude,longitude (y,x)
+$result = $geocoder->geocodeReverse(43.831, 4.360); # latitude, longitude
 print $result['results'][0]['formatted'];
 // 3 Rue de Rivarol, 30020 Nîmes, France
 ```
@@ -101,6 +101,11 @@ $results = \GuzzleHttp\Promise\Utils::unwrap($promises);
 print $results['london']['results'][0]['formatted'];
 print $results['paris']['results'][0]['formatted'];
 print $results['tokyo']['results'][0]['formatted'];
+
+// async reverse geocoding
+$promise = $geocoder->geocodeReverseAsync(43.831, 4.360);
+$result = $promise->wait();
+print $result['results'][0]['formatted'];
 ```
 
 ### Set a proxy URL

src/Geocoder.php

@@ -82,6 +82,21 @@ public function geocode(string $query, array $optParams = []): array
         return $ret;
     }
 
+    /**
+     * @param array<string, string> $optParams
+     * @return array{status: array{code: int, message: string}, results: list<mixed>, total_results: int, ...}
+     */
+    public function geocodeReverse(float|string $latitude, float|string $longitude, array $optParams = []): array
+    {
+        return $this->geocode($latitude . ',' . $longitude, $optParams);
+    }
+
+    /** @param array<string, string> $optParams */
+    public function geocodeReverseAsync(float|string $latitude, float|string $longitude, array $optParams = []): PromiseInterface
+    {
+        return $this->geocodeAsync($latitude . ',' . $longitude, $optParams);
+    }
+
     /** @param array<string, string> $optParams */
     public function geocodeAsync(string $query, array $optParams = []): PromiseInterface
     {

tests/GeocoderTest.php

@@ -112,11 +112,29 @@ public function testWithOptionalParams(): void
     public function testReverseGeocode(): void
     {
         $geocoder = new Geocoder(self::OPENCAGE_TEST_APIKEY_200);
-        $result = $geocoder->geocode('51.5227,-0.1025');
+        $result = $geocoder->geocodeReverse(51.5227, -0.1025);
         $this->assertEquals(200, $result['status']['code']);
         $this->assertGreaterThan(0, $result['total_results']);
     }
 
+    public function testReverseGeocodeWithStrings(): void
+    {
+        $geocoder = new Geocoder(self::OPENCAGE_TEST_APIKEY_200);
+        $result = $geocoder->geocodeReverse('51.5227', '-0.1025');
+        $this->assertEquals(200, $result['status']['code']);
+        $this->assertGreaterThan(0, $result['total_results']);
+    }
+
+    public function testReverseGeocodeAsync(): void
+    {
+        $geocoder = new Geocoder(self::OPENCAGE_TEST_APIKEY_200);
+        $promise = $geocoder->geocodeReverseAsync(51.5227, -0.1025);
+        /** @var array{status: array{code: int, message: string}} $result */
+        $result = $promise->wait();
+
+        $this->assertEquals(200, $result['status']['code']);
+    }
+
     public function testInvalidProxy(): void
     {
         $geocoder = new Geocoder(self::OPENCAGE_TEST_APIKEY_200);