silviooosilva / CacheerPHP

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;

Spacing +6 added lines, -6 removed lines

@@ -93,7 +93,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);
     }
@@ -189,7 +189,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);
     }
@@ -202,7 +202,7 @@ 
     * @param string|int $ttl
     * @return CacheDataFormatter|mixed
     */
-    public function getMany(array $cacheKeys, string $namespace = '', string|int $ttl = 3600): mixed
+    public function getMany(array $cacheKeys, string $namespace = '', string | int $ttl = 3600): mixed
     {
         return $this->retriever->getMany($cacheKeys, $namespace, $ttl);
     }
@@ -251,7 +251,7 @@ 
     * @param string|int $ttl
     * @return void
     */
-    public function putCache(string $cacheKey, mixed $cacheData, string $namespace = '', string|int $ttl = 3600): void
+    public function putCache(string $cacheKey, mixed $cacheData, string $namespace = '', string | int $ttl = 3600): void
     {
         $this->mutator->putCache($cacheKey, $cacheData, $namespace, $ttl);
     }
@@ -277,7 +277,7 @@ 
     * @param string $namespace
     * @return void
     */
-    public function renewCache(string $cacheKey, string|int $ttl = 3600, string $namespace = ''): void
+    public function renewCache(string $cacheKey, string | int $ttl = 3600, string $namespace = ''): void
     {
         $this->mutator->renewCache($cacheKey, $ttl, $namespace);
     }
@@ -290,7 +290,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);
     }