Merge pull request #1288 from christickner/flash_listener_configuration

[Flash Notifications] make registering the FlashListener configurable

Author: merk

DependencyInjection/Configuration.php

@@ -52,6 +52,7 @@ public function getConfigTreeBuilder()
                 ->scalarNode('firewall_name')->isRequired()->cannotBeEmpty()->end()
                 ->scalarNode('model_manager_name')->defaultNull()->end()
                 ->booleanNode('use_listener')->defaultTrue()->end()
+                ->booleanNode('use_flash_notifications')->defaultTrue()->end()
                 ->booleanNode('use_username_form_type')->defaultTrue()->end()
                 ->arrayNode('from_email')
                     ->addDefaultsIfNotSet()

DependencyInjection/FOSUserExtension.php

@@ -37,6 +37,10 @@ public function load(array $configs, ContainerBuilder $container)
             $loader->load(sprintf('%s.xml', $basename));
         }
 
+        if ($config['use_flash_notifications']) {
+            $loader->load('flash_notifications.xml');
+        }
+
         $container->setAlias('fos_user.mailer', $config['service']['mailer']);
         $container->setAlias('fos_user.util.email_canonicalizer', $config['service']['email_canonicalizer']);
         $container->setAlias('fos_user.util.username_canonicalizer', $config['service']['username_canonicalizer']);

Resources/config/flash_notifications.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+
+<container xmlns="http://symfony.com/schema/dic/services"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+
+    <services>
+        <service id="fos_user.listener.flash" class="FOS\UserBundle\EventListener\FlashListener">
+            <tag name="kernel.event_subscriber" />
+            <argument type="service" id="session" />
+            <argument type="service" id="translator" />
+        </service>
+    </services>
+
+</container>

Resources/config/listeners.xml

@@ -10,12 +10,6 @@
             <argument type="service" id="fos_user.security.login_manager" />
             <argument>%fos_user.firewall_name%</argument>
         </service>
-
-        <service id="fos_user.listener.flash" class="FOS\UserBundle\EventListener\FlashListener">
-            <tag name="kernel.event_subscriber" />
-            <argument type="service" id="session" />
-            <argument type="service" id="translator" />
-        </service>
     </services>
 
 </container>

Tests/DependencyInjection/FOSUserExtensionTest.php

@@ -294,6 +294,20 @@ public function testUserLoadUtilService()
         $this->assertAlias('acme_my.username_canonicalizer', 'fos_user.util.username_canonicalizer');
     }
 
+    public function testUserLoadFlashesByDefault()
+    {
+        $this->createEmptyConfiguration();
+
+        $this->assertHasDefinition('fos_user.listener.flash');
+    }
+
+    public function testUserLoadFlashesCanBeDisabled()
+    {
+        $this->createFullConfiguration();
+
+        $this->assertNotHasDefinition('fos_user.listener.flash');
+    }
+
     protected function createEmptyConfiguration()
     {
         $this->configuration = new ContainerBuilder();
@@ -335,6 +349,7 @@ protected function getFullConfig()
 db_driver: orm
 firewall_name: fos_user
 use_listener: true
+use_flash_notifications: false
 user_class: Acme\MyBundle\Entity\User
 model_manager_name: custom
 from_email: