Merge branch 'FriendsOfSymfony:2.x' into 2.x

FriendsOfSymfony · Oct 25, 2023 · 37d6a7b · 37d6a7b
2 parents bc83e22 + 18b4f0a
commit 37d6a7b
Show file tree

Hide file tree

Showing 34 changed files with 13 additions and 196 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -1,5 +1,10 @@
 version: 2
 
+build:
+    os: ubuntu-22.04
+    tools:
+        python: "3.11"
+
 sphinx:
     configuration: doc/conf.py
 
@@ -8,6 +13,5 @@ formats:
     - pdf
 
 python:
-    version: "3.7"
     install:
         - requirements: doc/requirements.txt
diff --git a/composer.json b/composer.json
@@ -55,5 +55,10 @@
         "psr-4": {
             "FOS\\HttpCache\\Tests\\": "tests/"
         }
+    },
+    "config": {
+        "allow-plugins": {
+            "php-http/discovery": true
+        }
     }
 }
diff --git a/doc/conf.py b/doc/conf.py
@@ -54,7 +54,7 @@
 
 # General information about the project.
 project = 'FOSHttpCache'
-copyright = u'2014–2018, FriendsOfSymfony'
+copyright = u'2014–now, FriendsOfSymfony'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the

diff --git a/src/EventListener/LogListener.php b/src/EventListener/LogListener.php
@@ -32,9 +32,6 @@ public function __construct(LoggerInterface $logger)
         $this->logger = $logger;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public static function getSubscribedEvents(): array
     {
         return [

diff --git a/src/ProxyClient/Cloudflare.php b/src/ProxyClient/Cloudflare.php
@@ -82,8 +82,6 @@ public function invalidateTags(array $tags)
     }
 
     /**
-     * {@inheritdoc}
-     *
      * @see https://api.cloudflare.com/#zone-purge-files-by-url
      * @see https://developers.cloudflare.com/cache/how-to/purge-cache#purge-by-single-file-by-url For details on headers you can pass to clear the cache correctly
      */
@@ -102,8 +100,6 @@ public function purge($url, array $headers = [])
     }
 
     /**
-     * {@inheritdoc}
-     *
      * @see https://api.cloudflare.com/#zone-purge-all-files
      */
     public function clear()
@@ -153,9 +149,6 @@ protected function queueRequest($method, $url, array $headers, $validateHost = t
         );
     }
 
-    /**
-     * {@inheritdoc}
-     */
     protected function configureOptions()
     {
         $resolver = parent::configureOptions();

diff --git a/src/ProxyClient/Fastly.php b/src/ProxyClient/Fastly.php
@@ -58,8 +58,6 @@ public function __construct(
     }
 
     /**
-     * {@inheritdoc}
-     *
      * @see https://docs.fastly.com/api/purge#purge_db35b293f8a724717fcf25628d713583
      */
     public function invalidateTags(array $tags)
@@ -85,8 +83,6 @@ public function invalidateTags(array $tags)
     }
 
     /**
-     * {@inheritdoc}
-     *
      * @see https://docs.fastly.com/api/purge#soft_purge_0c4f56f3d68e9bed44fb8b638b78ea36
      * @see https://docs.fastly.com/guides/purging/authenticating-api-purge-requests#purging-urls-with-an-api-token
      */
