[Nominatim] Add support for "quarter" (OpenStreetMap) (#1099)

Author: jkobus

src/Provider/Nominatim/Model/NominatimAddress.php

@@ -34,6 +34,11 @@ final class NominatimAddress extends Address
      */
     private $displayName;
 
+    /**
+     * @var string|null
+     */
+    private $quarter;
+
     /**
      * @var string|null
      */
@@ -196,4 +201,25 @@ public function withType(string $type = null): self
 
         return $new;
     }
+
+    /**
+     * @return string|null
+     */
+    public function getQuarter(): ?string
+    {
+        return $this->quarter;
+    }
+
+    /**
+     * @param string|null $quarter
+     *
+     * @return NominatimAddress
+     */
+    public function withQuarter(string $quarter = null): self
+    {
+        $new = clone $this;
+        $new->quarter = $quarter;
+
+        return $new;
+    }
 }

src/Provider/Nominatim/Nominatim.php

@@ -228,10 +228,15 @@ private function jsonResultToLocation(\stdClass $place, bool $reverse): Location
 
         $builder->setBounds($place->boundingbox[0], $place->boundingbox[2], $place->boundingbox[1], $place->boundingbox[3]);
 
+        /** @var NominatimAddress $location */
         $location = $builder->build(NominatimAddress::class);
         $location = $location->withAttribution($place->licence);
         $location = $location->withDisplayName($place->display_name);
 
+        if (isset($place->address->quarter)) {
+            $location = $location->withQuarter($place->address->quarter);
+        }
+
         if (isset($place->osm_id)) {
             $location = $location->withOSMId(intval($place->osm_id));
         }

src/Provider/Nominatim/Tests/.cached_responses/nominatim.openstreetmap.org_587636b4f0e7139858b4390498946009583bc32d

@@ -0,0 +1 @@
+s:625:"[{"place_id":219601027,"licence":"Data © OpenStreetMap contributors, ODbL 1.0. https://osm.org/copyright","osm_type":"way","osm_id":625792441,"boundingbox":["52.1875624","52.1884584","20.9880299","20.9890588"],"lat":"52.18810065","lon":"20.98854576935957","display_name":"Woronicza, Służewiec, Mokotów, Warszawa, województwo mazowieckie, Polska","place_rank":22,"category":"landuse","type":"construction","importance":0.5,"address":{"landuse":"Woronicza","quarter":"Służewiec","suburb":"Mokotów","city_district":"Warszawa","city":"Warszawa","state":"województwo mazowieckie","country":"Polska","country_code":"pl"}}]";

src/Provider/Nominatim/Tests/NominatimTest.php

@@ -109,6 +109,17 @@ public function testGeocodeWithRealAddress()
         $this->assertEquals('yes', $result->getType());
     }
 
+    public function testGeocodeWithRealAddressThatReturnsOptionalQuarter()
+    {
+        $provider = Nominatim::withOpenStreetMapServer($this->getHttpClient(), 'Geocoder PHP/Nominatim Provider/Nominatim Test');
+        $results = $provider->geocodeQuery(GeocodeQuery::create('woronicza 17, warszawa, polska'));
+
+        $this->assertCount(1, $results);
+
+        /* @var \Geocoder\Provider\Nominatim\Model\NominatimAddress $result */
+        $this->assertEquals('Służewiec', $results->first()->getQuarter());
+    }
+
     public function testGeocodeWithCountrycodes()
     {
         $provider = Nominatim::withOpenStreetMapServer($this->getHttpClient(), 'Geocoder PHP/Nominatim Provider/Nominatim Test');