Improve locality for city layer & Add layer & radius query params

Author: ybert

src/Provider/Photon/Model/PhotonAddress.php

@@ -54,6 +54,21 @@ final class PhotonAddress extends Address
      */
     private $district;
 
+    /**
+     * @var string|null
+     */
+    private $type;
+
+    public function getLocality(): ?string
+    {
+        $locality = parent::getLocality();
+        if ($locality === null && $this->type === 'city' && $this->name !== null) {
+            $locality = $this->name;
+        }
+
+        return $locality;
+    }
+
     /**
      * @return string|null
      */
@@ -173,4 +188,17 @@ public function withDistrict(?string $district = null): self
 
         return $new;
     }
+
+    public function getType(): ?string
+    {
+        return $this->type;
+    }
+
+    public function withType(?string $type = null): self
+    {
+        $new = clone $this;
+        $new->type = $type;
+
+        return $new;
+    }
 }

src/Provider/Photon/Photon.php

@@ -68,6 +68,7 @@ public function geocodeQuery(GeocodeQuery $query): Collection
             .'/api?'
             .http_build_query([
                 'q' => $address,
+                'layer' => $query->getData('layer'),
                 'limit' => $query->getLimit(),
                 'lang' => $query->getLocale(),
             ]);
@@ -102,6 +103,8 @@ public function reverseQuery(ReverseQuery $query): Collection
             .http_build_query([
                 'lat' => $latitude,
                 'lon' => $longitude,
+                'layer' => $query->getData('layer'),
+                'radius' => $query->getData('radius'),
                 'limit' => $query->getLimit(),
                 'lang' => $query->getLocale(),
             ]);
@@ -157,7 +160,8 @@ private function featureToAddress(\stdClass $feature): Location
             ->withName($properties->name ?? null)
             ->withState($properties->state ?? null)
             ->withCounty($properties->county ?? null)
-            ->withDistrict($properties->district ?? null);
+            ->withDistrict($properties->district ?? null)
+            ->withType($properties->type ?? null);
 
         return $address;
     }

src/Provider/Photon/Tests/.cached_responses/photon.komoot.io_1452fda1b72428b0f5de90de04038275fd7f7e7e

@@ -0,0 +1 @@
+s:334:"{"features":[{"geometry":{"coordinates":[13.3989367,52.510885],"type":"Point"},"type":"Feature","properties":{"osm_type":"R","osm_id":62422,"extent":[13.088345,52.6755087,13.7611609,52.3382448],"country":"Deutschland","osm_key":"place","countrycode":"DE","osm_value":"city","name":"Berlin","type":"city"}}],"type":"FeatureCollection"}";

src/Provider/Photon/Tests/PhotonTest.php

@@ -178,4 +178,18 @@ public function testReverseQueryWithOsmTagFilter(): void
             $this->assertEquals('pharmacy', $result->getOSMTag()->value);
         }
     }
+
+    public function testReverseQueryWithLayerCityAndRadiusFilter(): void
+    {
+        $provider = Photon::withKomootServer($this->getHttpClient());
+        $reverseQuery = ReverseQuery::fromCoordinates(52.51644, 13.38890)
+            ->withData('layer', 'city')
+            ->withData('radius', 20)
+            ->withLimit(1);
+        $result = $provider->reverseQuery($reverseQuery)->first();
+
+        $this->assertInstanceOf(PhotonAddress::class, $result);
+        $this->assertEquals('city', $result->getType());
+        $this->assertEquals('Berlin', $result->getLocality());
+    }
 }