cleanup flash message listener naming and doc

dbu · dbu · commit 0c1e99ebf7b9 · 2014-07-11T16:32:37.000+02:00
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -99,7 +99,7 @@ public function getConfigTreeBuilder()
         $this->addTagSection($rootNode);
         $this->addInvalidationSection($rootNode);
         $this->addUserContextListenerSection($rootNode);
-        $this->addFlashMessageListenerSection($rootNode);
+        $this->addFlashMessageSection($rootNode);
         $this->addDebugSection($rootNode);
 
         return $treeBuilder;
@@ -417,11 +417,11 @@ private function addUserContextListenerSection(ArrayNodeDefinition $rootNode)
         ;
     }
 
-    private function addFlashMessageListenerSection(ArrayNodeDefinition $rootNode)
+    private function addFlashMessageSection(ArrayNodeDefinition $rootNode)
     {
         $rootNode
             ->children()
-                ->arrayNode('flash_message_listener')
+                ->arrayNode('flash_message')
                     ->canBeUnset()
                     ->canBeEnabled()
                     ->info('Activate the flash message listener that puts flash messages into a cookie.')
diff --git a/DependencyInjection/FOSHttpCacheExtension.php b/DependencyInjection/FOSHttpCacheExtension.php
@@ -26,12 +26,20 @@
  */
 class FOSHttpCacheExtension extends Extension
 {
+    /**
+     * {@inheritDoc}
+     */
+    public function getConfiguration(array $config, ContainerBuilder $container)
+    {
+        return new Configuration($container->getParameter('kernel.debug'));
+    }
+
     /**
      * {@inheritDoc}
      */
     public function load(array $configs, ContainerBuilder $container)
     {
-        $configuration = new Configuration($container->getParameter('kernel.debug'));
+        $configuration = $this->getConfiguration($configs, $container);
         $config = $this->processConfiguration($configuration, $configs);
 
         $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
@@ -85,10 +93,10 @@ public function load(array $configs, ContainerBuilder $container)
             $this->loadUserContext($container, $loader, $config['user_context']);
         }
 
-        if (!empty($config['flash_message_listener']) && $config['flash_message_listener']['enabled']) {
-            $container->setParameter($this->getAlias().'.event_listener.flash_message.options', $config['flash_message_listener']);
+        if (!empty($config['flash_message']) && $config['flash_message']['enabled']) {
+            $container->setParameter($this->getAlias().'.event_listener.flash_message.options', $config['flash_message']);
 
-            $loader->load('flash_message_listener.xml');
+            $loader->load('flash_message.xml');
         }
     }
 
diff --git a/Resources/config/flash_message.xml b/Resources/config/flash_message.xml
diff --git a/Resources/doc/event-subscribers/flash-message.rst b/Resources/doc/event-subscribers/flash-message.rst
@@ -2,18 +2,21 @@ Flash Message Subscriber
 ========================
 
 When flash messages are rendered into the content of a page, you can't cache
-the page anymore. This listener reads all flash messages into a cookie, leading
-to them not being there anymore when rendering the template. This will return
-the page with a set-cookie header which you of course must make sure to not
-cache in varnish. By default, varnish will simply not cache the whole response
-when there is a set-cookie header. (Maybe you could do something more clever -
-if you do, please provide a VCL example.)
+the page anymore. When enabled, this subscriber reads all flash messages into a
+cookie, leading to them not being there anymore when rendering the template.
+This will return the page with a set-cookie header which you of course must
+make sure to not cache in varnish. By default, varnish will simply not cache
+the whole response when there is a set-cookie header. (Maybe you could do
+something more clever - if you do, please provide a VCL example.)
+
+The flash message subscriber is automatically enabled if you configure any of
+the options under ``flash_message``.
 
 .. code-block:: yaml
 
     # app/config.yml
     fos_http_cache:
-      flash_message_listener:
+      flash_message:
         name: flashes
         path: /
         host: null
@@ -42,7 +45,7 @@ show the flash message once. This could look along these lines:
 
     function showFlash()
     {
-        var cookie = getCookie("flashes"); // fos_http_cache.flash_message_listener.name
+        var cookie = getCookie("flashes"); // fos_http_cache.flash_message.name
 
         if (!cookie) {
             return;
diff --git a/Tests/Resources/Fixtures/config/full.php b/Tests/Resources/Fixtures/config/full.php
@@ -85,7 +85,7 @@
         'user_hash_header' => 'FOS-User-Context-Hash',
         'role_provider' => true,
     ),
-    'flash_message_listener' => array(
+    'flash_message' => array(
         'enabled' => true,
         'name' => 'flashtest',
         'path' => '/x',
diff --git a/Tests/Resources/Fixtures/config/full.yml b/Tests/Resources/Fixtures/config/full.yml
@@ -80,7 +80,7 @@ fos_http_cache:
             - Authorization
         user_hash_header: FOS-User-Context-Hash
 
-    flash_message_listener:
+    flash_message:
         name: flashtest
         path: /x
         host: y
diff --git a/Tests/Unit/DependencyInjection/ConfigurationTest.php b/Tests/Unit/DependencyInjection/ConfigurationTest.php
@@ -138,7 +138,7 @@ public function testSupportsAllConfigFormats()
                 'user_hash_header' => 'FOS-User-Context-Hash',
                 'role_provider' => true,
             ),
-            'flash_message_listener' => array(
+            'flash_message' => array(
                 'enabled' => true,
                 'name' => 'flashtest',
                 'path' => '/x',
@@ -367,7 +367,7 @@ private function getEmptyConfig()
                 'user_hash_header' => 'X-User-Context-Hash',
                 'role_provider' => false,
             ),
-            'flash_message_listener' => array(
+            'flash_message' => array(
                 'enabled' => false,
                 'name' => 'flashes',
                 'path' => '/',
diff --git a/Tests/Unit/DependencyInjection/FOSHttpCacheExtensionTest.php b/Tests/Unit/DependencyInjection/FOSHttpCacheExtensionTest.php
@@ -240,26 +240,10 @@ public function testConfigWithoutUserContext()
         $this->assertFalse($container->has('fos_http_cache.user_context.role_provider'));
     }
 
-    public function testConfigLoadFlashMessageListener()
+    public function testConfigLoadFlashMessageSubscriber()
     {
         $config = array(
-            array('flash_message_listener' => array(
-                'name' => 'myflashes',
-                'path' => '/test',
-                'host' => '*.fos.lo',
-                'secure' => true,
-                'httpOnly' => false,
-            )),
-        );
-
-        $container = $this->createContainer();
-        $this->extension->load($config, $container);
-    }
-
-    public function testConfigLoadFlashMessageListenerDefaults()
-    {
-        $config = array(
-            array('flash_message_listener' => true,
+            array('flash_message' => true,
             ),
         );
 
