Auto register doctrine services, and support multiple metadata drivers

Author: pierredup

Mapping/Driver/AttributeDriver.php

@@ -0,0 +1,83 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * 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\Driver;
+
+use Bazinga\GeocoderBundle\Mapping\Attributes;
+use Bazinga\GeocoderBundle\Mapping\ClassMetadata;
+use Bazinga\GeocoderBundle\Mapping\Exception\MappingException;
+use Doctrine\Common\Util\ClassUtils;
+
+/**
+ * @author Pierre du Plessis <[email protected]>
+ */
+final class AttributeDriver implements DriverInterface
+{
+    public function isGeocodeable($object): bool
+    {
+        if (PHP_VERSION_ID < 80000) {
+            return false;
+        }
+
+        $reflection = ClassUtils::newReflectionObject($object);
+
+        return count($reflection->getAttributes(Annotations\Geocodeable::class)) > 0;
+    }
+
+    /**
+     * @throws MappingException
+     */
+    public function loadMetadataFromObject($object): ClassMetadata
+    {
+        if (PHP_VERSION_ID < 80000) {
+            throw new MappingException(sprintf('The class %s is not geocodeable', get_class($object)));
+        }
+
+        $reflection = ClassUtils::newReflectionObject($object);
+
+        $attributes = $reflection->getAttributes(Attributes\Geocodeable::class);
+
+        if (0 === count($attributes)) {
+            throw new MappingException(sprintf('The class %s is not geocodeable', get_class($object)));
+        }
+
+        $metadata = new ClassMetadata();
+        $metadata->provider = $attributes[0]->newInstance()->provider;
+
+        foreach ($reflection->getProperties() as $property) {
+            foreach ($property->getAttributes() as $attribute) {
+                if (Attributes\Latitude::class === $attribute->getName()) {
+                    $property->setAccessible(true);
+                    $metadata->latitudeProperty = $property;
+                } elseif (Attributes\Longitude::class === $attribute->getName()) {
+                    $property->setAccessible(true);
+                    $metadata->longitudeProperty = $property;
+                } elseif (Attributes\Address::class === $attribute->getName()) {
+                    $property->setAccessible(true);
+                    $metadata->addressProperty = $property;
+                }
+            }
+        }
+
+        foreach ($reflection->getMethods(\ReflectionMethod::IS_PUBLIC) as $method) {
+            if (count($method->getAttributes(Annotations\Address::class)) > 0) {
+                if (0 !== $method->getNumberOfRequiredParameters()) {
+                    throw new MappingException('You can not use a method requiring parameters with #[Address] attribute!');
+                }
+
+                $metadata->addressGetter = $method;
+            }
+        }
+
+        return $metadata;
+    }
+}

Resources/config/doctrine.yml

@@ -0,0 +1,15 @@
+services:
+    Bazinga\GeocoderBundle\Mapping\Driver\AnnotationDriver:
+        class: Bazinga\GeocoderBundle\Mapping\Driver\AnnotationDriver
+        arguments:
+            - '@annotations.reader'
+        tags:
+            - { name: bazinga_geocoder.metadata.driver }
+
+    Bazinga\GeocoderBundle\Doctrine\ORM\GeocoderListener:
+        class: Bazinga\GeocoderBundle\Doctrine\ORM\GeocoderListener
+        arguments:
+            - !tagged_locator 'bazinga_geocoder.provider'
+            - '@Bazinga\GeocoderBundle\Mapping\Driver\DriverInterface'
+        tags:
+            - doctrine.event_subscriber

Resources/config/services.yml

