Change useCacheCooldown to cacheCooldownSeconds

Author: mikebronner

README.md

@@ -124,13 +124,13 @@ For example you might have a busy site where comments are submitted at a high
 rate, and you don't want every comment submission to invalidate the cache. While
 I don't necessarily recommend this, you might experiment it's effectiveness.
 
-To ise it, it must be enabled in the model:
+To use it, it must be enabled in the model (or base model if you want to use it on multiple or all models):
 ```php
 class MyModel extends Model
 {
     use Cachable;
 
-    protected $useCacheCooldown = true;
+    protected $cacheCooldownSeconds = 300; // 5 minutes
 
     // ...
 }
@@ -139,7 +139,14 @@ class MyModel extends Model
 After that it can be implemented in queries:
 ```php
 (new Comment)
-    ->withCacheCooldownSeconds(30)
+    ->withCacheCooldownSeconds(30) // override default cooldown seconds in model
+    ->get();
+```
+
+or:
+```php
+(new Comment)
+    ->withCacheCooldownSeconds() // use default cooldown seconds in model
     ->get();
 ```
 

src/Traits/Caching.php

@@ -93,7 +93,7 @@ protected function makeCacheTags() : array
 
     public function getModelCacheCooldown(Model $instance) : array
     {
-        if (! $instance->useCacheCooldown) {
+        if (! $instance->cacheCooldownSeconds) {
             return [null, null, null];
         }
 

src/Traits/ModelCaching.php

@@ -6,7 +6,7 @@
 
 trait ModelCaching
 {
-    protected $useCacheCooldown = false;
+    protected $cacheCooldownSeconds = 0;
 
     public static function all($columns = ['*'])
     {
@@ -88,8 +88,12 @@ public function scopeDisableCache(EloquentBuilder $query) : EloquentBuilder
 
     public function scopeWithCacheCooldownSeconds(
         EloquentBuilder $query,
-        int $seconds
+        int $seconds = null
     ) : EloquentBuilder {
+        if (! $seconds) {
+            $seconds = $this->cacheCooldownSeconds;
+        }
+
         $cachePrefix = $this->getCachePrefix();
         $modelClassName = get_class($this);
         $cacheKey = "{$cachePrefix}:{$modelClassName}-cooldown:seconds";
@@ -108,8 +112,8 @@ public function scopeWithCacheCooldownSeconds(
         return $query;
     }
 
-    public function getUseCacheCooldownAttribute() : bool
+    public function getcacheCooldownSecondsAttribute() : bool
     {
-        return $this->useCacheCooldown;
+        return $this->cacheCooldownSeconds;
     }
 }

tests/Fixtures/AuthorWithCooldown.php

@@ -8,5 +8,5 @@
 class AuthorWithCooldown extends Author
 {
     protected $table = "authors";
-    protected $useCacheCooldown = true;
+    protected $cacheCooldownSeconds = 1;
 }