@@ -106,9 +102,6 @@ public function purge($url, array $headers = [])
         return $this;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function refresh($url, array $headers = [])
     {
         // First soft purge url
@@ -131,8 +124,6 @@ public function refresh($url, array $headers = [])
     }
 
     /**
-     * {@inheritdoc}
-     *
      * @see https://docs.fastly.com/api/purge#purge_bee5ed1a0cfd541e8b9f970a44718546
      *
      * Warning:
@@ -165,9 +156,6 @@ protected function queueRequest($method, $url, array $headers, $validateHost = t
         );
     }
 
-    /**
-     * {@inheritdoc}
-     */
     protected function configureOptions()
     {
         $resolver = parent::configureOptions();

diff --git a/src/ProxyClient/HttpDispatcher.php b/src/ProxyClient/HttpDispatcher.php
@@ -107,9 +107,6 @@ public function __construct(
         $this->setBaseUri($baseUri);
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function invalidate(RequestInterface $invalidationRequest, $validateHost = true)
     {
         if ($validateHost && !$this->baseUri && !$invalidationRequest->getUri()->getHost()) {
@@ -125,9 +122,6 @@ public function invalidate(RequestInterface $invalidationRequest, $validateHost
         $this->queue[$signature] = $invalidationRequest;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function flush()
     {
         $queue = $this->queue;

diff --git a/src/ProxyClient/HttpProxyClient.php b/src/ProxyClient/HttpProxyClient.php
@@ -63,9 +63,6 @@ public function __construct(
         $this->requestFactory = $messageFactory ?: MessageFactoryDiscovery::find();
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function flush()
     {
         return $this->httpDispatcher->flush();

diff --git a/src/ProxyClient/Nginx.php b/src/ProxyClient/Nginx.php
@@ -31,9 +31,6 @@ class Nginx extends HttpProxyClient implements PurgeCapable, RefreshCapable
 
     public const HTTP_HEADER_REFRESH = 'X-Refresh';
 
-    /**
-     * {@inheritdoc}
-     */
     public function refresh($url, array $headers = [])
     {
         $headers = array_merge($headers, [self::HTTP_HEADER_REFRESH => '1']);
@@ -42,9 +39,6 @@ public function refresh($url, array $headers = [])
         return $this;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function purge($url, array $headers = [])
     {
         $purgeUrl = $this->buildPurgeUrl($url);
@@ -53,9 +47,6 @@ public function purge($url, array $headers = [])
         return $this;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     protected function configureOptions()
     {
         $resolver = parent::configureOptions();

diff --git a/src/ProxyClient/Noop.php b/src/ProxyClient/Noop.php
@@ -28,57 +28,36 @@
  */
 class Noop implements ProxyClient, BanCapable, PurgeCapable, RefreshCapable, TagCapable, ClearCapable
 {
-    /**
-     * {@inheritdoc}
-     */
     public function ban(array $headers)
     {
         return $this;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function banPath($path, $contentType = null, $hosts = null)
     {
         return $this;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function invalidateTags(array $tags)
     {
         return $this;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function purge($url, array $headers = [])
     {
         return $this;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function refresh($url, array $headers = [])
     {
         return $this;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function flush()
     {
         return 0;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function clear()
     {
         return $this;

diff --git a/src/ProxyClient/Symfony.php b/src/ProxyClient/Symfony.php
@@ -31,19 +31,13 @@ class Symfony extends HttpProxyClient implements PurgeCapable, RefreshCapable, T
 {
     public const HTTP_METHOD_REFRESH = 'GET';
 
-    /**
-     * {@inheritdoc}
-     */
     public function purge($url, array $headers = [])
     {
         $this->queueRequest($this->options['purge_method'], $url, $headers);
 
         return $this;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function refresh($url, array $headers = [])
     {
         $headers = array_merge($headers, ['Cache-Control' => 'no-cache']);
@@ -73,9 +67,6 @@ protected function configureOptions()
         return $resolver;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function invalidateTags(array $tags)
     {
         $escapedTags = $this->escapeTags($tags);

diff --git a/src/ProxyClient/Varnish.php b/src/ProxyClient/Varnish.php
@@ -67,9 +67,6 @@ class Varnish extends HttpProxyClient implements BanCapable, PurgeCapable, Refre
 
     public const DEFAULT_HTTP_HEADER_CACHE_XKEY = 'xkey-softpurge';
 
-    /**
-     * {@inheritdoc}
-     */
     public function invalidateTags(array $tags)
     {
         $banMode = self::TAG_BAN === $this->options['tag_mode'];
@@ -92,9 +89,6 @@ public function invalidateTags(array $tags)
         return $this;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function ban(array $headers)
     {
         $headers = array_merge(
@@ -107,9 +101,6 @@ public function ban(array $headers)
         return $this;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function banPath($path, $contentType = null, $hosts = null)
     {
         if (is_array($hosts)) {
@@ -133,19 +124,13 @@ public function banPath($path, $contentType = null, $hosts = null)
         return $this->ban($headers);
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function purge($url, array $headers = [])
     {
         $this->queueRequest(self::HTTP_METHOD_PURGE, $url, $headers);
 
         return $this;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function refresh($url, array $headers = [])
     {
         $headers = array_merge($headers, ['Cache-Control' => 'no-cache']);
@@ -154,9 +139,6 @@ public function refresh($url, array $headers = [])
         return $this;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     protected function configureOptions()
     {
         $resolver = parent::configureOptions();

diff --git a/src/SymfonyCache/AccessControlledListener.php b/src/SymfonyCache/AccessControlledListener.php
@@ -22,8 +22,6 @@
  * control on requests.
  *
  * @author David Buchmann <[email protected]>
- *
- * {@inheritdoc}
  */
 abstract class AccessControlledListener implements EventSubscriberInterface
 {

diff --git a/src/SymfonyCache/CleanupCacheTagsListener.php b/src/SymfonyCache/CleanupCacheTagsListener.php
@@ -44,9 +44,6 @@ public function removeTagsHeader(CacheEvent $e)
         $response->headers->remove($this->tagsHeader);
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public static function getSubscribedEvents(): array
     {
         return [

diff --git a/src/SymfonyCache/CustomTtlListener.php b/src/SymfonyCache/CustomTtlListener.php
@@ -20,8 +20,6 @@
  * keep s-maxage for 3rd party proxies.
  *
  * @author David Buchmann <[email protected]>
- *
- * {@inheritdoc}
  */
 class CustomTtlListener implements EventSubscriberInterface
 {
@@ -99,9 +97,6 @@ public function cleanResponse(CacheEvent $e)
         $response->headers->remove(static::SMAXAGE_BACKUP);
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public static function getSubscribedEvents(): array
     {
         return [

diff --git a/src/SymfonyCache/DebugListener.php b/src/SymfonyCache/DebugListener.php
@@ -19,14 +19,9 @@
  * Add debug information to the response for use in cache tests.
  *
  * @author David Buchmann <[email protected]>
- *
- * {@inheritdoc}
  */
 class DebugListener implements EventSubscriberInterface
 {
-    /**
-     * {@inheritdoc}
-     */
     public static function getSubscribedEvents(): array
     {
         return [

diff --git a/src/SymfonyCache/EventDispatchingHttpCache.php b/src/SymfonyCache/EventDispatchingHttpCache.php
@@ -37,8 +37,6 @@
  *
  * @author Jérôme Vieilledent <[email protected]> (courtesy of eZ Systems AS)
  * @author David Buchmann <[email protected]>
- *
- * {@inheritdoc}
  */
 trait EventDispatchingHttpCache
 {