@@ -0,0 +1,52 @@
+services:
+    _instanceof:
+        Geocoder\Dumper\Dumper:
+            tags: ['bazinga_geocoder.dumper']
+            public: true
+
+    Geocoder\Dumper\GeoArray: ~
+    Geocoder\Dumper\GeoJson: ~
+    Geocoder\Dumper\Gpx: ~
+    Geocoder\Dumper\Kml: ~
+    Geocoder\Dumper\Wkb: ~
+    Geocoder\Dumper\Wkt: ~
+
+    Bazinga\GeocoderBundle\ProviderFactory\:
+        resource: '../../ProviderFactory'
+        public: false
+        autowire: true
+        autoconfigure: true
+
+    Geocoder\ProviderAggregator:
+        class: Geocoder\ProviderAggregator
+
+    Bazinga\GeocoderBundle\Plugin\FakeIpPlugin:
+        class: Bazinga\GeocoderBundle\Plugin\FakeIpPlugin
+        arguments: [~, ~, false]
+
+    Bazinga\GeocoderBundle\Command\GeocodeCommand:
+        arguments: ['@Geocoder\ProviderAggregator']
+        tags: ['console.command']
+
+    Bazinga\GeocoderBundle\Validator\Constraint\AddressValidator:
+        arguments: ['@geocoder']
+        tags: ['validator.constraint_validator']
+
+    # Keep these aliases for BC purpose
+    bazinga_geocoder.geocoder:
+        alias: "Geocoder\\ProviderAggregator"
+
+    geocoder:
+        alias: "Geocoder\\ProviderAggregator"
+
+    Bazinga\GeocoderBundle\Mapping\Driver\ChainDriver:
+        class: Bazinga\GeocoderBundle\Mapping\Driver\ChainDriver
+        arguments:
+            - !tagged_iterator bazinga_geocoder.metadata.driver
+
+    Bazinga\GeocoderBundle\Mapping\Driver\AttributeDriver:
+        class: Bazinga\GeocoderBundle\Mapping\Driver\AttributeDriver
+        tags:
+            - { name: bazinga_geocoder.metadata.driver }
+
+    Bazinga\GeocoderBundle\Mapping\Driver\DriverInterface: '@Bazinga\GeocoderBundle\Mapping\Driver\ChainDriver'

Resources/doc/doctrine.md

