Merge pull request #517 from FriendsOfSymfony/noop-clear

noop can also (not) clear the whole cache

CHANGELOG.md

@@ -14,6 +14,10 @@ See also the [GitHub releases page](https://github.com/FriendsOfSymfony/FOSHttpC
   If you use the user context, read the updated documentation and call `fos_user_context_hash` in
   your `vcl_hash` function.
 
+### Noop Client
+
+* Implemented ClearCapable.
+
 2.11.0
 ------
 

doc/proxy-clients.rst

@@ -26,8 +26,8 @@ Varnish       ✓       ✓       ✓       ✓
 Fastly        ✓       ✓               ✓       ✓
 NGINX         ✓       ✓
 Symfony Cache ✓       ✓               ✓ (1)   ✓ (1)
-Noop          ✓       ✓       ✓       ✓
-Multiplexer   ✓       ✓       ✓       ✓
+Noop          ✓       ✓       ✓       ✓       ✓
+Multiplexer   ✓       ✓       ✓       ✓       ✓
 ============= ======= ======= ======= ======= =======
 
 (1): Only when using `Toflar Psr6Store`_.

src/ProxyClient/Noop.php

@@ -12,17 +12,21 @@
 namespace FOS\HttpCache\ProxyClient;
 
 use FOS\HttpCache\ProxyClient\Invalidation\BanCapable;
+use FOS\HttpCache\ProxyClient\Invalidation\ClearCapable;
 use FOS\HttpCache\ProxyClient\Invalidation\PurgeCapable;
 use FOS\HttpCache\ProxyClient\Invalidation\RefreshCapable;
 use FOS\HttpCache\ProxyClient\Invalidation\TagCapable;
 
 /**
- * This is a no operation client, its only purpose is to provide an implementation for use in an enviroments that
- * have no proxy to use.
+ * This client implements the interfaces but does nothing.
+ *
+ * It is useful when testing code that needs a ProxyClient, or to configure in
+ * environments that have no caching proxy to talk to, like a local development
+ * setup.
  *
  * @author Gavin Staniforth <gavin@gsdev.me>
  */
-class Noop implements ProxyClient, BanCapable, PurgeCapable, RefreshCapable, TagCapable
+class Noop implements ProxyClient, BanCapable, PurgeCapable, RefreshCapable, TagCapable, ClearCapable
 {
     /**
      * {@inheritdoc}
@@ -71,4 +75,12 @@ public function flush()
     {
         return 0;
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function clear()
+    {
+        return $this;
+    }
 }