silviooosilva / CacheerPHP

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(): bool|string
     {
         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(): array
     {
         return (array)$this->data;
     }
 
     /**
-    * Converts the data to a string.
-    * 
-    * @return string
-    */
+     * Converts the data to a string.
+     * 
+     * @return string
+     */
     public function toString(): string
     {
         return (string)$this->data;
     }
 
     /**
-    * Converts the data to an object.
-    * 
-    * @return object
-    */
+     * Converts the data to an object.
+     * 
+     * @return object
+     */
     public function toObject(): object
     {
         return (object)$this->data;

Spacing +1 added lines, -1 removed lines

@@ -27,7 +27,7 @@
     *
     * @return string|false
     */
-    public function toJson(): bool|string
+    public function toJson(): bool | string
     {
         return json_encode(
             $this->data,

src/Utils/CacheLogger.php

Indentation +26 added lines, -26 removed lines

@@ -23,40 +23,40 @@ 
     }
 
     /**
-    * Logs a info message.
-    * 
-    * @return void
-    */
+     * Logs a info message.
+     * 
+     * @return void
+     */
     public function info($message): void
     {
         $this->log('INFO', $message);
     }
 
     /**
-    * Logs a warning message.
-    *
-    * @return void
-    */
+     * Logs a warning message.
+     *
+     * @return void
+     */
     public function warning($message): void
     {
         $this->log('WARNING', $message);
     }
 
     /**
-    * Logs an error message.
-    * 
-    * @return void
-    */
+     * Logs an error message.
+     * 
+     * @return void
+     */
     public function error($message): void
     {
         $this->log('ERROR', $message);
     }
 
     /**
-    * Logs a debug message.
-    * 
-    * @return void
-    */
+     * Logs a debug message.
+     * 
+     * @return void
+     */
     public function debug($message): void
     {
         $this->log('DEBUG', $message);
@@ -74,10 +74,10 @@ 
     }
 
     /**
-    * Rotates the log file if it exceeds the maximum size.
-    * 
-    * @return void
-    */
+     * Rotates the log file if it exceeds the maximum size.
+     * 
+     * @return void
+     */
     private function rotateLog(): void
     {
         if (file_exists($this->logFile) && filesize($this->logFile) >= $this->maxFileSize) {
@@ -87,12 +87,12 @@ 
     }
 
     /**
-    * Logs a message to the log file.
-    * 
-    * @param mixed $level
-    * @param string $message
-    * @return void
-    */
+     * Logs a message to the log file.
+     * 
+     * @param mixed $level
+     * @param string $message
+     * @return void
+     */
     private function log(mixed $level, string $message): void
     {
         if (!$this->shouldLog($level)) {

src/Core/Connect.php

Indentation +22 added lines, -22 removed lines

@@ -14,18 +14,18 @@ 
 class Connect
 {
     /**
-    * The default connection type.
-    * Currently, it supports 'mysql', 'sqlite', and 'pgsql'.
-    *
-    * @var string
-    */
+     * The default connection type.
+     * Currently, it supports 'mysql', 'sqlite', and 'pgsql'.
+     *
+     * @var string
+     */
     public static string $connection = 'sqlite';
 
     /**
-    * Holds the last error encountered during connection attempts.
-    *
-    * @var PDOException|null
-    */
+     * Holds the last error encountered during connection attempts.
+     *
+     * @var PDOException|null
+     */
     private static ?PDOException $error = null;
 
 
@@ -62,20 +62,20 @@ 
     }
 
     /**
-    * Gets the current connection type.
-    *
-    * @return string
-    */
+     * Gets the current connection type.
+     *
+     * @return string
+     */
     public static function getConnection(): string
     {
         return self::$connection;
     }
 
     /**
-    * Returns the last error encountered during connection attempts.\
-    * 
-    * @return PDOException|null
-    */
+     * Returns the last error encountered during connection attempts.\
+     * 
+     * @return PDOException|null
+     */
     public static function getError(): ?PDOException
     {
         return self::$error;
@@ -86,13 +86,13 @@ 
      * This class is designed to be used statically, so it cannot be instantiated.
      * 
      * @return void
-    */    
+     */    
     private function __construct() {}
 
     /**
-    * Prevents cloning of the Connect instance.
-    *
-    * @return void
-    */
+     * Prevents cloning of the Connect instance.
+     *
+     * @return void
+     */
     private function __clone() {}
 }

src/Helpers/CacheFileHelper.php

Indentation +10 added lines, -10 removed lines

@@ -82,15 +82,15 @@
         return $ttl;
     }
 
-  /**
-  * Generates an array identifier for cache data.
-  * 
-  * @param mixed $currentCacheData
-  * @param mixed $cacheData
-  * @return array
-  */
-  public static function arrayIdentifier(mixed $currentCacheData, mixed $cacheData): array
-  {
+    /**
+     * Generates an array identifier for cache data.
+     * 
+     * @param mixed $currentCacheData
+     * @param mixed $cacheData
+     * @return array
+     */
+    public static function arrayIdentifier(mixed $currentCacheData, mixed $cacheData): array
+    {
     return CacheerHelper::arrayIdentifier($currentCacheData, $cacheData);
-  }
+    }
 }

Spacing +1 added lines, -1 removed lines

@@ -20,7 +20,7 @@
      * @return float|int
      * @throws CacheFileException
      */
-    public static function convertExpirationToSeconds(string $expiration): float|int
+    public static function convertExpirationToSeconds(string $expiration): float | int
     {
         $units = [
             'second' => 1,

src/Helpers/SqliteHelper.php

Indentation +28 added lines, -28 removed lines

@@ -12,24 +12,24 @@ 
 {
 
     /**
-    * Gets the path to the SQLite database file.
-    *  
-    * @param string $database
-    * @param ?string $path
-    * @return string
-    */
+     * Gets the path to the SQLite database file.
+     *  
+     * @param string $database
+     * @param ?string $path
+     * @return string
+     */
     public static function database(string $database = 'database.sqlite', ?string $path = null): string
     {
         return self::getDynamicSqliteDbPath($database, $path);
     }
 
     /**
-    * Gets the path to the SQLite database file dynamically.
-    *
-    * @param  string $database
-    * @param ?string $path
-    * @return string
-    */
+     * Gets the path to the SQLite database file dynamically.
+     *
+     * @param  string $database
+     * @param ?string $path
+     * @return string
+     */
     private static function getDynamicSqliteDbPath(string $database, ?string $path = null): string
     {
         $rootPath = EnvHelper::getRootPath();
@@ -47,11 +47,11 @@ 
     }
 
     /**
-    * Creates the database directory if it does not exist.
-    * 
-    * @param string $databaseDir
-    * @return void
-    */
+     * Creates the database directory if it does not exist.
+     * 
+     * @param string $databaseDir
+     * @return void
+     */
     private static function createDatabaseDir(string $databaseDir): void
     {
         if (!is_dir($databaseDir)) {
@@ -60,11 +60,11 @@ 
     }
 
     /**
-    * Creates the SQLite database file if it does not exist.
-    *
-    * @param string $dbFile
-    * @return void
-    */
+     * Creates the SQLite database file if it does not exist.
+     *
+     * @param string $dbFile
+     * @return void
+     */
     private static function createDatabaseFile(string $dbFile): void
     {
         if (!file_exists($dbFile)) {
@@ -73,12 +73,12 @@ 
     }
 
     /**
-    * Checks if the database name has the correct extension.
-    * If not, appends '.sqlite' to the name.
-    *
-    * @param string $database
-    * @return string
-    */
+     * Checks if the database name has the correct extension.
+     * If not, appends '.sqlite' to the name.
+     *
+     * @param string $database
+     * @return string
+     */
     private static function checkExtension(string $database): string
     {
         if (!str_contains($database, '.sqlite')) {

src/Helpers/CacheRedisHelper.php

Indentation +27 added lines, -27 removed lines

@@ -13,29 +13,29 @@ 
 class CacheRedisHelper
 {
 
-  /**
-  * serializes or unserializes data based on the $serialize flag.
-  * 
-  * @param mixed $data
-  * @param bool  $serialize
-  * @return mixed
-  */
-  public static function serialize(mixed $data, bool $serialize = true): mixed
-  {
+    /**
+     * serializes or unserializes data based on the $serialize flag.
+     * 
+     * @param mixed $data
+     * @param bool  $serialize
+     * @return mixed
+     */
+    public static function serialize(mixed $data, bool $serialize = true): mixed
+    {
     if($serialize) {
-      return serialize($data);
+        return serialize($data);
     }
 
     return unserialize($data);
 
-  }
+    }
 
     /**
-    * Validates a cache item.
-    *  
-    * @param array $item
-    * @return void
-    */
+     * Validates a cache item.
+     *  
+     * @param array $item
+     * @return void
+     */
     public static function validateCacheItem(array $item): void
     {
         CacheerHelper::validateCacheItem(
@@ -55,17 +55,17 @@ 
         return CacheerHelper::mergeCacheData($cacheData);
     }
 
-  /**
-  * Generates an array identifier for cache data.
-  * 
-  * @param mixed $currentCacheData
-  * @param mixed $cacheData
-  * @return array
-  */
-  public static function arrayIdentifier(mixed $currentCacheData, mixed $cacheData): array
-  {
-      return CacheerHelper::arrayIdentifier($currentCacheData, $cacheData);
-  }
+    /**
+     * Generates an array identifier for cache data.
+     * 
+     * @param mixed $currentCacheData
+     * @param mixed $cacheData
+     * @return array
+     */
+    public static function arrayIdentifier(mixed $currentCacheData, mixed $cacheData): array
+    {
+        return CacheerHelper::arrayIdentifier($currentCacheData, $cacheData);
+    }
 
 }
 

Spacing +1 added lines, -1 removed lines

@@ -22,7 +22,7 @@
   */
   public static function serialize(mixed $data, bool $serialize = true): mixed
   {
-    if($serialize) {
+    if ($serialize) {
       return serialize($data);
     }
 

src/Service/CacheMutator.php

Indentation +52 added lines, -52 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): bool
     {
         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 bool
-    */
+     * Appends data to an existing cache item.
+     *
+     * @param string $cacheKey
+     * @param mixed $cacheData
+     * @param string $namespace
+     * @return bool
+     */
     public function appendCache(string $cacheKey, mixed $cacheData, string $namespace = ''): bool
     {
         $this->cacheer->cacheStore->appendCache($cacheKey, $cacheData, $namespace);
@@ -65,12 +65,12 @@ 
     }
 
     /**
-    * Clears a specific cache item.
-    *
-    * @param string $cacheKey
-    * @param string $namespace
-    * @return bool
-    */
+     * Clears a specific cache item.
+     *
+     * @param string $cacheKey
+     * @param string $namespace
+     * @return bool
+     */
     public function clearCache(string $cacheKey, string $namespace = ''): bool
     {
         $this->cacheer->cacheStore->clearCache($cacheKey, $namespace);
@@ -80,13 +80,13 @@ 
     }
 
     /**
-    * 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 = ''): bool
     {
         return $this->increment($cacheKey, ($amount * -1), $namespace);
@@ -108,10 +108,10 @@ 
     }
 
     /**
-    * Flushes the entire cache.
-    *
-    * @return bool
-    */
+     * Flushes the entire cache.
+     *
+     * @return bool
+     */
     public function flushCache(): bool
     {
         $this->cacheer->cacheStore->flushCache();
@@ -160,13 +160,13 @@ 
     }
 
     /**
-    * Puts multiple cache items in a batch.
-    *
-    * @param array $items
-    * @param string $namespace
-    * @param int $batchSize
-    * @return bool
-    */
+     * Puts multiple cache items in a batch.
+     *
+     * @param array $items
+     * @param string $namespace
+     * @param int $batchSize
+     * @return bool
+     */
     public function putMany(array $items, string $namespace = '', int $batchSize = 100): bool
     {
         $this->cacheer->cacheStore->putMany($items, $namespace, $batchSize);
@@ -176,13 +176,13 @@ 
     }
 
     /**
-    * Renews the cache item with a new TTL.
-    *
-    * @param string $cacheKey
-    * @param int|string $ttl
-    * @param string $namespace
-    * @return bool
-    */
+     * Renews the cache item with a new TTL.
+     *
+     * @param string $cacheKey
+     * @param int|string $ttl
+     * @param string $namespace
+     * @return bool
+     */
     public function renewCache(string $cacheKey, int|string $ttl = 3600, string $namespace = ''): bool
     {
         $this->cacheer->cacheStore->renewCache($cacheKey, $ttl, $namespace);

Spacing +3 added lines, -3 removed lines

@@ -36,7 +36,7 @@ 
     * @param int|string $ttl
     * @return bool
     */
-    public function add(string $cacheKey, mixed $cacheData, string $namespace = '', int|string $ttl = 3600): bool
+    public function add(string $cacheKey, mixed $cacheData, string $namespace = '', int | string $ttl = 3600): bool
     {
         if (!empty($this->cacheer->getCache($cacheKey, $namespace))) {
             return true;
@@ -150,7 +150,7 @@ 
      * @param int|string $ttl
      * @return bool
      */
-    public function putCache(string $cacheKey, mixed $cacheData, string $namespace = '', int|string $ttl = 3600): bool
+    public function putCache(string $cacheKey, mixed $cacheData, string $namespace = '', int | string $ttl = 3600): bool
     {
         $data = CacheerHelper::prepareForStorage($cacheData, $this->cacheer->isCompressionEnabled(), $this->cacheer->getEncryptionKey());
         $this->cacheer->cacheStore->putCache($cacheKey, $data, $namespace, $ttl);
@@ -183,7 +183,7 @@ 
     * @param string $namespace
     * @return bool
     */
-    public function renewCache(string $cacheKey, int|string $ttl = 3600, string $namespace = ''): bool
+    public function renewCache(string $cacheKey, int | string $ttl = 3600, string $namespace = ''): bool
     {
         $this->cacheer->cacheStore->renewCache($cacheKey, $ttl, $namespace);
         $this->cacheer->syncState();

tests/Unit/StaticAccessTest.php

Indentation +2 added lines, -2 removed lines

@@ -35,8 +35,8 @@
             'driver' => 'file',
             'path' => '/tmp/cache',
         ];
-       Cacheer::setUp($options);
-       self::assertSame($options, Cacheer::getOptions());
+        Cacheer::setUp($options);
+        self::assertSame($options, Cacheer::getOptions());
     }
 
     public function testSetUpStaticWithOptionBuilder(): void

src/Cacheer.php

Indentation +60 added lines, -60 removed lines

@@ -63,66 +63,66 @@ 
 final class Cacheer
 {
     /**
-    * @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 RedisCacheStore|DatabaseCacheStore|ArrayCacheStore|FileCacheStore $cacheStore;
 
     /**
-    * @var array
-    */
+     * @var array
+     */
     public array $options = [];
 
     /**
-    * @var CacheRetriever
-    */
+     * @var CacheRetriever
+     */
     private CacheRetriever $retriever;
 
     /**
-    * @var CacheMutator
-    */
+     * @var CacheMutator
+     */
     private CacheMutator $mutator;
 
     /**
-    * @var CacheConfig
-    */
+     * @var CacheConfig
+     */
     private CacheConfig $config;
 
     /**
-    * @var Cacheer|null
-    */
+     * @var Cacheer|null
+     */
     private static ?Cacheer $staticInstance = null;
 
 /**
-    * Cacheer constructor.
-    *
-    * @param array $options
-    * @param bool  $formatted
-    * @throws RuntimeException|Exceptions\CacheFileException
+ * Cacheer constructor.
+ *
+ * @param array $options
+ * @param bool  $formatted
+ * @throws RuntimeException|Exceptions\CacheFileException
  */
     public function __construct(array $options = [], bool $formatted = false)
     {
@@ -182,11 +182,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;
@@ -194,11 +194,11 @@ 
     }
 
     /**
-    * 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;
@@ -206,43 +206,43 @@ 
     }
 
     /**
-    * 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;
     }
 
     /**
-    * 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;
     }
 
     /**
-    * 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;
@@ -250,10 +250,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;

Spacing +1 added lines, -1 removed lines

@@ -90,7 +90,7 @@
     /**
     * @var FileCacheStore|DatabaseCacheStore|RedisCacheStore|ArrayCacheStore
     */
-    public RedisCacheStore|DatabaseCacheStore|ArrayCacheStore|FileCacheStore $cacheStore;
+    public RedisCacheStore | DatabaseCacheStore | ArrayCacheStore | FileCacheStore $cacheStore;
 
     /**
     * @var array