Merge pull request #239 from romaricdrigon/feat-217

Address annotation can be used over a getter

Author: norkunas

Doctrine/ORM/GeocoderListener.php

@@ -12,6 +12,7 @@
 
 namespace Bazinga\GeocoderBundle\Doctrine\ORM;
 
+use Bazinga\GeocoderBundle\Mapping\ClassMetadata;
 use Bazinga\GeocoderBundle\Mapping\Driver\DriverInterface;
 use Doctrine\Common\EventSubscriber;
 use Doctrine\ORM\Event\OnFlushEventArgs;
@@ -84,8 +85,15 @@ public function onFlush(OnFlushEventArgs $args)
 
     private function geocodeEntity($entity)
     {
+        /** @var ClassMetadata $metadata */
         $metadata = $this->driver->loadMetadataFromObject($entity);
-        $address = $metadata->addressProperty->getValue($entity);
+
+        if (null !== $metadata->addressGetter) {
+            $address = $metadata->addressGetter->invoke($entity);
+        } else {
+            $address = $metadata->addressProperty->getValue($entity);
+        }
+
         $results = $this->geocoder->geocodeQuery(GeocodeQuery::create($address));
 
         if (!empty($results)) {

Mapping/ClassMetadata.php

@@ -31,4 +31,9 @@ class ClassMetadata
      * @var \ReflectionProperty
      */
     public $longitudeProperty;
+
+    /**
+     * @var \ReflectionMethod
+     */
+    public $addressGetter;
 }

Mapping/Driver/AnnotationDriver.php

@@ -62,6 +62,16 @@ public function loadMetadataFromObject($object)
             }
         }
 
+        foreach ($reflection->getMethods(\ReflectionMethod::IS_PUBLIC) as $method) {
+            if ($this->reader->getMethodAnnotation($method, Annotations\Address::class)) {
+                if (0 !== $method->getNumberOfRequiredParameters()) {
+                    throw new \Exception('You can not use a method requiring parameters with @Address annotation!');
+                }
+
+                $metadata->addressGetter = $method;
+            }
+        }
+
         return $metadata;
     }
 }

Resources/doc/doctrine.md

@@ -34,6 +34,37 @@ class User
 }
 ```
 
+Instead of annotating a property, you can also annotate a getter:
+
+```php
+
+use Bazinga\GeocoderBundle\Mapping\Annotations as Geocoder;
+
+/**
+ * @Geocoder\Geocodeable
+ */
+class User
+{
+    /**
+     * @Geocoder\Latitude
+     */
+    private $latitude;
+
+    /**
+     * @Geocoder\Longitude
+     */
+    private $longitude;
+    
+    /**
+     * @Geocoder\Address
+     */
+    public function getAddress(): string
+    {
+        // Your code...
+    }
+}
+```
+
 Secondly, register the Doctrine event listener and its dependencies in your `services.yaml` file.  
 You have to indicate which provider to use to reverse geocode the address. Here we use `acme` provider we declared in bazinga_geocoder configuration earlier.
 

Tests/Doctrine/ORM/GeocoderListenerTest.php

@@ -74,13 +74,15 @@ protected function setUp()
 
         $sm = new SchemaTool($this->em);
         $sm->createSchema([
-            $this->em->getClassMetadata('Bazinga\GeocoderBundle\Tests\Doctrine\ORM\Dummy'),
+            $this->em->getClassMetadata('Bazinga\GeocoderBundle\Tests\Doctrine\ORM\DummyWithProperty'),
+            $this->em->getClassMetadata('Bazinga\GeocoderBundle\Tests\Doctrine\ORM\DummyWithGetter'),
+            $this->em->getClassMetadata('Bazinga\GeocoderBundle\Tests\Doctrine\ORM\DummyWithInvalidGetter'),
         ]);
     }
 
-    public function testPersist()
+    public function testPersistForProperty()
     {
-        $dummy = new Dummy();
+        $dummy = new DummyWithProperty();
         $dummy->address = 'Berlin, Germany';
 
         $this->em->persist($dummy);
@@ -98,13 +100,46 @@ public function testPersist()
         $this->assertNotEquals($clone->latitude, $dummy->latitude);
         $this->assertNotEquals($clone->longitude, $dummy->longitude);
     }
+
+    public function testPersistForGetter()
+    {
+        $dummy = new DummyWithGetter();
+        $dummy->setAddress('Berlin, Germany');
+
+        $this->em->persist($dummy);
+        $this->em->flush();
+
+        $this->assertNotNull($dummy->getLatitude());
+        $this->assertNotNull($dummy->getLongitude());
+
+        $clone = clone $dummy;
+        $dummy->setAddress('Paris, France');
+
+        $this->em->persist($dummy);
+        $this->em->flush();
+
+        $this->assertNotEquals($clone->getLatitude(), $dummy->getLatitude());
+        $this->assertNotEquals($clone->getLongitude(), $dummy->getLongitude());
+    }
+
+    public function testPersistForInvalidGetter()
+    {
+        $dummy = new DummyWithInvalidGetter();
+        $dummy->setAddress('Berlin, Germany');
+
+        $this->em->persist($dummy);
+
+        $this->expectException(\Exception::class);
+
+        $this->em->flush();
+    }
 }
 
 /**
  * @Geocodeable
  * @Entity
  */
-class Dummy
+class DummyWithProperty
 {
     /**
      * @Id @GeneratedValue
@@ -130,3 +165,129 @@ class Dummy
      */
     public $address;
 }
+
+/**
+ * @Geocodeable
+ * @Entity
+ */
+class DummyWithGetter
+{
+    /**
+     * @Id @GeneratedValue
+     * @Column(type="integer")
+     */
+    private $id;
+
+    /**
+     * @Latitude
+     * @Column
+     */
+    private $latitude;
+
+    /**
+     * @Longitude
+     * @Column
+     */
+    private $longitude;
+
+    /**
+     * @Column
+     */
+    private $_address;
+
+    public function setAddress($address)
+    {
+        $this->_address = $address;
+    }
+
+    /**
+     * @Address
+     */
+    public function getAddress()
+    {
+        return $this->_address;
+    }
+
+    public function getLatitude()
+    {
+        return $this->latitude;
+    }
+
+    public function setLatitude($latitude)
+    {
+        $this->latitude = $latitude;
+    }
+
+    public function getLongitude()
+    {
+        return $this->longitude;
+    }
+
+    public function setLongitude($longitude)
+    {
+        $this->longitude = $longitude;
+    }
+}
+
+/**
+ * @Geocodeable
+ * @Entity
+ */
+class DummyWithInvalidGetter
+{
+    /**
+     * @Id @GeneratedValue
+     * @Column(type="integer")
+     */
+    private $id;
+
+    /**
+     * @Latitude
+     * @Column
+     */
+    private $latitude;
+
+    /**
+     * @Longitude
+     * @Column
+     */
+    private $longitude;
+
+    /**
+     * @Column
+     */
+    private $_address;
+
+    public function setAddress($address)
+    {
+        $this->_address = $address;
+    }
+
+    /**
+     * @Address
+     */
+    public function getAddress($requiredParameter)
+    {
+        return $this->_address;
+    }
+
+    public function getLatitude()
+    {
+        return $this->latitude;
+    }
+
+    public function setLatitude($latitude)
+    {
+        $this->latitude = $latitude;
+    }
+
+    public function getLongitude()
+    {
+        return $this->longitude;
+    }
+
+    public function setLongitude($longitude)
+    {
+        $this->longitude = $longitude;
+    }
+}