Added support for the immutable directive in the cache-control header

twoleds · twoleds · commit eb37144f4762 · 2017-05-28T21:39:00.000+02:00
diff --git a/src/Symfony/Component/HttpFoundation/Response.php b/src/Symfony/Component/HttpFoundation/Response.php
@@ -620,6 +620,34 @@ public function setPublic()
         return $this;
     }
 
+    /**
+     * Marks the response as "immutable".
+     *
+     * @param bool $immutable Enables or disabled the immutable directive.
+     *
+     * @return $this
+     */
+    public function setImmutable($immutable = true)
+    {
+        if ($immutable) {
+            $this->headers->addCacheControlDirective('immutable');
+        } else {
+            $this->headers->removeCacheControlDirective('immutable');
+        }
+
+        return $this;
+    }
+
+    /**
+     * Returns true if the response is marked as "immutable".
+     *
+     * @return bool Returns true if the response is marked as "immutable"; otherwise false.
+     */
+    public function isImmutable()
+    {
+        return $this->headers->getCacheControlDirective('immutable') ? true : false;
+    }
+
     /**
      * Returns true if the response must be revalidated by caches.
      *
@@ -956,7 +984,7 @@ public function setEtag($etag = null, $weak = false)
      */
     public function setCache(array $options)
     {
-        if ($diff = array_diff(array_keys($options), array('etag', 'last_modified', 'max_age', 's_maxage', 'private', 'public'))) {
+        if ($diff = array_diff(array_keys($options), array('etag', 'last_modified', 'max_age', 's_maxage', 'private', 'public', 'immutable'))) {
             throw new \InvalidArgumentException(sprintf('Response does not support the following options: "%s".', implode('", "', array_values($diff))));
         }
 
@@ -992,6 +1020,10 @@ public function setCache(array $options)
             }
         }
 
+        if (isset($options['immutable'])) {
+            $this->setImmutable($options['immutable'] ? true : false);
+        }
+
         return $this;
     }
 
diff --git a/src/Symfony/Component/HttpFoundation/Tests/ResponseTest.php b/src/Symfony/Component/HttpFoundation/Tests/ResponseTest.php
@@ -610,6 +610,12 @@ public function testSetCache()
         $response->setCache(array('private' => false));
         $this->assertTrue($response->headers->hasCacheControlDirective('public'));
         $this->assertFalse($response->headers->hasCacheControlDirective('private'));
+
+        $response->setCache(array('immutable' => true));
+        $this->assertTrue($response->headers->hasCacheControlDirective('immutable'));
+
+        $response->setCache(array('immutable' => false));
+        $this->assertFalse($response->headers->hasCacheControlDirective('immutable'));
     }
 
     public function testSendContent()
@@ -631,6 +637,22 @@ public function testSetPublic()
         $this->assertFalse($response->headers->hasCacheControlDirective('private'));
     }
 
+    public function testSetImmutable()
+    {
+        $response = new Response();
+        $response->setImmutable();
+
+        $this->assertTrue($response->headers->hasCacheControlDirective('immutable'));
+    }
+
+    public function testIsImmutable()
+    {
+        $response = new Response();
+        $response->setImmutable();
+
+        $this->assertTrue($response->isImmutable());
+    }
+
     public function testSetExpires()
     {
         $response = new Response();
