[Geocoding] Allow to filter address components by type

egeloen · Feb 17, 2013 · beac0c6 · beac0c6
1 parent 6e09bc5
commit beac0c6
Show file tree

Hide file tree

Showing 3 changed files with 48 additions and 3 deletions.
diff --git a/doc/usage/services/geocoding/ivory_geocoder.md b/doc/usage/services/geocoding/ivory_geocoder.md
@@ -92,6 +92,18 @@ foreach ($results as $result) {
 }
 ```
 
+You can filter the address components by type:
+
+``` php
+// Get the geocoder results
+$results = $response->getResults();
+
+foreach ($results as $result) {
+    foreach ($result->getAddressComponents('route') as $addressComponent) {
+        // ...
+    }
+}
+
 #### Geometry informations
 
 Geometry contains the following information:

diff --git a/src/Ivory/GoogleMap/Services/Geocoding/Result/GeocoderResult.php b/src/Ivory/GoogleMap/Services/Geocoding/Result/GeocoderResult.php
@@ -63,11 +63,25 @@ public function __construct(
     /**
      * Gets the address components.
      *
+     * @param string|null The type of the address components.
+     *
      * @return array The address components.
      */
-    public function getAddressComponents()
+    public function getAddressComponents($type = null)
     {
-        return $this->addressComponents;
+        if ($type === null) {
+            return $this->addressComponents;
+        }
+
+        $addressComponents = array();
+
+        foreach ($this->addressComponents as $addressComponent) {
+            if (in_array($type, $addressComponent->getTypes())) {
+                $addressComponents[] = $addressComponent;
+            }
+        }
+
+        return $addressComponents;
     }
 
     /**

diff --git a/tests/Ivory/Tests/GoogleMap/Services/Geocoding/Result/GeocoderResultTest.php b/tests/Ivory/Tests/GoogleMap/Services/Geocoding/Result/GeocoderResultTest.php
@@ -87,7 +87,7 @@ public function testInitialState()
         $this->assertSame($this->partialMatch, $this->geocoderResult->isPartialMatch());
     }
 
-    public function testAddressComponents()
+    public function testAddressComponentsWithoutType()
     {
         $addressComponent = $this->getMockBuilder('Ivory\GoogleMap\Services\Geocoding\Result\GeocoderAddressComponent')
             ->disableOriginalConstructor()
@@ -100,6 +100,25 @@ public function testAddressComponents()
         $this->assertSame($addressComponents, $this->geocoderResult->getAddressComponents());
     }
 
+    public function testAddressComponentsWithType()
+    {
+        $addressComponent = $this->getMockBuilder('Ivory\GoogleMap\Services\Geocoding\Result\GeocoderAddressComponent')
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        $addressComponent
+            ->expects($this->any())
+            ->method('getTypes')
+            ->will($this->returnValue(array('foo')));
+
+        $addressComponents = array($addressComponent);
+
+        $this->geocoderResult->setAddressComponents($addressComponents);
+
+        $this->assertSame($addressComponents, $this->geocoderResult->getAddressComponents('foo'));
+        $this->assertEmpty($this->geocoderResult->getAddressComponents('bar'));
+    }
+
     public function testFormattedAddressWithValidValue()
     {
         $this->geocoderResult->setFormattedAddress('formatted_address');