add legacy symfony support

Author: dbu

DependencyInjection/Compiler/RegisterMappingsPass.php

@@ -0,0 +1,86 @@
+<?php
+
+namespace FOS\UserBundle\DependencyInjection\Compiler;
+
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Definition;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\Exception\ParameterNotFoundException;
+
+/**
+ * Forward compatibility class in case FOSUserBundle is used with older
+ * versions of Symfony2 or the doctrine bundles that do not provide the
+ * register mappings compiler pass yet.
+ *
+ * @deprecated Compatibility class to make the bundle work with Symfony < 2.3.
+ * To be removed when this bundle drops support for Symfony < 2.3
+ *
+ * @author David Buchmann <[email protected]>
+ */
+class RegisterMappingsPass implements CompilerPassInterface
+{
+    private $driver;
+    private $driverPattern;
+    private $namespaces;
+    private $enabledParameter;
+    private $fallbackManagerParameter;
+
+    public function __construct($driver, $driverPattern, $namespaces, $enabledParameter, $fallbackManagerParameter)
+    {
+        $this->driver = $driver;
+        $this->driverPattern = $driverPattern;
+        $this->namespaces = $namespaces;
+        $this->enabledParameter = $enabledParameter;
+        $this->fallbackManagerParameter = $fallbackManagerParameter;
+    }
+
+    /**
+     * Register mappings with the metadata drivers.
+     *
+     * @param ContainerBuilder $container
+     */
+    public function process(ContainerBuilder $container)
+    {
+        if (!$container->hasParameter($this->enabledParameter)) {
+            return;
+        }
+
+        $chainDriverDefService = $this->getChainDriverServiceName($container);
+        $chainDriverDef = $container->getDefinition($chainDriverDefService);
+        foreach ($this->namespaces as $namespace) {
+            $chainDriverDef->addMethodCall('addDriver', array($this->driver, $namespace));
+        }
+    }
+
+    protected function getChainDriverServiceName(ContainerBuilder $container)
+    {
+        foreach (array('fos_user.model_manager_name', $this->fallbackManagerParameter) as $param) {
+            if ($container->hasParameter($param)) {
+                $name = $container->getParameter($param);
+                if ($name) {
+                    return sprintf($this->driverPattern, $name);
+                }
+            }
+        }
+
+        throw new ParameterNotFoundException('None of the managerParameters resulted in a valid name');
+    }
+
+    public static function createOrmMappingDriver(array $mappings)
+    {
+        $arguments = array($mappings, '.orm.xml');
+        $locator = new Definition('Doctrine\Common\Persistence\Mapping\Driver\SymfonyFileLocator', $arguments);
+        $driver = new Definition('Doctrine\ORM\Mapping\Driver\XmlDriver', array($locator));
+
+        return new RegisterMappingsPass($driver, 'doctrine.orm.%s_metadata_driver', $mappings, 'fos_user.backend_type_orm', 'doctrine.default_entity_manager');
+    }
+
+    public static function createMongoDBMappingDriver($mappings)
+    {
+        $arguments = array($mappings, '.mongodb.xml');
+        $locator = new Definition('Doctrine\Common\Persistence\Mapping\Driver\SymfonyFileLocator', $arguments);
+        $driver = new Definition('Doctrine\ODM\MongoDB\Mapping\Driver\XmlDriver', array($locator));
+
+        return new RegisterMappingsPass($driver, 'doctrine_mongodb.odm.%s_metadata_driver', $mappings, 'fos_user.backend_type_mongodb', 'doctrine_mongodb.odm.default_document_manager');
+    }
+}

FOSUserBundle.php

@@ -11,6 +11,7 @@
 
 namespace FOS\UserBundle;
 
+use FOS\UserBundle\DependencyInjection\Compiler\RegisterMappingsPass;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use FOS\UserBundle\DependencyInjection\Compiler\ValidationPass;
@@ -23,27 +24,37 @@
  */
 class FOSUserBundle extends Bundle
 {
+
     public function build(ContainerBuilder $container)
     {
         parent::build($container);
         $container->addCompilerPass(new ValidationPass());
 
-        if (! class_exists('Symfony\Bridge\Doctrine\DependencyInjection\CompilerPass\RegisterMappingsPass')) {
-            // TODO: provide a temporary implementation of the compiler pass in FOSUserBundle
-            // so people can already use the Model class even with older symfony?
-            return;
-        }
+        $this->addRegisterMappingsPass($container);
+    }
+
+    /**
+     * @param ContainerBuilder $container
+     */
+    private function addRegisterMappingsPass(ContainerBuilder $container)
+    {
+        // the base class is only available since symfony 2.3
+        $symfonyVersion = class_exists('Symfony\Bridge\Doctrine\DependencyInjection\CompilerPass\RegisterMappingsPass');
 
         $mappings = array(
-            realpath(__DIR__.'/Resources/config/doctrine/model') => 'FOS\UserBundle\Model',
+            realpath(__DIR__ . '/Resources/config/doctrine/model') => 'FOS\UserBundle\Model',
         );
 
-        if (class_exists('Doctrine\Bundle\DoctrineBundle\DependencyInjection\Compiler\DoctrineOrmMappingsPass')) {
+        if ($symfonyVersion && class_exists('Doctrine\Bundle\DoctrineBundle\DependencyInjection\Compiler\DoctrineOrmMappingsPass')) {
             $container->addCompilerPass(DoctrineOrmMappingsPass::createXmlMappingDriver($mappings, array('fos_user.model_manager_name'), 'fos_user.backend_type_orm'));
+        } else {
+            $container->addCompilerPass(RegisterMappingsPass::createOrmMappingDriver($mappings));
         }
 
-        if (class_exists('Doctrine\Bundle\MongoDBBundle\DependencyInjection\Compiler\DoctrineMongoDBMappingsPass')) {
+        if ($symfonyVersion && class_exists('Doctrine\Bundle\MongoDBBundle\DependencyInjection\Compiler\DoctrineMongoDBMappingsPass')) {
             $container->addCompilerPass(DoctrineMongoDBMappingsPass::createXmlMappingDriver($mappings, array('fos_user.model_manager_name'), 'fos_user.backend_type_mongodb'));
+        } else {
+            $container->addCompilerPass(RegisterMappingsPass::createMongoDBMappingDriver($mappings));
         }
 
         // TODO: couch