Add tag listener config (fix #24)

Improve doc

Remove unused fixture

Author: ddeboer

DependencyInjection/Compiler/LoggerPass.php

@@ -6,7 +6,7 @@
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 
 /**
- * E
+ * Attach Symfony2 logger to cache manager
  */
 class LoggerPass implements CompilerPassInterface
 {

DependencyInjection/Compiler/TagListenerPass.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace FOS\HttpCacheBundle\DependencyInjection\Compiler;
+
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+/**
+ * Check for required ControllerListener if TagListener is enabled
+ */
+class TagListenerPass implements CompilerPassInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function process(ContainerBuilder $container)
+    {
+        if ($container->has('fos_http_cache.tag_listener')
+            && !$container->has('sensio_framework_extra.controller.listener')
+        ) {
+            throw new \RuntimeException(
+                'The TagListener requires SensioFrameworkExtraBundle’s ControllerListener. '
+                . 'Please install sensio/framework-extra-bundle and add it to your AppKernel.'
+            );
+        }
+    }
+}

DependencyInjection/Configuration.php

@@ -30,6 +30,7 @@ public function getConfigTreeBuilder()
 
         $this->addRulesSection($rootNode);
         $this->addVarnishSection($rootNode);
+        $this->addTagListenerSection($rootNode);
         $this->addFlashMessageListenerSection($rootNode);
         $this->addInvalidatorsSection($rootNode);
 
@@ -116,6 +117,25 @@ private function addVarnishSection(ArrayNodeDefinition $rootNode)
             ->end();
     }
 
+    private function addTagListenerSection(ArrayNodeDefinition $rootNode)
+    {
+        $rootNode
+            ->children()
+                ->arrayNode('tag_listener')
+                    ->addDefaultsIfNotSet()
+                    ->treatFalseLike(array('enabled' => false))
+                    ->treatTrueLike(array('enabled' => true))
+                    ->treatNullLike(array('enabled' => true))
+                    ->children()
+                        ->scalarNode('enabled')
+                            ->defaultTrue()
+                            ->info('Whether to enable the listener. True by default.')
+                        ->end()
+                    ->end()
+                ->end()
+            ->end();
+    }
+
     private function addFlashMessageListenerSection(ArrayNodeDefinition $rootNode)
     {
         $rootNode

DependencyInjection/FOSHttpCacheExtension.php

@@ -65,6 +65,14 @@ public function load(array $configs, ContainerBuilder $container)
             $loader->load('authorization_request_listener.xml');
         }
 
+        if ($config['tag_listener']['enabled']) {
+            if (!class_exists('\Symfony\Component\ExpressionLanguage\ExpressionLanguage')) {
+                throw new \RuntimeException('The TagListener requires symfony/expression-language');
+            }
+
+            $loader->load('tag_listener.xml');
+        }
+
         if (!empty($config['flash_message_listener']) && $config['flash_message_listener']['enabled']) {
             $loader->load('flash_message_listener.xml');
 

FOSHttpCacheBundle.php

@@ -3,6 +3,7 @@
 namespace FOS\HttpCacheBundle;
 
 use FOS\HttpCacheBundle\DependencyInjection\Compiler\LoggerPass;
+use FOS\HttpCacheBundle\DependencyInjection\Compiler\TagListenerPass;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 
@@ -14,5 +15,6 @@ class FOSHttpCacheBundle extends Bundle
     public function build(ContainerBuilder $container)
     {
         $container->addCompilerPass(new LoggerPass());
+        $container->addCompilerPass(new TagListenerPass());
     }
 }

Resources/config/tag_listener.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" ?>
+
+<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_http_cache.tag_listener"
+                 class="FOS\HttpCacheBundle\EventListener\TagListener">
+            <argument type="service" id="fos_http_cache.cache_manager" />
+            <tag name="kernel.event_subscriber" event="kernel.response" />
+        </service>
+    </services>
+</container>