Added base tags to ensure full resource cache purging

Author: rennokki

README.md

@@ -90,6 +90,43 @@ $alice = Kid::whereName('Alice')->cacheFor(60)->cacheTags(['kids'])->first();
 $bob = Kid::whereName('Bob')->cacheFor(60)->cacheTags(['kids'])->first();
 ```
 
+### Global Cache Invalidation
+
+To invalidate all the cache for a specific model, use the `flushAllQueryCache` method.
+
+The package automatically appends a list of tags, called **base tags** on each query coming from a model. It defaults to the full model class name.
+
+You can still use your custom tags on the queries and they will work like usual:
+
+```php
+Kid::flushAllQueryCache();
+```
+
+In case you want to change the base tags, you can do so in your model.
+
+```php
+class Kid extends Model
+{
+    use QueryCacheable;
+
+    /**
+     * Set the base cache tags that will be present
+     * on all queries.
+     *
+     * @return array
+     */
+    protected function getCacheBaseTags(): array
+    {
+        return [
+            'custom_tag',
+        ];
+    }
+}
+
+// Automatically works with `custom_tag`
+Kid::flushAllQueryCache();
+```
+
 ## Relationship Caching
 Relationships are just another queries. They can be intercepted and modified before the database is hit with the query. The following example needs the `Order` model (or the model associated with the `orders` relationship) to include the `QueryCacheable` trait.
 

src/Traits/QueryCacheModule.php

@@ -22,6 +22,14 @@ trait QueryCacheModule
      */
     protected $cacheTags = null;
 
+    /**
+     * The tags for the query cache that
+     * will be present on all queries.
+     *
+     * @var null|array
+     */
+    protected $cacheBaseTags = null;
+
     /**
      * The cache driver to be used.
      *
@@ -170,6 +178,18 @@ public function flushQueryCache(array $tags = []): bool
         return true;
     }
 
+    /**
+     * Flush all cached resources with the default model tag.
+     *
+     * @return bool
+     */
+    public function flushAllQueryCache(): bool
+    {
+        return self::flushQueryCache(
+            $this->getCacheBaseTags() ?: []
+        );
+    }
+
     /**
      * Flush the cache for a specific tag.
      *
@@ -272,6 +292,20 @@ public function cacheDriver(string $cacheDriver)
         return $this;
     }
 
+    /**
+     * Set the base cache tags; the tags
+     * that will be present on all cached queries.
+     *
+     * @param  array  $tags
+     * @return \Rennokki\QueryCache\Query\Builder
+     */
+    public function cacheBaseTags(array $tags = [])
+    {
+        $this->cacheBaseTags = $tags;
+
+        return $this;
+    }
+
     /**
      * Use a plain key instead of a hashed one in the cache driver.
      *
@@ -302,9 +336,13 @@ public function getCacheDriver()
     public function getCache()
     {
         $cache = $this->getCacheDriver();
-        $tags = $this->getCacheTags();
 
-        return $tags ? $cache->tags($tags) : $cache;
+        $tags = array_merge(
+            $this->getCacheTags() ?: [],
+            $this->getCacheBaseTags() ?: []
+        );
+
+        return $cache->tags($tags);
     }
 
     /**
@@ -348,6 +386,16 @@ public function getCacheTags()
         return $this->cacheTags;
     }
 
+    /**
+     * Get the base cache tags attribute.
+     *
+     * @return array|null
+     */
+    public function getCacheBaseTags()
+    {
+        return $this->cacheBaseTags;
+    }
+
     /**
      * Get the cache prefix attribute.
      *

src/Traits/QueryCacheable.php

@@ -41,6 +41,20 @@ protected function newBaseQueryBuilder()
             $builder->withPlainKey();
         }
 
-        return $builder;
+        return $builder
+            ->cacheBaseTags($this->getCacheBaseTags());
+    }
+
+    /**
+     * Set the base cache tags that will be present
+     * on all queries.
+     *
+     * @return array
+     */
+    protected function getCacheBaseTags(): array
+    {
+        return [
+            (string) Self::class,
+        ];
     }
 }

tests/MethodsTest.php

@@ -89,6 +89,21 @@ public function test_cache_flush_with_more_tags()
         $this->assertNull($cache);
     }
 
+    public function test_cache_flush_with_default_tags_attached()
+    {
+        $post = factory(Post::class)->create();
+        $storedPost = Post::cacheFor(now()->addHours(1))->cacheTags(['test'])->first();
+
+        $cache = Cache::tags(['test', Post::getCacheBaseTags()[0]])->get('leqc:sqlitegetselect * from "posts" limit 1a:0:{}');
+        $this->assertNotNull($cache);
+
+        Post::flushAllQueryCache();
+
+        $cache = Cache::tags(['test', Post::getCacheBaseTags()[0]])->get('leqc:sqlitegetselect * from "posts" limit 1a:0:{}');
+
+        $this->assertNull($cache);
+    }
+
     public function test_hashed_key()
     {
         $kid = factory(Kid::class)->create();