silviooosilva / CacheerPHP

src/Utils/CacheDriver.php

Indentation +31 added lines, -31 removed lines

@@ -20,8 +20,8 @@ 
 {
 
     /**
-    * @var Cacheer
-    */
+     * @var Cacheer
+     */
     protected $cacheer;
 
     /** @param string $logPath */
@@ -38,10 +38,10 @@ 
     }
 
     /**
-    * Uses the database driver for caching.
-    * 
-    * @return Cacheer
-    */
+     * Uses the database driver for caching.
+     * 
+     * @return Cacheer
+     */
     public function useDatabaseDriver()
     {
         $this->cacheer->cacheStore = new DatabaseCacheStore($this->logPath);
@@ -49,10 +49,10 @@ 
     }
 
     /**
-    * Uses the file driver for caching.
-    *
-    * @return Cacheer
-    */
+     * Uses the file driver for caching.
+     *
+     * @return Cacheer
+     */
     public function useFileDriver()
     {
         $this->cacheer->options['loggerPath'] = $this->logPath;
@@ -61,10 +61,10 @@ 
     }
 
     /**
-    * Uses the Redis driver for caching.
-    * 
-    * @return Cacheer
-    */
+     * Uses the Redis driver for caching.
+     * 
+     * @return Cacheer
+     */
     public function useRedisDriver()
     {
         $this->cacheer->cacheStore = new RedisCacheStore($this->logPath);
@@ -72,10 +72,10 @@ 
     }
 
     /**
-    * Uses the array driver for caching.
-    * 
-    * @return Cacheer
-    */
+     * Uses the array driver for caching.
+     * 
+     * @return Cacheer
+     */
     public function useArrayDriver()
     {
         $this->cacheer->cacheStore = new ArrayCacheStore($this->logPath);
@@ -83,10 +83,10 @@ 
     }
 
     /**
-    * Uses the default driver for caching.
-    * 
-    * @return Cacheer
-    */
+     * Uses the default driver for caching.
+     * 
+     * @return Cacheer
+     */
     public function useDefaultDriver()
     {
         if (!isset($this->cacheer->options['cacheDir'])) {
@@ -103,16 +103,16 @@ 
     }
 
     /**
-    * Checks if the directory exists or creates it.
-    *
-    * @param mixed $dirName
-    * @return bool
-    */
+     * Checks if the directory exists or creates it.
+     *
+     * @param mixed $dirName
+     * @return bool
+     */
     private function isDir(mixed $dirName)
     {
-      if (is_dir($dirName)) {
-          return true;
-      }
-      return mkdir($dirName, 0755, true);
+        if (is_dir($dirName)) {
+            return true;
+        }
+        return mkdir($dirName, 0755, true);
     }
 }

src/Utils/CacheDataFormatter.php

Indentation +20 added lines, -20 removed lines

