wip

README.md

@@ -25,17 +25,6 @@ php artisan vendor:publish --tag="modelcache-config"
 
 Implement the `Foxws\ModelCache\Concerns\InteractsWithModelCache` trait to your Eloquent models:
 
-```php
-use Foxws\ModelCache\Concerns\InteractsWithModelCache;
-use Illuminate\Foundation\Auth\User as Authenticatable;
-
-class User extends Authenticatable
-{
-    use InteractsWithModelCache;
-}
-
-```
-
 ```php
 use Foxws\ModelCache\Concerns\InteractsWithModelCache;
 use Illuminate\Database\Eloquent\Model;
@@ -47,24 +36,48 @@ class Video extends Model
 
 ```
 
+### Model instances
+
 To cache a model value:
 
 ```php
-User::first()->modelCache('randomSeed', 0.5);
+Video::first()->modelCache('currentTime', 20);
 Video::first()->modelCache('currentTime', 20, now()->addDay()); // cache for one day
 ```
 
 To get a cached value:
 
 ```php
-User::first()->modelCached('randomSeed');
+Video::first()->modelCached('currentTime');
 Video::first()->modelCached('currentTime', $default); // with fallback
 ```
 
 To forget a value:
 
 ```php
 Video::first()->modelCacheForget('currentTime');
+Video::first()->modelCacheForget('viewed_at');
+```
+
+### Model class caching
+
+To register a model class cache value:
+
+```php
+Video::modelCacheClass('randomSeed', 0.1);
+```
+
+To retrieve a model class cached value:
+
+```php
+Video::modelCachedClass('randomSeed');
+Video::modelCachedClass('randomSeed', $default);
+```
+
+To forget a model class cached value:
+
+```php
+Video::modelCacheClassForget('randomSeed');
 ```
 
 ### Creating a custom cache profile

src/Concerns/InteractsWithModelCache.php

@@ -7,6 +7,29 @@
 
 trait InteractsWithModelCache
 {
+    public static function modelCacheClass(string $key, mixed $value = null, DateTime|int|null $ttl = null): mixed
+    {
+        if (! ModelCache::shouldCache(static::class, $key, $value)) {
+            return null;
+        }
+
+        return ModelCache::cache(static::class, $key, $value, $ttl);
+    }
+
+    public static function modelCachedClass(string $key, mixed $default = null): mixed
+    {
+        if (! ModelCache::enabled() || ! ModelCache::hasBeenCached(static::class, $key)) {
+            return $default;
+        }
+
+        return ModelCache::getCachedValue(static::class, $key) ?? $default;
+    }
+
+    public static function modelCacheClassForget(string $key): void
+    {
+        ModelCache::forget(static::class, $key);
+    }
+
     public function modelCache(string $key, mixed $value = null, DateTime|int|null $ttl = null): mixed
     {
         if (! ModelCache::shouldCache($this, $key, $value)) {