silviooosilva / CacheerPHP

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();

src/Cacheer.php

Indentation +174 added lines, -174 removed lines

@@ -23,56 +23,56 @@ 
 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 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;
 
 /**
-    * 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)
     {
@@ -84,122 +84,122 @@ 
     }
 
     /**
-    * 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 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
     {
         return $this->mutator->appendCache($cacheKey, $cacheData, $namespace);
     }
 
     /**
-    * 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
     {
         return $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 bool
-    */
+     * Store data in the cache permanently.
+     *
+     * @param string $cacheKey
+     * @param mixed $cacheData
+     * @return bool
+     */
     public function forever(string $cacheKey, mixed $cacheData): bool
     {
         return $this->mutator->forever($cacheKey, $cacheData);
     }
 
     /**
-    * Flushes all cache items.
-    *
-    * @return bool
-    */
+     * Flushes all cache items.
+     *
+     * @return bool
+     */
     public function flushCache(): bool
     {
         return $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|array
+     * Retrieves multiple cache items by their keys.
+     * 
+     * @param array $cacheKeys
+     * @param string $namespace
+     * @param string|int $ttl
+     * @return CacheDataFormatter|array
      */
     public function getMany(array $cacheKeys, string $namespace = '', string|int $ttl = 3600): CacheDataFormatter|array
     {
@@ -207,132 +207,132 @@ 
     }
 
     /**
-    * Checks if a cache item exists.
-    *
-    * @param string $cacheKey
-    * @param string $namespace
-    * @return bool
-    */
+     * Checks if a cache item exists.
+     *
+     * @param string $cacheKey
+     * @param string $namespace
+     * @return bool
+     */
     public function has(string $cacheKey, string $namespace = ''): bool
     {
         return $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 bool
-    */
+     * Stores an item in the cache with a specific TTL.
+     * 
+     * @param string $cacheKey
+     * @param mixed  $cacheData
+     * @param string $namespace
+     * @param string|int $ttl
+     * @return bool
+     */
     public function putCache(string $cacheKey, mixed $cacheData, string $namespace = '', string|int $ttl = 3600): bool
     {
         return $this->mutator->putCache($cacheKey, $cacheData, $namespace, $ttl);
     }
 
     /**
-    * Stores multiple items in the cache.
-    *  
-    * @param array   $items
-    * @param string  $namespace
-    * @param integer $batchSize
-    * @return bool
-    */
+     * Stores multiple items in the cache.
+     *  
+     * @param array   $items
+     * @param string  $namespace
+     * @param integer $batchSize
+     * @return bool
+     */
     public function putMany(array $items, string $namespace = '', int $batchSize = 100): bool
     {
         return $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 bool
-    */
+     * Renews the cache for a specific key with a new TTL.
+     * 
+     * @param string $cacheKey
+     * @param string|int $ttl
+     * @param string $namespace
+     * @return bool
+     */
     public function renewCache(string $cacheKey, string|int $ttl = 3600, string $namespace = ''): bool
     {
         return $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;
@@ -340,10 +340,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;
@@ -392,32 +392,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;
@@ -425,11 +425,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;

Spacing +7 added lines, -7 removed lines

@@ -50,7 +50,7 @@ 
     /**
     * @var FileCacheStore|DatabaseCacheStore|RedisCacheStore|ArrayCacheStore
     */
-    public RedisCacheStore|DatabaseCacheStore|ArrayCacheStore|FileCacheStore $cacheStore;
+    public RedisCacheStore | DatabaseCacheStore | ArrayCacheStore | FileCacheStore $cacheStore;
 
     /**
     * @var array
@@ -92,7 +92,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
     {
         return $this->mutator->add($cacheKey, $cacheData, $namespace, $ttl);
     }
@@ -188,7 +188,7 @@ 
     * @param string|int $ttl
     * @return CacheDataFormatter|mixed
     */
-    public function getCache(string $cacheKey, string $namespace = '', string|int $ttl = 3600): mixed
+    public function getCache(string $cacheKey, string $namespace = '', string | int $ttl = 3600): mixed
     {
         return $this->retriever->getCache($cacheKey, $namespace, $ttl);
     }
@@ -201,7 +201,7 @@ 
     * @param string|int $ttl
     * @return CacheDataFormatter|array
      */
-    public function getMany(array $cacheKeys, string $namespace = '', string|int $ttl = 3600): CacheDataFormatter|array
+    public function getMany(array $cacheKeys, string $namespace = '', string | int $ttl = 3600): CacheDataFormatter | array
     {
         return $this->retriever->getMany($cacheKeys, $namespace, $ttl);
     }
@@ -250,7 +250,7 @@ 
     * @param string|int $ttl
     * @return bool
     */
-    public function putCache(string $cacheKey, mixed $cacheData, string $namespace = '', string|int $ttl = 3600): bool
+    public function putCache(string $cacheKey, mixed $cacheData, string $namespace = '', string | int $ttl = 3600): bool
     {
         return $this->mutator->putCache($cacheKey, $cacheData, $namespace, $ttl);
     }
@@ -276,7 +276,7 @@ 
     * @param string $namespace
     * @return bool
     */
-    public function renewCache(string $cacheKey, string|int $ttl = 3600, string $namespace = ''): bool
+    public function renewCache(string $cacheKey, string | int $ttl = 3600, string $namespace = ''): bool
     {
         return $this->mutator->renewCache($cacheKey, $ttl, $namespace);
     }
@@ -289,7 +289,7 @@ 
     * @param Closure $callback
     * @return mixed
     */
-    public function remember(string $cacheKey, int|string $ttl, Closure $callback): mixed
+    public function remember(string $cacheKey, int | string $ttl, Closure $callback): mixed
     {
         return $this->retriever->remember($cacheKey, $ttl, $callback);
     }