Remove bypass filter and add setting to bypass (disable).

Author: thefrosty

CHANGELONG.md

@@ -6,7 +6,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## 1.4 2019-04-17
 ### Added
-- Bypass cache filter, use `RestDispatch::FILTER_CACHE_BYPASS`
+- Bypass cache setting added.
 
 ## 1.3.2 2019-02-14
 ### Added

src/RestApi/RestDispatch.php

@@ -36,7 +36,6 @@ class RestDispatch implements WpHooksInterface
     const FILTER_CACHE_EXPIRE = WpRestApiCache::FILTER_PREFIX . 'expire';
     const FILTER_CACHE_HEADERS = WpRestApiCache::FILTER_PREFIX . 'headers';
     const FILTER_CACHE_SKIP = WpRestApiCache::FILTER_PREFIX . 'skip';
-    const FILTER_CACHE_BYPASS = WpRestApiCache::FILTER_PREFIX . 'bypass';
     const HEADER_CACHE_CONTROL = 'Cache-Control';
     const QUERY_CACHE_DELETE = 'rest_cache_delete';
     const QUERY_CACHE_FORCE_DELETE = 'rest_force_delete';
@@ -57,8 +56,11 @@ class RestDispatch implements WpHooksInterface
      */
     public function addHooks()
     {
-        $this->addFilter('rest_pre_dispatch', [$this, 'preDispatch'], 10, 3);
-        $this->addFilter('rest_post_dispatch', [$this, 'postDispatch'], 10, 3);
+        $options = $this->getOptions([]);
+        if (!isset($options[Settings::BYPASS]) || $options[Settings::BYPASS] !== 'on') {
+            $this->addFilter('rest_pre_dispatch', [$this, 'preDispatch'], 10, 3);
+            $this->addFilter('rest_post_dispatch', [$this, 'postDispatch'], 10, 3);
+        }
     }
 
     /**
@@ -73,7 +75,7 @@ public function addHooks()
      */
     protected function preDispatch($result, WP_REST_Server $server, WP_REST_Request $request)
     {
-        if ($result !== null || \apply_filters(self::FILTER_CACHE_BYPASS, false) === true) {
+        if ($result !== null) {
             return $result;
         }
         $request_uri = $this->getRequestUri();
@@ -230,7 +232,7 @@ protected function getCachedResult(
                     Settings::PERIOD => MINUTE_IN_SECONDS,
                 ],
             ];
-            $options = \get_option(Admin::OPTION_KEY, $defaults);
+            $options = $this->getOptions($defaults);
             /**
              * Filter for cache expiration time.
              * @param int Expiration time.
@@ -367,4 +369,14 @@ private function isUserAuthenticated(WP_REST_Request $request) : bool
          */
         return \apply_filters(self::FILTER_CACHE_VALIDATE_AUTH, false, $request) !== false;
     }
+
+    /**
+     * Get the options.
+     * @param mixed $defaults
+     * @return mixed
+     */
+    private function getOptions($defaults)
+    {
+        return \get_option(Admin::OPTION_KEY, $defaults);
+    }
 }

src/WpAdmin/Admin.php

@@ -188,7 +188,7 @@ protected function getOptions($key = null)
     {
         $options = \apply_filters(
             self::FILTER_CACHE_OPTIONS,
-            \get_option(self::OPTION_KEY, $this->settings->getExpiration())
+            \get_option(self::OPTION_KEY, $this->settings->getSettings())
         );
 
         if (\is_string($key) && \array_key_exists($key, $options)) {
@@ -250,8 +250,9 @@ private function updateOptions(array $options) : bool
     {
         $this->settings->setLength(absint($options[Settings::EXPIRATION][Settings::LENGTH]));
         $this->settings->setPeriod(absint($options[Settings::EXPIRATION][Settings::PERIOD]));
+        $this->settings->setBypass(!empty($options[Settings::BYPASS]) ? 'on' : 'off');
 
-        return \update_option(self::OPTION_KEY, $this->settings->getExpiration(), 'yes');
+        return \update_option(self::OPTION_KEY, $this->settings->getSettings(), 'yes');
     }
 
     /**

src/WpAdmin/Settings.php

@@ -11,24 +11,25 @@
 class Settings extends BaseModel
 {
 
+    const BYPASS = 'bypass';
     const EXPIRATION = 'expiration';
     const LENGTH = 'length';
     const PERIOD = 'period';
 
     /**
-     * Settings expiration array.
+     * Settings array.
      *
-     * @var array $expiration
+     * @var array $settings
      */
-    protected $expiration = [];
+    protected $settings = [];
 
     /**
      * Get's the expiration settings array.
      * @return array
      */
-    public function getExpiration() : array
+    public function getSettings() : array
     {
-        return $this->expiration;
+        return $this->settings;
     }
 
     /**
@@ -37,7 +38,7 @@ public function getExpiration() : array
      */
     public function setLength(int $length)
     {
-        $this->expiration[self::EXPIRATION][self::LENGTH] = $length;
+        $this->settings[self::EXPIRATION][self::LENGTH] = $length;
     }
 
     /**
@@ -46,6 +47,15 @@ public function setLength(int $length)
      */
     public function setPeriod(int $period)
     {
-        $this->expiration[self::EXPIRATION][self::PERIOD] = $period;
+        $this->settings[self::EXPIRATION][self::PERIOD] = $period;
+    }
+
+    /**
+     * Sets the bypass value.
+     * @param string $value
+     */
+    public function setBypass(string $value)
+    {
+        $this->settings[self::BYPASS] = $value;
     }
 }

views/settings.php

@@ -55,6 +55,15 @@ class="button button-primary"><?php esc_html_e( 'empty cache', 'wp-rest-api-cach
                     </select>
                 </td>
             </tr>
+            <tr>
+                <th scope="row"><?php esc_html_e( 'Disable REST Cache', 'wp-rest-api-cache' ); ?></th>
+                <td>
+                    <input type="checkbox"
+                           name="<?php printf( '%s[%s]', Admin::OPTION_KEY, Settings::BYPASS ); ?>"
+                           value="on"<?php checked($options[Settings::BYPASS], 'on'); ?>>
+
+                </td>
+            </tr>
             <tr>
                 <th scope="row">&nbsp;</th>
                 <td><input type="submit" class="button button-primary"