@@ -13,20 +13,20 @@ 
     private mixed $data;
 
     /**
-    * CacheDataFormatter constructor.
-    *
-    * @param mixed $data
-    */
+     * CacheDataFormatter constructor.
+     *
+     * @param mixed $data
+     */
     public function __construct(mixed $data)
     {
         $this->data = $data;
     }
 
     /**
-    * Converts the data to JSON format.
-    *
-    * @return string|false
-    */
+     * Converts the data to JSON format.
+     *
+     * @return string|false
+     */
     public function toJson()
     {
         return json_encode(
@@ -38,30 +38,30 @@ 
     }
 
     /**
-    * Converts the data to an array.
-    * 
-    * @return array
-    */
+     * Converts the data to an array.
+     * 
+     * @return array
+     */
     public function toArray()
     {
         return (array)$this->data;
     }
 
     /**
-    * Converts the data to a string.
-    * 
-    * @return string
-    */
+     * Converts the data to a string.
+     * 
+     * @return string
+     */
     public function toString()
     {
         return (string)$this->data;
     }
 
     /**
-    * Converts the data to an object.
-    * 
-    * @return object
-    */
+     * Converts the data to an object.
+     * 
+     * @return object
+     */
     public function toObject()
     {
         return (object)$this->data;

src/Repositories/CacheDatabaseRepository.php

Indentation +64 added lines, -64 removed lines

@@ -60,12 +60,12 @@ 
     }
 
     /**
-    * Retrieves cache data from the database.
-    * 
-    * @param string $cacheKey
-    * @param string $namespace
-    * @return mixed
-    */
+     * Retrieves cache data from the database.
+     * 
+     * @param string $cacheKey
+     * @param string $namespace
+     * @return mixed
+     */
     public function retrieve(string $cacheKey, string $namespace = '')
     {
         $driver = $this->connection->getAttribute(PDO::ATTR_DRIVER_NAME);
@@ -85,11 +85,11 @@ 
     }
 
     /**
-    * Retrieves multiple cache items by their keys. 
-    * @param array $cacheKeys
-    * @param string $namespace
-    * @return array
-    */
+     * Retrieves multiple cache items by their keys. 
+     * @param array $cacheKeys
+     * @param string $namespace
+     * @return array
+     */
     public function getAll(string $namespace = '')
     {
         $driver = $this->connection->getAttribute(PDO::ATTR_DRIVER_NAME);
@@ -110,10 +110,10 @@ 
     }
 
     /**
-    * Get Update query based on the database driver.
-    *
-    * @return string
-    */
+     * Get Update query based on the database driver.
+     *
+     * @return string
+     */
     private function getUpdateQueryWithDriver()
     {
         $driver = $this->connection->getAttribute(PDO::ATTR_DRIVER_NAME);
@@ -124,10 +124,10 @@ 
     }
 
     /**
-    * Get Delete query based on the database driver.
-    * 
-    * @return string
-    */
+     * Get Delete query based on the database driver.
+     * 
+     * @return string
+     */
     private function getDeleteQueryWithDriver()
     {
         $driver = $this->connection->getAttribute(PDO::ATTR_DRIVER_NAME);
@@ -138,13 +138,13 @@ 
     }
 
     /**
-    * Updates an existing cache item in the database.
-    * 
-    * @param string $cacheKey
-    * @param mixed  $cacheData
-    * @param string $namespace
-    * @return bool
-    */
+     * Updates an existing cache item in the database.
+     * 
+     * @param string $cacheKey
+     * @param mixed  $cacheData
+     * @param string $namespace
+     * @return bool
+     */
     public function update(string $cacheKey, mixed $cacheData, string $namespace = '')
     {
         $query = $this->getUpdateQueryWithDriver();
@@ -158,12 +158,12 @@ 
     }
 
     /**
-    * Clears a specific cache item from the database.
-    * 
-    * @param string $cacheKey
-    * @param string $namespace
-    * @return bool
-    */
+     * Clears a specific cache item from the database.
+     * 
+     * @param string $cacheKey
+     * @param string $namespace
+     * @return bool
+     */
     public function clear(string $cacheKey, string $namespace = '')
     {
         $query = $this->getDeleteQueryWithDriver();
@@ -176,10 +176,10 @@ 
     }
 
     /**
-    * Gets the query to renew the expiration time of a cache item based on the database driver.
-    *  
-    * @return string
-    */
+     * Gets the query to renew the expiration time of a cache item based on the database driver.
+     *  
+     * @return string
+     */
     private function getRenewExpirationQueryWithDriver(): string
     {
         $driver = $this->connection->getAttribute(PDO::ATTR_DRIVER_NAME);
@@ -194,13 +194,13 @@ 
     }
 
     /**
-    * Checks if a cache item is valid based on its key, namespace, and current time.
-    * 
-    * @param string $cacheKey
-    * @param string $namespace
-    * @param string $currentTime
-    * @return bool
-    */
+     * Checks if a cache item is valid based on its key, namespace, and current time.
+     * 
+     * @param string $cacheKey
+     * @param string $namespace
+     * @param string $currentTime
+     * @return bool
+     */
     private function hasValidCache(string $cacheKey, string $namespace, string $currentTime): bool
     {
         $stmt = $this->connection->prepare(
@@ -216,13 +216,13 @@ 
     }
 
     /**
-    * Renews the expiration time of a cache item.
-    * 
-    * @param string $cacheKey
-    * @param string|int $ttl
-    * @param string $namespace
-    * @return bool
-    */
+     * Renews the expiration time of a cache item.
+     * 
+     * @param string $cacheKey
+     * @param string|int $ttl
+     * @param string $namespace
+     * @return bool
+     */
     public function renew(string $cacheKey, string|int $ttl, string $namespace = '')
     {
         $currentTime = date('Y-m-d H:i:s');
@@ -242,32 +242,32 @@ 
     }
 
     /**
-    * Flushes all cache items from the database.
-    * 
-    * @return bool
-    */
+     * Flushes all cache items from the database.
+     * 
+     * @return bool
+     */
     public function flush()
     {
         return $this->connection->exec("DELETE FROM cacheer_table") !== false;
     }
 
     /**
-    * Serializes or unserializes data based on the provided flag.
-    * 
-    * @param mixed $data
-    * @return string
-    */
+     * Serializes or unserializes data based on the provided flag.
+     * 
+     * @param mixed $data
+     * @return string
+     */
     private function serialize(mixed $data, bool $serialize = true)
     {
         return $serialize ? serialize($data) : unserialize($data);
     }
 
     /**
-    * Gets the current date and time based on the database driver.
-    * 
-    * @param string $driver
-    * @return string
-    */
+     * Gets the current date and time based on the database driver.
+     * 
+     * @param string $driver
+     * @return string
+     */
     private function getCurrentDateTime(string $driver)
     {
         return ($driver === 'sqlite') ? "DATETIME('now', 'localtime')" : "NOW()";

src/Support/TimeBuilder.php

Indentation +93 added lines, -93 removed lines

@@ -13,112 +13,112 @@
 class TimeBuilder
 {
 
-  /** @param string $unit */
-  private string $unit;
-
-  /** @param int $value */
-  private int $value;
-
-  /** @param Closure $callback */
-  private Closure $callback;
-
-  /** @param FileOptionBuilder */
-  private $builder = null;
-
-  /**
-  * TimeBuilder constructor.
-  * @param Closure $callback
-  * @param FileOptionBuilder $builder
-  *
-  * @return void
-  */
-  public function __construct(Closure $callback, $builder)
-  {
+    /** @param string $unit */
+    private string $unit;
+
+    /** @param int $value */
+    private int $value;
+
+    /** @param Closure $callback */
+    private Closure $callback;
+
+    /** @param FileOptionBuilder */
+    private $builder = null;
+
+    /**
+     * TimeBuilder constructor.
+     * @param Closure $callback
+     * @param FileOptionBuilder $builder
+     *
+     * @return void
+     */
+    public function __construct(Closure $callback, $builder)
+    {
     $this->callback = $callback;
     $this->builder = $builder;
-  }
-
-  /**
-  * Sets the time in seconds.
-  * 
-  * @param int $seconds
-  * @return FileOptionBuilder|mixed
-  */
-  public function second(int $seconds) 
-  {
+    }
+
+    /**
+     * Sets the time in seconds.
+     * 
+     * @param int $seconds
+     * @return FileOptionBuilder|mixed
+     */
+    public function second(int $seconds) 
+    {
     return $this->setTime($seconds, "seconds");
-  }
-
-  /**
-  * Sets the time in minutes.
-  *
-  * @param int $minutes
-  * @return FileOptionBuilder|mixed
-  */
-  public function minute(int $minutes) 
-  {
+    }
+
+    /**
+     * Sets the time in minutes.
+     *
+     * @param int $minutes
+     * @return FileOptionBuilder|mixed
+     */
+    public function minute(int $minutes) 
+    {
     return $this->setTime($minutes, "minutes");
-  }
-
-  /**
-  * Sets the time in hours.
-  * 
-  * @param int $hours
-  * @return FileOptionBuilder|mixed
-  */
-  public function hour(int $hours) 
-  {
+    }
+
+    /**
+     * Sets the time in hours.
+     * 
+     * @param int $hours
+     * @return FileOptionBuilder|mixed
+     */
+    public function hour(int $hours) 
+    {
     return $this->setTime($hours, "hours");
-  }
-
-  /**
-  * Sets the time in days.
-  *
-  * @param int $days
-  * @return FileOptionBuilder|mixed
-  */
-  public function day(int $days) 
-  {
+    }
+
+    /**
+     * Sets the time in days.
+     *
+     * @param int $days
+     * @return FileOptionBuilder|mixed
+     */
+    public function day(int $days) 
+    {
     return $this->setTime($days, "days");
-  }
-
-  /**
-  * Sets the time in weeks.
-  *
-  * @param int $weeks
-  * @return FileOptionBuilder|mixed
-  */
-  public function week(int $weeks) 
-  {
+    }
+
+    /**
+     * Sets the time in weeks.
+     *
+     * @param int $weeks
+     * @return FileOptionBuilder|mixed
+     */
+    public function week(int $weeks) 
+    {
     return $this->setTime($weeks, "weeks");
-  }
-
-  /**
-  * Sets the time in months.
-  *
-  * @param int $months
-  * @return FileOptionBuilder|mixed
-  */
-  public function month(int $months) 
-  {
+    }
+
+    /**
+     * Sets the time in months.
+     *
+     * @param int $months
+     * @return FileOptionBuilder|mixed
+     */
+    public function month(int $months) 
+    {
     return $this->setTime($months, "months");
-  }
+    }
   
 
-  /** 
-  * This method sets the time value and unit, and invokes the callback with the formatted string. 
-  *
-  * @param int $value
-  * @param string $unit
-  * @return FileOptionBuilder
-  */
-  private function setTime(int $value, string $unit) 
-  {
+    /** 
+     * This method sets the time value and unit, and invokes the callback with the formatted string. 
+     *
+     * @param int $value
+     * @param string $unit
+     * @return FileOptionBuilder
+     */
+    private function setTime(int $value, string $unit) 
+    {
 
     $this->value = $value;
     $this->unit = $unit;
-   ($this->callback)("{$value} {$unit}");
+    ($this->callback)("{$value} {$unit}");
     return $this->builder;
-  }
+    }
 
 }

src/CacheStore/FileCacheStore.php

Indentation +6 added lines, -6 removed lines

@@ -43,18 +43,18 @@
 
 
     /**
-    * @var CacheLogger
-    */
+     * @var CacheLogger
+     */
     private $logger = null;
 
     /**
-    * @var FileCacheManager
-    */
+     * @var FileCacheManager
+     */
     private FileCacheManager $fileManager;
 
     /**
-    * @var FileCacheFlusher
-    */
+     * @var FileCacheFlusher
+     */
     private FileCacheFlusher $flusher;
 
 

src/CacheStore/CacheManager/FileCacheFlusher.php

Indentation +20 added lines, -20 removed lines

@@ -12,18 +12,18 @@ 
 class FileCacheFlusher
 {
     /**
-    * @var FileCacheManager
-    */
+     * @var FileCacheManager
+     */
     private FileCacheManager $fileManager;
 
     /**
-    * @var string $cacheDir
-    */
+     * @var string $cacheDir
+     */
     private string $cacheDir;
 
     /**
-    * @var string $lastFlushTimeFile
-    */
+     * @var string $lastFlushTimeFile
+     */
     private string $lastFlushTimeFile;
 
     /**
@@ -40,10 +40,10 @@ 
     }
 
     /**
-    * Flushes all cache items and updates the last flush timestamp.
-    *
-    * @return void
-    */
+     * Flushes all cache items and updates the last flush timestamp.
+     *
+     * @return void
+     */
     public function flushCache()
     {
         $this->fileManager->clearDirectory($this->cacheDir);
@@ -51,11 +51,11 @@ 
     }
 
     /**
-    * Handles the auto-flush functionality based on options.
-    *
-    * @param array $options
-    * @return void
-    */
+     * Handles the auto-flush functionality based on options.
+     *
+     * @param array $options
+     * @return void
+     */
     public function handleAutoFlush(array $options)
     {
         if (isset($options['flushAfter'])) {
@@ -64,11 +64,11 @@ 
     }
 
     /**
-    * Schedules a flush operation based on the provided interval.
-    *
-    * @param string $flushAfter
-    * @return void
-    */
+     * Schedules a flush operation based on the provided interval.
+     *
+     * @param string $flushAfter
+     * @return void
+     */
     private function scheduleFlush(string $flushAfter)
     {
         $flushAfterSeconds = CacheFileHelper::convertExpirationToSeconds($flushAfter);

src/Service/CacheRetriever.php

Indentation +50 added lines, -50 removed lines

@@ -15,28 +15,28 @@ 
 class CacheRetriever
 {
     /**
-    * @var Cacheer
-    */
+     * @var Cacheer
+     */
     private Cacheer $cacheer;
 
     /**
-    * CacheRetriever constructor.
-    *
-    * @param Cacheer $cacheer
-    */
+     * CacheRetriever constructor.
+     *
+     * @param Cacheer $cacheer
+     */
     public function __construct(Cacheer $cacheer)
     {
         $this->cacheer = $cacheer;
     }
 
     /**
-    * Retrieves a cache item by its key.
-    *
-    * @param string $cacheKey
-    * @param string $namespace
-    * @param int|string $ttl
-    * @return mixed
-    */
+     * Retrieves a cache item by its key.
+     *
+     * @param string $cacheKey
+     * @param string $namespace
+     * @param int|string $ttl
+     * @return mixed
+     */
     public function getCache(string $cacheKey, string $namespace = '', int|string $ttl = 3600)
     {
         $cacheData = $this->cacheer->cacheStore->getCache($cacheKey, $namespace, $ttl);
@@ -50,13 +50,13 @@ 
     }
 
     /**
-    * Retrieves multiple cache items by their keys.
-    *
-    * @param array $cacheKeys
-    * @param string $namespace
-    * @param int|string $ttl
-    * @return array|CacheDataFormatter
-    */
+     * Retrieves multiple cache items by their keys.
+     *
+     * @param array $cacheKeys
+     * @param string $namespace
+     * @param int|string $ttl
+     * @return array|CacheDataFormatter
+     */
     public function getMany(array $cacheKeys, string $namespace = '', int|string $ttl = 3600)
     {
         $cachedData = $this->cacheer->cacheStore->getMany($cacheKeys, $namespace, $ttl);
@@ -72,11 +72,11 @@ 
     }
 
     /**
-    * Retrieves all cache items in a namespace.
-    *
-    * @param string $namespace
-    * @return CacheDataFormatter|mixed
-    */
+     * Retrieves all cache items in a namespace.
+     *
+     * @param string $namespace
+     * @return CacheDataFormatter|mixed
+     */
     public function getAll(string $namespace = '')
     {
         $cachedData = $this->cacheer->cacheStore->getAll($namespace);
@@ -92,12 +92,12 @@ 
     }
 
     /**
-    * Retrieves a cache item, deletes it, and returns its data.
-    *
-    * @param string $cacheKey
-    * @param string $namespace
-    * @return mixed|null
-    */
+     * Retrieves a cache item, deletes it, and returns its data.
+     *
+     * @param string $cacheKey
+     * @param string $namespace
+     * @return mixed|null
+     */
     public function getAndForget(string $cacheKey, string $namespace = '')
     {
         $cachedData = $this->getCache($cacheKey, $namespace);
@@ -112,13 +112,13 @@ 
     }
 
     /**
-    * Retrieves a cache item, or executes a callback to store it if not found.
-    *
-    * @param string $cacheKey
-    * @param int|string $ttl
-    * @param Closure $callback
-    * @return mixed
-    */
+     * Retrieves a cache item, or executes a callback to store it if not found.
+     *
+     * @param string $cacheKey
+     * @param int|string $ttl
+     * @param Closure $callback
+     * @return mixed
+     */
     public function remember(string $cacheKey, int|string $ttl, Closure $callback)
     {
         $cachedData = $this->getCache($cacheKey, ttl: $ttl);
@@ -133,24 +133,24 @@ 
     }
 
     /**
-    * Retrieves a cache item indefinitely, or executes a callback to store it if not found.
-    *
-    * @param string $cacheKey
-    * @param Closure $callback
-    * @return mixed
-    */
+     * Retrieves a cache item indefinitely, or executes a callback to store it if not found.
+     *
+     * @param string $cacheKey
+     * @param Closure $callback
+     * @return mixed
+     */
     public function rememberForever(string $cacheKey, Closure $callback)
     {
         return $this->remember($cacheKey, 31536000 * 1000, $callback);
     }
 
     /**
-    * Checks if a cache item exists.
-    *
-    * @param string $cacheKey
-    * @param string $namespace
-    * @return void
-    */
+     * Checks if a cache item exists.
+     *
+     * @param string $cacheKey
+     * @param string $namespace
+     * @return void
+     */
     public function has(string $cacheKey, string $namespace = '')
     {
         $this->cacheer->cacheStore->has($cacheKey, $namespace);

src/Service/CacheMutator.php

Indentation +71 added lines, -71 removed lines

@@ -13,29 +13,29 @@ 
 class CacheMutator
 {
     /**
-    * @var Cacheer
-    */
+     * @var Cacheer
+     */
     private Cacheer $cacheer;
 
     /**
-    * CacheMutator constructor.
-    *
-    * @param Cacheer $cacheer
-    */
+     * CacheMutator constructor.
+     *
+     * @param Cacheer $cacheer
+     */
     public function __construct(Cacheer $cacheer)
     {
         $this->cacheer = $cacheer;
     }
 
     /**
-    * Adds a cache item if it does not already exist.
-    *
-    * @param string $cacheKey
-    * @param mixed $cacheData
-    * @param string $namespace
-    * @param int|string $ttl
-    * @return bool
-    */
+     * Adds a cache item if it does not already exist.
+     *
+     * @param string $cacheKey
+     * @param mixed $cacheData
+     * @param string $namespace
+     * @param int|string $ttl
+     * @return bool
+     */
     public function add(string $cacheKey, mixed $cacheData, string $namespace = '', int|string $ttl = 3600)
     {
         if (!empty($this->cacheer->getCache($cacheKey, $namespace))) {
@@ -49,13 +49,13 @@ 
     }
 
     /**
-    * Appends data to an existing cache item.
-    *
-    * @param string $cacheKey
-    * @param mixed $cacheData
-    * @param string $namespace
-    * @return void
-    */
+     * Appends data to an existing cache item.
+     *
+     * @param string $cacheKey
+     * @param mixed $cacheData
+     * @param string $namespace
+     * @return void
+     */
     public function appendCache(string $cacheKey, mixed $cacheData, string $namespace = '')
     {
         $this->cacheer->cacheStore->appendCache($cacheKey, $cacheData, $namespace);
@@ -63,12 +63,12 @@ 
     }
 
     /**
-    * Clears a specific cache item.
-    *
-    * @param string $cacheKey
-    * @param string $namespace
-    * @return void
-    */
+     * Clears a specific cache item.
+     *
+     * @param string $cacheKey
+     * @param string $namespace
+     * @return void
+     */
     public function clearCache(string $cacheKey, string $namespace = '')
     {
         $this->cacheer->cacheStore->clearCache($cacheKey, $namespace);
@@ -76,25 +76,25 @@ 
     }
 
     /**
-    * Decrements a numeric cache item by a specified amount.
-    *
-    * @param string $cacheKey
-    * @param int $amount
-    * @param string $namespace
-    * @return bool
-    */
+     * Decrements a numeric cache item by a specified amount.
+     *
+     * @param string $cacheKey
+     * @param int $amount
+     * @param string $namespace
+     * @return bool
+     */
     public function decrement(string $cacheKey, int $amount = 1, string $namespace = '')
     {
         return $this->increment($cacheKey, ($amount * -1), $namespace);
     }
 
     /**
-    * Checks if a cache item exists.
-    *
-    * @param string $cacheKey
-    * @param string $namespace
-    * @return void
-    */
+     * Checks if a cache item exists.
+     *
+     * @param string $cacheKey
+     * @param string $namespace
+     * @return void
+     */
     public function forever(string $cacheKey, mixed $cacheData)
     {
         $this->putCache($cacheKey, $cacheData, ttl: 31536000 * 1000);
@@ -102,10 +102,10 @@ 
     }
 
     /**
-    * Flushes the entire cache.
-    *
-    * @return void
-    */
+     * Flushes the entire cache.
+     *
+     * @return void
+     */
     public function flushCache()
     {
         $this->cacheer->cacheStore->flushCache();
@@ -113,12 +113,12 @@ 
     }
 
     /**
-    * Gets a cache item by its key.
-    *
-    * @param string $cacheKey
-    * @param string $namespace
-    * @return bool
-    */
+     * Gets a cache item by its key.
+     *
+     * @param string $cacheKey
+     * @param string $namespace
+     * @return bool
+     */
     public function increment(string $cacheKey, int $amount = 1, string $namespace = '')
     {
         $cacheData = $this->cacheer->getCache($cacheKey, $namespace);
@@ -133,13 +133,13 @@ 
     }
 
     /**
-    * Gets a cache item by its key.
-    *
-    * @param string $cacheKey
-    * @param string $namespace
-    * @param int|string $ttl
-    * @return void
-    */
+     * Gets a cache item by its key.
+     *
+     * @param string $cacheKey
+     * @param string $namespace
+     * @param int|string $ttl
+     * @return void
+     */
     public function putCache(string $cacheKey, mixed $cacheData, string $namespace = '', int|string $ttl = 3600)
     {
         $data = CacheerHelper::prepareForStorage($cacheData, $this->cacheer->isCompressionEnabled(), $this->cacheer->getEncryptionKey());
@@ -148,26 +148,26 @@ 
     }
 
     /**
-    * Puts multiple cache items in a batch.
-    *
-    * @param array $items
-    * @param string $namespace
-    * @param int $batchSize
-    * @return void
-    */
+     * Puts multiple cache items in a batch.
+     *
+     * @param array $items
+     * @param string $namespace
+     * @param int $batchSize
+     * @return void
+     */
     public function putMany(array $items, string $namespace = '', int $batchSize = 100)
     {
         $this->cacheer->cacheStore->putMany($items, $namespace, $batchSize);
     }
 
     /**
-    * Renews the cache item with a new TTL.
-    *
-    * @param string $cacheKey
-    * @param int|string $ttl
-    * @param string $namespace
-    * @return void
-    */
+     * Renews the cache item with a new TTL.
+     *
+     * @param string $cacheKey
+     * @param int|string $ttl
+     * @param string $namespace
+     * @return void
+     */
     public function renewCache(string $cacheKey, int|string $ttl = 3600, string $namespace = '')
     {
         $this->cacheer->cacheStore->renewCache($cacheKey, $ttl, $namespace);

src/Cacheer.php

Indentation +176 added lines, -176 removed lines

@@ -24,57 +24,57 @@ 
 final class Cacheer implements CacheerInterface
 {
     /**
-    * @var string
-    */
+     * @var string
+     */
     private string $message;
 
     /**
-    * @var boolean
-    */
+     * @var boolean
+     */
     private bool $success;
 
     /**
-    * @var boolean
-    */
+     * @var boolean
+     */
     private bool $formatted = false;
 
     /**
-    * @var bool
-    */
+     * @var bool
+     */
     private bool $compression = false;
 
     /**
-    * @var string|null
-    */
+     * @var string|null
+     */
     private ?string $encryptionKey = null;
 
     /**
-    * @var FileCacheStore|DatabaseCacheStore|RedisCacheStore|ArrayCacheStore
-    */
+     * @var FileCacheStore|DatabaseCacheStore|RedisCacheStore|ArrayCacheStore
+     */
     public $cacheStore;
 
     /**
-    * @var array
-    */
+     * @var array
+     */
     public array $options = [];
 
     /**
-    * @var CacheRetriever
-    */
+     * @var CacheRetriever
+     */
     private CacheRetriever $retriever;
 
     /**
-    * @var CacheMutator
-    */
+     * @var CacheMutator
+     */
     private CacheMutator $mutator;
 
 /**
-    * Cacheer constructor.
-    *
-    * @param array $options
-    * @param bool  $formatted
-    * @throws RuntimeException
-    */
+ * Cacheer constructor.
+ *
+ * @param array $options
+ * @param bool  $formatted
+ * @throws RuntimeException
+ */
     public function __construct(array $options = [], bool $formatted = false)
     {
         $this->formatted = $formatted;
@@ -85,255 +85,255 @@ 
     }
 
     /**
-    * Adds data to the cache if it does not already exist.
-    *
-    * @param string $cacheKey
-    * @param mixed  $cacheData
-    * @param string $namespace
-    * @param int|string $ttl
-    * @return bool
-    */
+     * Adds data to the cache if it does not already exist.
+     *
+     * @param string $cacheKey
+     * @param mixed  $cacheData
+     * @param string $namespace
+     * @param int|string $ttl
+     * @return bool
+     */
     public function add(string $cacheKey, mixed $cacheData, string $namespace = '', int|string $ttl = 3600): bool
     {
         return $this->mutator->add($cacheKey, $cacheData, $namespace, $ttl);
     }
 
     /**
-    * Appends data to an existing cache item.
-    * 
-    * @param string $cacheKey
-    * @param mixed  $cacheData
-    * @param string $namespace
-    * @return void
-    */
+     * Appends data to an existing cache item.
+     * 
+     * @param string $cacheKey
+     * @param mixed  $cacheData
+     * @param string $namespace
+     * @return void
+     */
     public function appendCache(string $cacheKey, mixed $cacheData, string $namespace = ''): void
     {
         $this->mutator->appendCache($cacheKey, $cacheData, $namespace);
     }
 
     /**
-    * Clears a specific cache item.
-    * 
-    * @param string $cacheKey
-    * @param string $namespace
-    * @return void
-    */
+     * Clears a specific cache item.
+     * 
+     * @param string $cacheKey
+     * @param string $namespace
+     * @return void
+     */
     public function clearCache(string $cacheKey, string $namespace = ''): void
     {
         $this->mutator->clearCache($cacheKey, $namespace);
     }
 
     /**
-    * Decrements a cache item by a specified amount.
-    *  
-    * @param string $cacheKey
-    * @param int $amount
-    * @param string $namespace
-    * @return bool
-    */
+     * Decrements a cache item by a specified amount.
+     *  
+     * @param string $cacheKey
+     * @param int $amount
+     * @param string $namespace
+     * @return bool
+     */
     public function decrement(string $cacheKey, int $amount = 1, string $namespace = ''): bool
     {
         return $this->mutator->decrement($cacheKey, $amount, $namespace);
     }
 
     /**
-    * Store data in the cache permanently.
-    *
-    * @param string $cacheKey
-    * @param mixed $cacheData
-    * @return void
-    */
+     * Store data in the cache permanently.
+     *
+     * @param string $cacheKey
+     * @param mixed $cacheData
+     * @return void
+     */
     public function forever(string $cacheKey, mixed $cacheData): void
     {
         $this->mutator->forever($cacheKey, $cacheData);
     }
 
     /**
-    * Flushes all cache items.
-    * 
-    * @return void
-    */
+     * Flushes all cache items.
+     * 
+     * @return void
+     */
     public function flushCache(): void
     {
         $this->mutator->flushCache();
     }
 
     /**
-    * Retrieves a cache item and deletes it from the cache.
-    * 
-    * @param string $cacheKey
-    * @param string $namespace
-    * @return mixed
-    */
+     * Retrieves a cache item and deletes it from the cache.
+     * 
+     * @param string $cacheKey
+     * @param string $namespace
+     * @return mixed
+     */
     public function getAndForget(string $cacheKey, string $namespace = ''): mixed
     {
         return $this->retriever->getAndForget($cacheKey, $namespace);
     }
 
     /**
-    * Gets all items in a specific namespace.
-    * 
-    * @param string $namespace
-    * @return CacheDataFormatter|mixed
-    */
+     * Gets all items in a specific namespace.
+     * 
+     * @param string $namespace
+     * @return CacheDataFormatter|mixed
+     */
     public function getAll(string $namespace = ''): mixed
     {
         return $this->retriever->getAll($namespace);
     }
 
     /**
-    * Retrieves a single cache item.
-    * 
-    * @param string $cacheKey
-    * @param string $namespace
-    * @param string|int $ttl
-    * @return CacheDataFormatter|mixed
-    */
+     * Retrieves a single cache item.
+     * 
+     * @param string $cacheKey
+     * @param string $namespace
+     * @param string|int $ttl
+     * @return CacheDataFormatter|mixed
+     */
     public function getCache(string $cacheKey, string $namespace = '', string|int $ttl = 3600): mixed
     {
         return $this->retriever->getCache($cacheKey, $namespace, $ttl);
     }
 
     /**
-    * Retrieves multiple cache items by their keys.
-    * 
-    * @param array $cacheKeys
-    * @param string $namespace
-    * @param string|int $ttl
-    * @return CacheDataFormatter|mixed
-    */
+     * Retrieves multiple cache items by their keys.
+     * 
+     * @param array $cacheKeys
+     * @param string $namespace
+     * @param string|int $ttl
+     * @return CacheDataFormatter|mixed
+     */
     public function getMany(array $cacheKeys, string $namespace = '', string|int $ttl = 3600): mixed
     {
         return $this->retriever->getMany($cacheKeys, $namespace, $ttl);
     }
 
     /**
-    * Checks if a cache item exists.
-    * 
-    * @param string $cacheKey
-    * @param string $namespace
-    * @return void
-    */
+     * Checks if a cache item exists.
+     * 
+     * @param string $cacheKey
+     * @param string $namespace
+     * @return void
+     */
     public function has(string $cacheKey, string $namespace = ''): void
     {
         $this->retriever->has($cacheKey, $namespace);
     }
 
     /**
-    * Increments a cache item by a specified amount.
-    * 
-    * @param string $cacheKey
-    * @param int $amount
-    * @param string $namespace
-    * @return bool
-    */
+     * Increments a cache item by a specified amount.
+     * 
+     * @param string $cacheKey
+     * @param int $amount
+     * @param string $namespace
+     * @return bool
+     */
     public function increment(string $cacheKey, int $amount = 1, string $namespace = ''): bool
     {
         return $this->mutator->increment($cacheKey, $amount, $namespace);
     }
 
     /**
-    * Checks if the last operation was successful.
-    * 
-    * @return bool
-    */
+     * Checks if the last operation was successful.
+     * 
+     * @return bool
+     */
     public function isSuccess(): bool
     {
         return $this->success;
     }
 
     /**
-    * Stores an item in the cache with a specific TTL.
-    * 
-    * @param string $cacheKey
-    * @param mixed  $cacheData
-    * @param string $namespace
-    * @param string|int $ttl
-    * @return void
-    */
+     * Stores an item in the cache with a specific TTL.
+     * 
+     * @param string $cacheKey
+     * @param mixed  $cacheData
+     * @param string $namespace
+     * @param string|int $ttl
+     * @return void
+     */
     public function putCache(string $cacheKey, mixed $cacheData, string $namespace = '', string|int $ttl = 3600): void
     {
         $this->mutator->putCache($cacheKey, $cacheData, $namespace, $ttl);
     }
 
     /**
-    * Stores multiple items in the cache.
-    *  
-    * @param array   $items
-    * @param string  $namespace
-    * @param integer $batchSize
-    * @return void
-    */
+     * Stores multiple items in the cache.
+     *  
+     * @param array   $items
+     * @param string  $namespace
+     * @param integer $batchSize
+     * @return void
+     */
     public function putMany(array $items, string $namespace = '', int $batchSize = 100): void
     {
         $this->mutator->putMany($items, $namespace, $batchSize);
     }
 
     /**
-    * Renews the cache for a specific key with a new TTL.
-    * 
-    * @param string $cacheKey
-    * @param string|int $ttl
-    * @param string $namespace
-    * @return void
-    */
+     * Renews the cache for a specific key with a new TTL.
+     * 
+     * @param string $cacheKey
+     * @param string|int $ttl
+     * @param string $namespace
+     * @return void
+     */
     public function renewCache(string $cacheKey, string|int $ttl = 3600, string $namespace = ''): void
     {
         $this->mutator->renewCache($cacheKey, $ttl, $namespace);
     }
 
     /**
-    * Retrieves a cache item or executes a callback to store it if not found.
-    * 
-    * @param string $cacheKey
-    * @param int|string $ttl
-    * @param Closure $callback
-    * @return mixed
-    */
+     * Retrieves a cache item or executes a callback to store it if not found.
+     * 
+     * @param string $cacheKey
+     * @param int|string $ttl
+     * @param Closure $callback
+     * @return mixed
+     */
     public function remember(string $cacheKey, int|string $ttl, Closure $callback): mixed
     {
         return $this->retriever->remember($cacheKey, $ttl, $callback);
     }
 
     /**
-    * Retrieves a cache item or executes a callback to store it permanently if not found.
-    * 
-    * @param string $cacheKey
-    * @param Closure $callback
-    * @return mixed
-    */
+     * Retrieves a cache item or executes a callback to store it permanently if not found.
+     * 
+     * @param string $cacheKey
+     * @param Closure $callback
+     * @return mixed
+     */
     public function rememberForever(string $cacheKey, Closure $callback): mixed
     {
         return $this->retriever->rememberForever($cacheKey, $callback);
     }
 
     /**
-    * Returns a CacheConfig instance for configuration management.
-    * 
-    * @return CacheConfig
-    */
+     * Returns a CacheConfig instance for configuration management.
+     * 
+     * @return CacheConfig
+     */
     public function setConfig(): CacheConfig
     {
         return new CacheConfig($this);
     }
 
     /**
-    * Sets the cache driver based on the configuration.
-    * 
-    * @return CacheDriver
-    */
+     * Sets the cache driver based on the configuration.
+     * 
+     * @return CacheDriver
+     */
     public function setDriver(): CacheDriver
     {
         return new CacheDriver($this);
     }
 
     /**
-    * Sets a message for the cache operation.
-    *
-    * @param string  $message
-    * @param boolean $success
-    * @return void
-    */
+     * Sets a message for the cache operation.
+     *
+     * @param string  $message
+     * @param boolean $success
+     * @return void
+     */
     private function setMessage(string $message, bool $success): void
     {
         $this->message = $message;
@@ -341,10 +341,10 @@ 
     }
 
     /**
-    * Retrieves the message from the last operation.
-    * 
-    * @return string
-    */
+     * Retrieves the message from the last operation.
+     * 
+     * @return string
+     */
     public function getMessage(): string
     {
         return $this->message;
@@ -393,32 +393,32 @@ 
     }
 
     /**
-    * Enables or disables the formatter for cache data.
-    * 
-    * @return void
-    */
+     * Enables or disables the formatter for cache data.
+     * 
+     * @return void
+     */
     public function useFormatter(): void
     {
         $this->formatted = !$this->formatted;
     }
 
     /**
-    * Validates the options provided for the Cacheer instance.
-    * 
-    * @param array $options
-    * @return void
-    */
+     * Validates the options provided for the Cacheer instance.
+     * 
+     * @param array $options
+     * @return void
+     */
     private function validateOptions(array $options): void
     {
         $this->options = $options;
     }
 
     /**
-    * Enable or disable data compression
-    *
-    * @param bool $status
-    * @return $this
-    */
+     * Enable or disable data compression
+     *
+     * @param bool $status
+     * @return $this
+     */
     public function useCompression(bool $status = true): Cacheer
     {
         $this->compression = $status;
@@ -426,11 +426,11 @@ 
     }
 
     /**
-    * Enable encryption for cached data
-    *
-    * @param string $key
-    * @return $this
-    */
+     * Enable encryption for cached data
+     *
+     * @param string $key
+     * @return $this
+     */
     public function useEncryption(string $key): Cacheer
     {
         $this->encryptionKey = $key;