Merge pull request #109 from FriendsOfSymfony/tags-header-config

Make tags header configurable
FriendsOfSymfony · Jul 30, 2014 · d22a5e3 · d22a5e3
2 parents 4f4bcea + 68a9985
commit d22a5e3
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 2 deletions.
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -326,6 +326,10 @@ private function addTagSection(ArrayNodeDefinition $rootNode)
                             ->defaultValue('auto')
                             ->info('Allows to disable the listener for tag annotations when your project does not use the annotations. Enabled by default if you have expression language and the cache manager.')
                         ->end()
+                        ->scalarNode('header')
+                            ->defaultValue('X-Cache-Tags')
+                            ->info('HTTP header that contains cache tags')
+                        ->end()
                         ->arrayNode('rules')
                             ->prototype('array')
                                 ->fixXmlConfig('tag')

diff --git a/DependencyInjection/FOSHttpCacheExtension.php b/DependencyInjection/FOSHttpCacheExtension.php
@@ -19,7 +19,6 @@
 use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
 use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
-use Symfony\Component\HttpKernel\Kernel;
 
 /**
  * {@inheritdoc}
@@ -74,6 +73,11 @@ public function load(array $configs, ContainerBuilder $container)
                 // silently skip if set to auto
                 throw new InvalidConfigurationException('The TagSubscriber requires symfony/expression-language and needs the cache_manager to be configured');
             }
+
+            $tagsHeader = $config['tags']['header'];
+            $container->getDefinition($this->getAlias().'.cache_manager')
+                ->addMethodCall('setTagsHeader', array($tagsHeader))
+            ;
         }
 
         if ($config['invalidation']['enabled']) {

diff --git a/Tests/Resources/Fixtures/config/full.php b/Tests/Resources/Fixtures/config/full.php
@@ -43,6 +43,7 @@
         'enabled' => true,
     ),
     'tags' => array(
+        'header' => 'FOS-Tags',
         'rules' => array(
             array(
                 'match' => array(

diff --git a/Tests/Resources/Fixtures/config/full.xml b/Tests/Resources/Fixtures/config/full.xml
@@ -41,7 +41,7 @@
 
         <cache-manager enabled="true"/>
 
-        <tags>
+        <tags header="FOS-Tags">
             <rule>
                 <match path="/def" host="friends">
                     <method>PUT</method>

diff --git a/Tests/Resources/Fixtures/config/full.yml b/Tests/Resources/Fixtures/config/full.yml
@@ -43,6 +43,7 @@ fos_http_cache:
         enabled: true
 
     tags:
+        header: FOS-Tags
         rules:
             -
                 match:

diff --git a/Tests/Unit/DependencyInjection/ConfigurationTest.php b/Tests/Unit/DependencyInjection/ConfigurationTest.php
@@ -92,6 +92,7 @@ public function testSupportsAllConfigFormats()
             ),
             'tags' => array(
                 'enabled' => 'auto',
+                'header' => 'FOS-Tags',
                 'rules' => array(
                     array(
                         'match' => array(
@@ -410,6 +411,7 @@ private function getEmptyConfig()
             ),
             'tags' => array(
                 'enabled' => false,
+                'header' => 'X-Cache-Tags',
                 'rules' => array(),
             ),
             'invalidation' => array(