feat: Adds Doctrine attributes to map common Location properties

AymDev · AymDev · commit df92455892a9 · 2026-02-03T14:06:19.000+01:00
Adds additionnal attributes to be able to automatically map them
to Doctrine entities.
diff --git a/src/Doctrine/ORM/GeocodeEntityListener.php b/src/Doctrine/ORM/GeocodeEntityListener.php
@@ -107,6 +107,16 @@ private function geocodeEntity(ClassMetadata $metadata, object $entity): void
             $result = $results->first();
             $metadata->latitudeProperty?->setValue($entity, $result->getCoordinates()->getLatitude());
             $metadata->longitudeProperty?->setValue($entity, $result->getCoordinates()->getLongitude());
+            $metadata->northProperty?->setValue($entity, $result->getBounds()?->getNorth());
+            $metadata->southProperty?->setValue($entity, $result->getBounds()?->getSouth());
+            $metadata->eastProperty?->setValue($entity, $result->getBounds()?->getEast());
+            $metadata->westProperty?->setValue($entity, $result->getBounds()?->getWest());
+            $metadata->streetNumberProperty?->setValue($entity, $result->getStreetNumber());
+            $metadata->streetNameProperty?->setValue($entity, $result->getStreetName());
+            $metadata->localityProperty?->setValue($entity, $result->getLocality());
+            $metadata->postalCodeProperty?->setValue($entity, $result->getPostalCode());
+            $metadata->subLocalityProperty?->setValue($entity, $result->getSubLocality());
+            $metadata->countryProperty?->setValue($entity, $result->getCountry());
         }
     }
 