@@ -0,0 +1,99 @@
+# Doctrine annotation support
+
+*[<< Back to documentation index](/Resources/doc/index.md)*
+
+Wouldn't it be great if you could automatically save the coordinates of a users
+address every time it is updated? Wait not more here is the feature you been always
+wanted.
+
+First of all, update your entity:
+
+```php
+
+use Bazinga\GeocoderBundle\Mapping\Annotations as Geocoder;
+
+/**
+ * @Geocoder\Geocodeable
+ */
+class User
+{
+    /**
+     * @Geocoder\Address
+     */
+    private $address;
+
+    /**
+     * @Geocoder\Latitude
+     */
+    private $latitude;
+
+    /**
+     * @Geocoder\Longitude
+     */
+    private $longitude;
+}
+```
+
+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...
+    }
+}
+```
+
+If you are using PHP 8, then you can use [Attributes](https://www.php.net/manual/en/language.attributes.overview.php) in your entity:
+
+```php
+
+use Bazinga\GeocoderBundle\Mapping\Annotations as Geocoder;
+
+#[Geocoder\Geocodeable()]
+class User
+{
+    #[Geocoder\Address()]
+    private $address;
+
+    #[Geocoder\Latitude()]
+    private $latitude;
+
+    #[Geocoder\Longitude()]
+    private $longitude;
+}
+```
+
+It is done!  
+Now you can use it:
+
+```php
+$user = new User();
+$user->setAddress('Brandenburger Tor, Pariser Platz, Berlin');
+$em->persist($event);
+$em->flush();
+
+echo $user->getLatitude(); // will output 52.516325
+echo $user->getLongitude(); // will output 13.377264
+```

config/orm.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symfony\Component\DependencyInjection\Loader\Configurator;
+
+use Bazinga\GeocoderBundle\Doctrine\ORM\GeocodeEntityListener;
+use Bazinga\GeocoderBundle\Mapping\Driver\DriverInterface;
+
+return static function (ContainerConfigurator $container) {
+    $services = $container->services();
+
+    $services
+        ->set(GeocodeEntityListener::class)
+            ->args([
+                tagged_locator('bazinga_geocoder.provider'),
+                service(DriverInterface::class),
+            ])
+            ->tag('doctrine.event_listener', ['event' => 'onFlush'])
+    ;
+};

config/services.php

@@ -5,6 +5,9 @@
 namespace Symfony\Component\DependencyInjection\Loader\Configurator;
 
 use Bazinga\GeocoderBundle\Command\GeocodeCommand;
+use Bazinga\GeocoderBundle\Mapping\Driver\AttributeDriver;
+use Bazinga\GeocoderBundle\Mapping\Driver\ChainDriver;
+use Bazinga\GeocoderBundle\Mapping\Driver\DriverInterface;
 use Bazinga\GeocoderBundle\Plugin\FakeIpPlugin;
 use Bazinga\GeocoderBundle\Validator\Constraint\AddressValidator;
 use Geocoder\Dumper\Dumper;
@@ -49,5 +52,15 @@
                 service(ProviderAggregator::class),
             ])
             ->tag('validator.constraint_validator')
+
+        ->set(ChainDriver::class)
+            ->args([
+                tagged_iterator('bazinga_geocoder.metadata.driver', exclude: [ChainDriver::class]),
+            ])
+            ->tag('bazinga_geocoder.metadata.driver')
+        ->alias(DriverInterface::class, ChainDriver::class)
+
+        ->set(AttributeDriver::class)
+            ->tag('bazinga_geocoder.metadata.driver')
     ;
 };

doc/doctrine.md

@@ -1,18 +1,18 @@
-# Doctrine annotation support
+# Doctrine support
 
 *[<< Back to documentation index](/doc/index.md)*
 
-Wouldn't it be great if you could automatically save the coordinates of a users
-address every time it is updated? Wait not more here is the feature you been always
-wanted.
+Wouldn't it be great if you could automatically save the coordinates of a user's
+address every time it is updated? Well, wait no more—here is the feature you've
+always wanted!
 
 First of all, update your entity:
 
 ```php
 
 use Bazinga\GeocoderBundle\Mapping\Attributes as Geocoder;
 
-#[Geocoder\Geocodeable()]
+#[Geocoder\Geocodeable(provider: 'acme')]
 class User
 {
     #[Geocoder\Address()]
@@ -32,7 +32,7 @@ Instead of annotating a property, you can also annotate a getter:
 
 use Bazinga\GeocoderBundle\Mapping\Attributes as Geocoder;
 
-#[Geocoder\Geocodeable()]
+#[Geocoder\Geocodeable(provider: 'acme')]
 class User
 {
     #[Geocoder\Latitude()]
@@ -42,30 +42,22 @@ class User
     private $longitude;
 
     #[Geocoder\Address()]
-    public function getAddress(): string
+    public function getAddress(): \Stringable|string
     {
         // Your code...
     }
 }
 ```
 
-Secondly, register the Doctrine event listener and its dependencies in your `config/services.yaml` or `config/services.php` 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.
+Secondly, enable Doctrine ORM listener in the configuration:
 
 ```yaml
-    Bazinga\GeocoderBundle\Mapping\Driver\AttributeDriver: ~
-
-    Bazinga\GeocoderBundle\Doctrine\ORM\GeocoderListener:
-        class: Bazinga\GeocoderBundle\Doctrine\ORM\GeocoderListener
-        arguments:
-            - '@bazinga_geocoder.provider.acme'
-            - '@Bazinga\GeocoderBundle\Mapping\Driver\AttributeDriver'
-        tags:
-            - { name: doctrine.event_listener, event: onFlush }
+bazinga_geocoder:
+    orm:
+        enabled: true
 ```
 
-It is done!
-Now you can use it:
+That's it! Now you can use it:
 
 ```php
 $user = new User();