Refactor out all caching functionality to trait

Author: mikebronner

src/CachedBuilder.php

@@ -10,8 +10,6 @@ class CachedBuilder extends EloquentBuilder
 {
     use Cachable;
 
-    protected $isCachable = true;
-
     public function avg($column)
     {
         if (! $this->isCachable) {
@@ -56,13 +54,6 @@ public function delete()
         return parent::delete();
     }
 
-    public function disableCache()
-    {
-        $this->isCachable = false;
-
-        return $this;
-    }
-
     /**
      * @SuppressWarnings(PHPMD.ShortVariable)
      */
@@ -155,16 +146,4 @@ public function sum($column)
                 return parent::sum($column);
             });
     }
-
-    protected function makeCacheKey(array $columns = ['*'], $idColumn = null) : string
-    {
-        return (new CacheKey($this->eagerLoad, $this->model, $this->query))
-            ->make($columns, $idColumn);
-    }
-
-    protected function makeCacheTags() : array
-    {
-        return (new CacheTags($this->eagerLoad, $this->model))
-            ->make();
-    }
 }

src/CachedModel.php

@@ -1,6 +1,7 @@
 <?php namespace GeneaLabs\LaravelModelCaching;
 
 use GeneaLabs\LaravelModelCaching\CachedBuilder as Builder;
+use GeneaLabs\LaravelModelCaching\Traits\Cachable;
 use Illuminate\Cache\CacheManager;
 use Illuminate\Cache\TaggableStore;
 use Illuminate\Cache\TaggedCache;
@@ -12,6 +13,8 @@
 
 abstract class CachedModel extends Model
 {
+    use Cachable;
+
     public function newEloquentBuilder($query)
     {
         if (session('genealabs-laravel-model-caching-is-disabled')) {
@@ -46,30 +49,6 @@ public static function boot()
         });
     }
 
-    public function cache(array $tags = [])
-    {
-        $cache = cache();
-
-        if (is_subclass_of($cache->getStore(), TaggableStore::class)) {
-            array_push($tags, str_slug(get_called_class()));
-            $cache = $cache->tags($tags);
-        }
-
-        return $cache;
-    }
-
-    public function disableCache() : self
-    {
-        session(['genealabs-laravel-model-caching-is-disabled' => true]);
-
-        return $this;
-    }
-
-    public function flushCache(array $tags = [])
-    {
-        $this->cache($tags)->flush();
-    }
-
     public static function all($columns = ['*'])
     {
         $class = get_called_class();

src/Traits/Cachable.php

@@ -1,17 +1,51 @@
 <?php namespace GeneaLabs\LaravelModelCaching\Traits;
 
+use GeneaLabs\LaravelModelCaching\CacheKey;
+use GeneaLabs\LaravelModelCaching\CacheTags;
+use GeneaLabs\LaravelModelCaching\CachedModel;
 use Illuminate\Cache\TaggableStore;
 
 trait Cachable
 {
+    protected $isCachable = true;
+
     protected function cache(array $tags = [])
     {
         $cache = cache();
 
         if (is_subclass_of($cache->getStore(), TaggableStore::class)) {
+            if (is_a($this, CachedModel::class)) {
+                array_push($tags, str_slug(get_called_class()));
+            }
+
             $cache = $cache->tags($tags);
         }
 
         return $cache;
     }
+
+    public function disableCache()
+    {
+        session(['genealabs-laravel-model-caching-is-disabled' => true]);
+        $this->isCachable = false;
+
+        return $this;
+    }
+
+    public function flushCache(array $tags = [])
+    {
+        $this->cache($tags)->flush();
+    }
+
+    protected function makeCacheKey(array $columns = ['*'], $idColumn = null) : string
+    {
+        return (new CacheKey($this->eagerLoad, $this->model, $this->query))
+            ->make($columns, $idColumn);
+    }
+
+    protected function makeCacheTags() : array
+    {
+        return (new CacheTags($this->eagerLoad, $this->model))
+            ->make();
+    }
 }