diff --git a/src/Mapping/Attributes/Country.php b/src/Mapping/Attributes/Country.php
@@ -0,0 +1,16 @@
+<?php
+
+/*
+ * This file is part of the BazingaGeocoderBundle package.
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @license    MIT License
+ */
+
+namespace Bazinga\GeocoderBundle\Mapping\Attributes;
+
+#[\Attribute(\Attribute::TARGET_PROPERTY)]
+class Country
+{
+}
diff --git a/src/Mapping/Attributes/East.php b/src/Mapping/Attributes/East.php
@@ -0,0 +1,16 @@
+<?php
+
+/*
+ * This file is part of the BazingaGeocoderBundle package.
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @license    MIT License
+ */
+
+namespace Bazinga\GeocoderBundle\Mapping\Attributes;
+
+#[\Attribute(\Attribute::TARGET_PROPERTY)]
+class East
+{
+}
diff --git a/src/Mapping/Attributes/Locality.php b/src/Mapping/Attributes/Locality.php
@@ -0,0 +1,16 @@
+<?php
+
+/*
+ * This file is part of the BazingaGeocoderBundle package.
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @license    MIT License
+ */
+
+namespace Bazinga\GeocoderBundle\Mapping\Attributes;
+
+#[\Attribute(\Attribute::TARGET_PROPERTY)]
+class Locality
+{
+}
diff --git a/src/Mapping/Attributes/North.php b/src/Mapping/Attributes/North.php
@@ -0,0 +1,16 @@
+<?php
+
+/*
+ * This file is part of the BazingaGeocoderBundle package.
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @license    MIT License
+ */
+
+namespace Bazinga\GeocoderBundle\Mapping\Attributes;
+
+#[\Attribute(\Attribute::TARGET_PROPERTY)]
+class North
+{
+}
diff --git a/src/Mapping/Attributes/PostalCode.php b/src/Mapping/Attributes/PostalCode.php
@@ -0,0 +1,16 @@
+<?php
+
+/*
+ * This file is part of the BazingaGeocoderBundle package.
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @license    MIT License
+ */
+
+namespace Bazinga\GeocoderBundle\Mapping\Attributes;
+
+#[\Attribute(\Attribute::TARGET_PROPERTY)]
+class PostalCode
+{
+}
diff --git a/src/Mapping/Attributes/South.php b/src/Mapping/Attributes/South.php
@@ -0,0 +1,16 @@
+<?php
+
+/*
+ * This file is part of the BazingaGeocoderBundle package.
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @license    MIT License
+ */
+
+namespace Bazinga\GeocoderBundle\Mapping\Attributes;
+
+#[\Attribute(\Attribute::TARGET_PROPERTY)]
+class South
+{
+}
diff --git a/src/Mapping/Attributes/StreetName.php b/src/Mapping/Attributes/StreetName.php
@@ -0,0 +1,16 @@
+<?php
+
+/*
+ * This file is part of the BazingaGeocoderBundle package.
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @license    MIT License
+ */
+
+namespace Bazinga\GeocoderBundle\Mapping\Attributes;
+
+#[\Attribute(\Attribute::TARGET_PROPERTY)]
+class StreetName
+{
+}
diff --git a/src/Mapping/Attributes/StreetNumber.php b/src/Mapping/Attributes/StreetNumber.php
@@ -0,0 +1,16 @@
+<?php
+
+/*
+ * This file is part of the BazingaGeocoderBundle package.
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @license    MIT License
+ */
+
+namespace Bazinga\GeocoderBundle\Mapping\Attributes;
+
+#[\Attribute(\Attribute::TARGET_PROPERTY)]
+class StreetNumber
+{
+}
diff --git a/src/Mapping/Attributes/SubLocality.php b/src/Mapping/Attributes/SubLocality.php
@@ -0,0 +1,16 @@
+<?php
+
+/*
+ * This file is part of the BazingaGeocoderBundle package.
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @license    MIT License
+ */
+
+namespace Bazinga\GeocoderBundle\Mapping\Attributes;
+
+#[\Attribute(\Attribute::TARGET_PROPERTY)]
+class SubLocality
+{
+}
diff --git a/src/Mapping/Attributes/West.php b/src/Mapping/Attributes/West.php
@@ -0,0 +1,16 @@
+<?php
+
+/*
+ * This file is part of the BazingaGeocoderBundle package.
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @license    MIT License
+ */
+
+namespace Bazinga\GeocoderBundle\Mapping\Attributes;
+
+#[\Attribute(\Attribute::TARGET_PROPERTY)]
+class West
+{
+}
diff --git a/src/Mapping/ClassMetadata.php b/src/Mapping/ClassMetadata.php
@@ -26,6 +26,16 @@ public function __construct(
         public readonly ?\ReflectionProperty $latitudeProperty = null,
         public readonly ?\ReflectionProperty $longitudeProperty = null,
         public readonly ?\ReflectionMethod $addressGetter = null,
+        public readonly ?\ReflectionProperty $northProperty = null,
+        public readonly ?\ReflectionProperty $southProperty = null,
+        public readonly ?\ReflectionProperty $eastProperty = null,
+        public readonly ?\ReflectionProperty $westProperty = null,
+        public readonly ?\ReflectionProperty $streetNumberProperty = null,
+        public readonly ?\ReflectionProperty $streetNameProperty = null,
+        public readonly ?\ReflectionProperty $localityProperty = null,
+        public readonly ?\ReflectionProperty $postalCodeProperty = null,
+        public readonly ?\ReflectionProperty $subLocalityProperty = null,
+        public readonly ?\ReflectionProperty $countryProperty = null,
     ) {
     }
 }
