feat: implement configurable avatar caching (#170)

- Add option to enable/disable caching
- Add configurable cache duration (default: 24 hours)
- Add cache key prefix to avoid conflicts
- Update toBase64() method to respect cache configuration
- Document cache options in config file

This fixes the issue where avatars were cached forever with no way to
configure or disable the cache, making it difficult to see setting changes.

Author: ramaID

config/config.php

@@ -19,6 +19,26 @@
     */
     'driver' => env('IMAGE_DRIVER', 'gd'),
 
+    /*
+    |--------------------------------------------------------------------------
+    | Cache Configuration
+    |--------------------------------------------------------------------------
+    | Control caching behavior for avatars
+    |
+    */
+    'cache' => [
+        // Set to true to enable caching, false to disable
+        'enabled' => env('AVATAR_CACHE_ENABLED', true),
+
+        // Cache prefix to avoid conflicts with other cached items
+        'key_prefix' => 'avatar_',
+
+        // Cache duration in seconds
+        // Set to null to cache forever, 0 to disable cache
+        // Default: 86400 (24 hours)
+        'duration' => env('AVATAR_CACHE_DURATION', 86400),
+    ],
+
     // Initial generator class
     'generator' => \Laravolt\Avatar\Generator\DefaultGenerator::class,
 

src/Avatar.php

@@ -78,6 +78,11 @@ class Avatar
 
     protected array $defaultTheme = [];
 
+    // Cache configuration properties
+    protected bool $cacheEnabled = true;
+    protected string $cacheKeyPrefix = 'avatar_';
+    protected ?int $cacheDuration = 86400; // 24 hours by default
+
     /**
      * Avatar constructor.
      *
@@ -93,6 +98,13 @@ public function __construct(array $config = [], ?Repository $cache = null)
         $this->applyTheme($this->defaultTheme);
         $this->initialGenerator = new DefaultGenerator();
 
+        // Set up cache configuration
+        if (isset($config['cache'])) {
+            $this->cacheEnabled = $config['cache']['enabled'] ?? true;
+            $this->cacheKeyPrefix = $config['cache']['key_prefix'] ?? 'avatar_';
+            $this->cacheDuration = $config['cache']['duration'] ?? 86400; // 24 hours by default
+        }
+
         // Add any additional themes for further use
         $themes = $this->resolveTheme('*', $config['themes'] ?? []);
         foreach ($themes as $name => $conf) {
@@ -183,16 +195,31 @@ protected function resolveTheme(array|string|null $theme, array $cfg): array
 
     public function toBase64(): string
     {
-        $key = $this->cacheKey();
+        if (!$this->cacheEnabled) {
+            // Skip cache if it's disabled
+            $this->buildAvatar();
+            return $this->image->toPng()->toDataUri();
+        }
+
+        $key = $this->cacheKeyPrefix . $this->cacheKey();
+
+        // Check if the image is in the cache
         if ($base64 = $this->cache->get($key)) {
             return $base64;
         }
 
+        // Generate the avatar
         $this->buildAvatar();
-
         $base64 = $this->image->toPng()->toDataUri();
 
-        $this->cache->forever($key, $base64);
+        // Store in cache based on configured duration
+        if ($this->cacheDuration === null) {
+            // Cache forever
+            $this->cache->forever($key, $base64);
+        } else {
+            // Cache for specified duration (in seconds)
+            $this->cache->put($key, $base64, $this->cacheDuration);
+        }
 
         return $base64;
     }