Merge pull request #93 from renoki-co/feature/method-defined-caching

[3.x] Cache by methods defined in the model

Author: rennokki

src/FlushQueryCacheObserver.php

@@ -147,6 +147,7 @@ public function morphToManyUpdatedExistingPivot($relation, Model $model, $ids)
      * @param  string|null  $relation
      * @param  \Illuminate\Database\Eloquent\Collection|null  $pivotedModels
      * @return void
+     *
      * @throws Exception
      */
     protected function invalidateCache(Model $model, $relation = null, $pivotedModels = null): void

src/Traits/QueryCacheable.php

@@ -91,22 +91,42 @@ protected function newBaseQueryBuilder()
             $builder->cacheFor($this->cacheFor);
         }
 
+        if (method_exists($this, 'cacheForValue')) {
+            $builder->cacheFor($this->cacheForValue($builder));
+        }
+
         if ($this->cacheTags) {
             $builder->cacheTags($this->cacheTags);
         }
 
+        if (method_exists($this, 'cacheTagsValue')) {
+            $builder->cacheTags($this->cacheTagsValue($builder));
+        }
+
         if ($this->cachePrefix) {
             $builder->cachePrefix($this->cachePrefix);
         }
 
+        if (method_exists($this, 'cachePrefixValue')) {
+            $builder->cachePrefix($this->cachePrefixValue($builder));
+        }
+
         if ($this->cacheDriver) {
             $builder->cacheDriver($this->cacheDriver);
         }
 
+        if (method_exists($this, 'cacheDriverValue')) {
+            $builder->cacheDriver($this->cacheDriverValue($builder));
+        }
+
         if ($this->cacheUsePlainKey) {
             $builder->withPlainKey();
         }
 
+        if (method_exists($this, 'cacheUsePlainKeyValue')) {
+            $builder->withPlainKey($this->cacheUsePlainKeyValue($builder));
+        }
+
         return $builder->cacheBaseTags($this->getCacheBaseTags());
     }
 }

tests/Models/Book.php

@@ -14,4 +14,14 @@ class Book extends Model
     protected $fillable = [
         'name',
     ];
+
+    protected function cacheUsePlainKeyValue()
+    {
+        return $this->cacheUsePlainKey;
+    }
+
+    protected function cacheForValue()
+    {
+        return 3600;
+    }
 }

tests/Models/Kid.php

@@ -21,4 +21,14 @@ protected function getCacheBaseTags(): array
             //
         ];
     }
+
+    protected function cacheUsePlainKeyValue()
+    {
+        return $this->cacheUsePlainKey;
+    }
+
+    protected function cacheForValue()
+    {
+        return 3600;
+    }
 }

tests/Models/Page.php

@@ -23,4 +23,14 @@ protected function getCacheBaseTags(): array
             'test',
         ];
     }
+
+    protected function cacheUsePlainKeyValue()
+    {
+        return $this->cacheUsePlainKey;
+    }
+
+    protected function cacheForValue()
+    {
+        return 3600;
+    }
 }

tests/Models/Post.php

@@ -21,4 +21,14 @@ protected function getCacheBaseTags(): array
             //
         ];
     }
+
+    protected function cacheUsePlainKeyValue()
+    {
+        return $this->cacheUsePlainKey;
+    }
+
+    protected function cacheForValue()
+    {
+        return 3600;
+    }
 }

tests/Models/Role.php

@@ -21,4 +21,14 @@ protected function getCacheBaseTags(): array
             //
         ];
     }
+
+    protected function cacheUsePlainKeyValue()
+    {
+        return $this->cacheUsePlainKey;
+    }
+
+    protected function cacheForValue()
+    {
+        return 3600;
+    }
 }

tests/Models/User.php

@@ -32,6 +32,16 @@ protected function getCacheBaseTags(): array
         ];
     }
 
+    protected function cacheUsePlainKeyValue()
+    {
+        return $this->cacheUsePlainKey;
+    }
+
+    protected function cacheForValue()
+    {
+        return 3600;
+    }
+
     public function getCacheTagsToInvalidateOnUpdate($relation = null, $pivotedModels = null): array
     {
         if ($relation === 'roles') {