diff --git a/src/Mapping/Driver/AttributeDriver.php b/src/Mapping/Driver/AttributeDriver.php
@@ -23,6 +23,22 @@
  */
 final class AttributeDriver implements DriverInterface
 {
+    private const PROPERTY_MATRIX = [
+        Attributes\Latitude::class => 'latitudeProperty',
+        Attributes\Longitude::class => 'longitudeProperty',
+        Attributes\Address::class => 'addressProperty',
+        Attributes\North::class => 'northProperty',
+        Attributes\South::class => 'southProperty',
+        Attributes\East::class => 'eastProperty',
+        Attributes\West::class => 'westProperty',
+        Attributes\StreetNumber::class => 'streetNumberProperty',
+        Attributes\StreetName::class => 'streetNameProperty',
+        Attributes\Locality::class => 'localityProperty',
+        Attributes\PostalCode::class => 'postalCodeProperty',
+        Attributes\SubLocality::class => 'subLocalityProperty',
+        Attributes\Country::class => 'countryProperty',
+    ];
+
     public function isGeocodeable(object $object): bool
     {
         $reflection = self::getReflection($object);
@@ -47,12 +63,8 @@ public function loadMetadataFromObject(object $object): ClassMetadata
 
         foreach ($reflection->getProperties() as $property) {
             foreach ($property->getAttributes() as $attribute) {
-                if (Attributes\Latitude::class === $attribute->getName()) {
-                    $args['latitudeProperty'] = $property;
-                } elseif (Attributes\Longitude::class === $attribute->getName()) {
-                    $args['longitudeProperty'] = $property;
-                } elseif (Attributes\Address::class === $attribute->getName()) {
-                    $args['addressProperty'] = $property;
+                if (isset(self::PROPERTY_MATRIX[$attribute->getName()])) {
+                    $args[self::PROPERTY_MATRIX[$attribute->getName()]] = $property;
                 }
             }
         }
diff --git a/tests/Functional/Fixtures/Entity/DummyWithProperty.php b/tests/Functional/Fixtures/Entity/DummyWithProperty.php
@@ -13,9 +13,19 @@
 namespace Bazinga\GeocoderBundle\Tests\Functional\Fixtures\Entity;
 
 use Bazinga\GeocoderBundle\Mapping\Attributes\Address;
+use Bazinga\GeocoderBundle\Mapping\Attributes\Country;
+use Bazinga\GeocoderBundle\Mapping\Attributes\East;
 use Bazinga\GeocoderBundle\Mapping\Attributes\Geocodeable;
 use Bazinga\GeocoderBundle\Mapping\Attributes\Latitude;
+use Bazinga\GeocoderBundle\Mapping\Attributes\Locality;
 use Bazinga\GeocoderBundle\Mapping\Attributes\Longitude;
+use Bazinga\GeocoderBundle\Mapping\Attributes\North;
+use Bazinga\GeocoderBundle\Mapping\Attributes\PostalCode;
+use Bazinga\GeocoderBundle\Mapping\Attributes\South;
+use Bazinga\GeocoderBundle\Mapping\Attributes\StreetName;
+use Bazinga\GeocoderBundle\Mapping\Attributes\StreetNumber;
+use Bazinga\GeocoderBundle\Mapping\Attributes\SubLocality;
+use Bazinga\GeocoderBundle\Mapping\Attributes\West;
 use Doctrine\DBAL\Types\Types;
 use Doctrine\ORM\Mapping\Column;
 use Doctrine\ORM\Mapping\Entity;
@@ -42,4 +52,44 @@ class DummyWithProperty
     #[Column(type: Types::STRING)]
     #[Address]
     public ?string $address = null;
+
+    #[Column(type: Types::FLOAT, nullable: true)]
+    #[North]
+    public ?float $north = null;
+
+    #[Column(type: Types::FLOAT, nullable: true)]
+    #[South]
+    public ?float $south = null;
+
+    #[Column(type: Types::FLOAT, nullable: true)]
+    #[East]
+    public ?float $east = null;
+
+    #[Column(type: Types::FLOAT, nullable: true)]
+    #[West]
+    public ?float $west = null;
+
+    #[Column(type: Types::STRING, nullable: true)]
+    #[StreetNumber]
+    public int|string|null $streetNumber = null;
+
+    #[Column(type: Types::STRING, nullable: true)]
+    #[StreetName]
+    public ?string $streetName = null;
+
+    #[Column(type: Types::STRING, nullable: true)]
+    #[Locality]
+    public ?string $locality = null;
+
+    #[Column(type: Types::STRING, nullable: true)]
+    #[PostalCode]
+    public ?string $postalCode = null;
+
+    #[Column(type: Types::STRING, nullable: true)]
+    #[SubLocality]
+    public ?string $subLocality = null;
+
+    #[Column(type: Types::STRING, nullable: true)]
+    #[Country]
+    public ?string $country = null;
 }
diff --git a/tests/Functional/GeocodeEntityListenerTest.php b/tests/Functional/GeocodeEntityListenerTest.php
diff --git a/tests/Mapping/Driver/AttributeDriverTest.php b/tests/Mapping/Driver/AttributeDriverTest.php
diff --git a/tests/Mapping/Driver/Fixtures/Dummy.php b/tests/Mapping/Driver/Fixtures/Dummy.php
