silviooosilva / CacheerPHP

src/Helpers/SqliteHelper.php

Indentation +9 added lines, -9 removed lines

@@ -36,9 +36,9 @@ 
     }
 
     /**
-    * @param string $databaseDir
-    * @return void
-    */
+     * @param string $databaseDir
+     * @return void
+     */
     private static function createDatabaseDir(string $databaseDir)
     {
         if (!is_dir($databaseDir)) {
@@ -47,9 +47,9 @@ 
     }
 
     /**
-    * @param string $dbFile
-    * @return void
-    */
+     * @param string $dbFile
+     * @return void
+     */
     private static function createDatabaseFile(string $dbFile)
     {
         if (!file_exists($dbFile)) {
@@ -58,9 +58,9 @@ 
     }
 
     /**
-    * @param string $database
-    * @return string
-    */
+     * @param string $database
+     * @return string
+     */
     private static function checkExtension(string $database)
     {
         if (strpos($database, '.sqlite') === false) {

src/Utils/CacheDataFormatter.php

Indentation +8 added lines, -8 removed lines

@@ -18,8 +18,8 @@ 
     }
 
     /**
-    * @return string|false
-    */
+     * @return string|false
+     */
     public function toJson()
     {
         return json_encode(
@@ -31,24 +31,24 @@ 
     }
 
     /**
-    * @return array
-    */
+     * @return array
+     */
     public function toArray()
     {
         return (array)$this->data;
     }
 
     /**
-    * @return string
-    */
+     * @return string
+     */
     public function toString()
     {
         return (string)$this->data;
     }
 
     /**
-    * @return object
-    */
+     * @return object
+     */
     public function toObject()
     {
         return (object)$this->data;

src/Utils/CacheLogger.php

Indentation +17 added lines, -17 removed lines

@@ -23,49 +23,49 @@ 
     }
 
     /**
-    * @return void
-    */
+     * @return void
+     */
     public function info($message)
     {
         $this->log('INFO', $message);
     }
 
     /**
-    * @return void
-    */
+     * @return void
+     */
     public function warning($message)
     {
         $this->log('WARNING', $message);
     }
 
     /**
-    * @return void
-    */
+     * @return void
+     */
     public function error($message)
     {
         $this->log('ERROR', $message);
     }
 
     /**
-    * @return void
-    */
+     * @return void
+     */
     public function debug($message)
     {
         $this->log('DEBUG', $message);
     }
 
     /**
-    * @param mixed $level
-    * @return string|int|false
-    */
+     * @param mixed $level
+     * @return string|int|false
+     */
     private function shouldLog(mixed $level)
     {
         return array_search($level, $this->logLevels) >= array_search($this->logLevel, $this->logLevels);
     }
 
     /**
-    * @return void
-    */
+     * @return void
+     */
     private function rotateLog()
     {
         if (file_exists($this->logFile) && filesize($this->logFile) >= $this->maxFileSize) {
@@ -75,10 +75,10 @@ 
     }
 
     /**
-    * @param mixed $level
-    * @param string $message
-    * @return void
-    */
+     * @param mixed $level
+     * @param string $message
+     * @return void
+     */
     private function log($level, $message)
     {
         if (!$this->shouldLog($level)) {

src/CacheStore/FileCacheStore.php

Indentation +4 added lines, -4 removed lines

@@ -46,13 +46,13 @@
     private string $lastFlushTimeFile;
 
     /**
-    * @var CacheLogger
-    */
+     * @var CacheLogger
+     */
     private $logger = null;
 
     /**
-    * @var FileCacheManager
-    */
+     * @var FileCacheManager
+     */
     private FileCacheManager $fileManager;
 
     public function __construct(array $options = [])

src/Repositories/CacheDatabaseRepository.php

Indentation +12 added lines, -12 removed lines

@@ -48,10 +48,10 @@ 
     }
 
     /**
-    * @param string $cacheKey
-    * @param string $namespace
-    * @return mixed
-    */
+     * @param string $cacheKey
+     * @param string $namespace
+     * @return mixed
+     */
     public function retrieve(string $cacheKey, string $namespace = '')
     {
         $driver = $this->connection->getAttribute(PDO::ATTR_DRIVER_NAME);
@@ -105,11 +105,11 @@ 
     }
 
     /**
-    * @param string $cacheKey
-    * @param string|int $ttl
-    * @param string $namespace
-    * @return bool
-    */
+     * @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');
@@ -163,9 +163,9 @@ 
     }
 
     /**
-    * @param string $driver
-    * @return string
-    */
+     * @param string $driver
+     * @return string
+     */
     private function getCurrentDateTime(string $driver)
     {
         return ($driver === 'sqlite') ? "DATETIME('now', 'localtime')" : "NOW()";

Examples/example08.php

Indentation +3 added lines, -3 removed lines

@@ -23,15 +23,15 @@
     echo "Cache Found: ";
     print_r($Cacheer->getCache($cacheKey));
 } else {
-  echo $Cacheer->getMessage();
+    echo $Cacheer->getMessage();
 }
 
 // Renovando os dados do cache
 $Cacheer->renewCache($cacheKey, 3600);
 
 if($Cacheer->isSuccess()){
-  echo $Cacheer->getMessage() . PHP_EOL;
+    echo $Cacheer->getMessage() . PHP_EOL;
 } else {
-  echo $Cacheer->getMessage() . PHP_EOL;
+    echo $Cacheer->getMessage() . PHP_EOL;
 
 }
\ No newline at end of file

Examples/example07.php

Indentation +2 added lines, -2 removed lines

@@ -29,7 +29,7 @@ 
     echo "Cache Found: ";
     print_r($Cacheer->getCache($cacheKey));
 } else {
-  echo $Cacheer->getMessage();
+    echo $Cacheer->getMessage();
 }
 
 
@@ -40,6 +40,6 @@ 
     echo $Cacheer->getMessage() . PHP_EOL;
     print_r($Cacheer->getCache($cacheKey));
 } else {
-  echo $Cacheer->getMessage();
+    echo $Cacheer->getMessage();
 }
 

src/CacheStore/RedisCacheStore.php

Indentation +187 added lines, -187 removed lines

@@ -16,93 +16,93 @@ 
  */
 class RedisCacheStore implements CacheerInterface
 {
-  /** @var */
-  private $redis;
+    /** @var */
+    private $redis;
 
-  /** @param string $namespace */
-  private string $namespace = '';
+    /** @param string $namespace */
+    private string $namespace = '';
 
-  /**
-  * @var CacheLogger
-  */
-  private $logger = null;
+    /**
+     * @var CacheLogger
+     */
+    private $logger = null;
 
-  /**
-  * @var string
-  */
-  private string $message = '';
+    /**
+     * @var string
+     */
+    private string $message = '';
 
-  /**
-  * @var boolean
-  */
-  private bool $success = false;
+    /**
+     * @var boolean
+     */
+    private bool $success = false;
 
 
-  /**
-  * @return void
-  */
-  public function __construct(string $logPath)
-  {
+    /**
+     * @return void
+     */
+    public function __construct(string $logPath)
+    {
     $this->redis = RedisCacheManager::connect();
     $this->logger = new CacheLogger($logPath);
-  }
-
-  /**
-  * @param string $cacheKey
-  * @param string $namespace
-  * @param string|int $ttl
-  * @return mixed
-  */
-  public function getCache(string $cacheKey, string $namespace = '', string|int $ttl = 3600)
-  {
+    }
+
+    /**
+     * @param string $cacheKey
+     * @param string $namespace
+     * @param string|int $ttl
+     * @return mixed
+     */
+    public function getCache(string $cacheKey, string $namespace = '', string|int $ttl = 3600)
+    {
     $fullCacheKey = $this->buildKey($cacheKey, $namespace);
     $cacheData = $this->redis->get($fullCacheKey);
 
     if($cacheData) {
-      $this->setMessage("Cache retrieved successfully", true);
-      $this->logger->debug("{$this->getMessage()} from redis driver.");
-      return CacheRedisHelper::serialize($cacheData, false);
+        $this->setMessage("Cache retrieved successfully", true);
+        $this->logger->debug("{$this->getMessage()} from redis driver.");
+        return CacheRedisHelper::serialize($cacheData, false);
     }
 
     $this->setMessage("CacheData not found, does not exists or expired", false);
     $this->logger->info("{$this->getMessage()} from redis driver.");
-  }
-
-  /**
-  * Armazena um item no cache Redis, com suporte a namespace e TTL opcional.
-  *
-  * @param string $cacheKey
-  * @param mixed  $cacheData
-  * @param string $namespace
-  * @param string|int|null $ttl
-  * @return mixed
-  */
-  public function putCache(string $cacheKey, mixed $cacheData, string $namespace = '', string|int|null $ttl = null)
-  {
-      $cacheFullKey = $this->buildKey($cacheKey, $namespace);
-      $serializedData = CacheRedisHelper::serialize($cacheData);
-
-      $result = $ttl ? $this->redis->setex($cacheFullKey, (int) $ttl, $serializedData) 
+    }
+
+    /**
+     * Armazena um item no cache Redis, com suporte a namespace e TTL opcional.
+     *
+     * @param string $cacheKey
+     * @param mixed  $cacheData
+     * @param string $namespace
+     * @param string|int|null $ttl
+     * @return mixed
+     */
+    public function putCache(string $cacheKey, mixed $cacheData, string $namespace = '', string|int|null $ttl = null)
+    {
+        $cacheFullKey = $this->buildKey($cacheKey, $namespace);
+        $serializedData = CacheRedisHelper::serialize($cacheData);
+
+        $result = $ttl ? $this->redis->setex($cacheFullKey, (int) $ttl, $serializedData) 
                     : $this->redis->set($cacheFullKey, $serializedData);
 
-      if ($result) {
-          $this->setMessage("Cache stored successfully", true);
-      } else {
-          $this->setMessage("Failed to store cache", false);
-      }
+        if ($result) {
+            $this->setMessage("Cache stored successfully", true);
+        } else {
+            $this->setMessage("Failed to store cache", false);
+        }
 
-      $this->logger->debug("{$this->getMessage()} from Redis driver.");
-      return $result;
-  }
+        $this->logger->debug("{$this->getMessage()} from Redis driver.");
+        return $result;
+    }
 
 
-  /**
-  * @param string $cacheKey
-  * @param string $namespace
-  * @return void
-  */
-  public function clearCache(string $cacheKey, string $namespace = '')
-  {
+    /**
+     * @param string $cacheKey
+     * @param string $namespace
+     * @return void
+     */
+    public function clearCache(string $cacheKey, string $namespace = '')
+    {
     $cacheFullKey = $this->buildKey($cacheKey, $namespace);
 
 
@@ -114,107 +114,107 @@ 
 
 
     $this->logger->debug("{$this->getMessage()} from redis driver.");
-  }
-
-  /**
-  * @param string $cacheKey
-  * @param string $namespace
-  * @return void
-  */
-  public function has(string $cacheKey, string $namespace = '')
-  {
+    }
+
+    /**
+     * @param string $cacheKey
+     * @param string $namespace
+     * @return void
+     */
+    public function has(string $cacheKey, string $namespace = '')
+    {
     $cacheFullKey = $this->buildKey($cacheKey, $namespace);
 
     if($this->redis->exists($cacheFullKey) > 0) {
         $this->setMessage("Cache Key: {$cacheKey} exists!", true);
     } else {
         $this->setMessage("Cache Key: {$cacheKey} does not exists!", false);
-      }
+        }
 
     $this->logger->debug("{$this->getMessage()} from redis driver.");
-  }
-
-  /**
-  * @param string $cacheKey
-  * @param string|int $ttl
-  * @param string $namespace
-  * @return void
-  */
-  public function renewCache(string $cacheKey, string|int $ttl, string $namespace = '')
-  {
-      $cacheFullKey = $this->buildKey($cacheKey, $namespace);
-      $dump = $this->getDump($cacheFullKey);
-
-      if (!$dump) {
-          $this->setMessage("Cache Key: {$cacheKey} not found.", false);
-          $this->logger->warning("{$this->getMessage()} from Redis driver.");
-          return;
-      }
-
-      $this->clearCache($cacheFullKey);
-
-      if ($this->restoreKey($cacheFullKey, $ttl, $dump)) {
-          $this->setMessage("Cache Key: {$cacheKey} renewed successfully.", true);
-          $this->logger->debug("{$this->getMessage()} from Redis driver.");
-      } else {
-          $this->setMessage("Failed to renew cache key: {$cacheKey}.", false);
-          $this->logger->error("{$this->getMessage()} from Redis driver.");
-      }
-  }
-
-
-  /**
-  * @param string $cacheKey
-  * @param mixed  $cacheData
-  * @param string $namespace
-  * @return void
-  */
-  public function appendCache(string $cacheKey, mixed $cacheData, string $namespace = '')
-  {
-      $cacheFullKey = $this->buildKey($cacheKey, $namespace);
-      $existingData = $this->getCache($cacheFullKey);
-
-      $mergedCacheData = CacheRedisHelper::arrayIdentifier($existingData, $cacheData);
-
-      $serializedData = CacheRedisHelper::serialize($mergedCacheData);
-
-      if ($this->redis->set($cacheFullKey, $serializedData)) {
-          $this->setMessage("Cache appended successfully", true);
-      } else {
-          $this->setMessage("Something went wrong. Please, try again.", false);
-      }
+    }
+
+    /**
+     * @param string $cacheKey
+     * @param string|int $ttl
+     * @param string $namespace
+     * @return void
+     */
+    public function renewCache(string $cacheKey, string|int $ttl, string $namespace = '')
+    {
+        $cacheFullKey = $this->buildKey($cacheKey, $namespace);
+        $dump = $this->getDump($cacheFullKey);
+
+        if (!$dump) {
+            $this->setMessage("Cache Key: {$cacheKey} not found.", false);
+            $this->logger->warning("{$this->getMessage()} from Redis driver.");
+            return;
+        }
+
+        $this->clearCache($cacheFullKey);
+
+        if ($this->restoreKey($cacheFullKey, $ttl, $dump)) {
+            $this->setMessage("Cache Key: {$cacheKey} renewed successfully.", true);
+            $this->logger->debug("{$this->getMessage()} from Redis driver.");
+        } else {
+            $this->setMessage("Failed to renew cache key: {$cacheKey}.", false);
+            $this->logger->error("{$this->getMessage()} from Redis driver.");
+        }
+    }
+
+
+    /**
+     * @param string $cacheKey
+     * @param mixed  $cacheData
+     * @param string $namespace
+     * @return void
+     */
+    public function appendCache(string $cacheKey, mixed $cacheData, string $namespace = '')
+    {
+        $cacheFullKey = $this->buildKey($cacheKey, $namespace);
+        $existingData = $this->getCache($cacheFullKey);
+
+        $mergedCacheData = CacheRedisHelper::arrayIdentifier($existingData, $cacheData);
+
+        $serializedData = CacheRedisHelper::serialize($mergedCacheData);
+
+        if ($this->redis->set($cacheFullKey, $serializedData)) {
+            $this->setMessage("Cache appended successfully", true);
+        } else {
+            $this->setMessage("Something went wrong. Please, try again.", false);
+        }
 
   
-      $this->logger->debug("{$this->getMessage()} from redis driver.");
-  }
+        $this->logger->debug("{$this->getMessage()} from redis driver.");
+    }
 
 
-  /**
-  * @param array  $items
-  * @param string $namespace
-  * @param int    $batchSize
-  * @return void
-  */
-  public function putMany(array $items, string $namespace = '', int $batchSize = 100)
-  {
-      $processedCount = 0;
-      $itemCount = count($items);
+    /**
+     * @param array  $items
+     * @param string $namespace
+     * @param int    $batchSize
+     * @return void
+     */
+    public function putMany(array $items, string $namespace = '', int $batchSize = 100)
+    {
+        $processedCount = 0;
+        $itemCount = count($items);
 
-      while($processedCount < $itemCount)
-      {
+        while($processedCount < $itemCount)
+        {
 
         $batchItems = array_slice($items, $processedCount, $batchSize);
         $this->processBatchItems($batchItems, $namespace);
         $processedCount += count($batchItems);
-      }
+        }
 
-  }
+    }
 
-  /**
-  * @return void
-  */
-  public function flushCache()
-  {
+    /**
+     * @return void
+     */
+    public function flushCache()
+    {
   
     if($this->redis->flushall()) {
         $this->setMessage("Cache flushed successfully", true);
@@ -223,7 +223,7 @@ 
     }
 
     $this->logger->debug("{$this->getMessage()} from redis driver.");
-  }
+    }
 
     /**
      * @return string
@@ -241,17 +241,17 @@ 
         return $this->success;
     }
 
-  /**
-  * @param string $key
-  * @param string $namespace
-  * @return string
-  */
-  private function buildKey(string $key, string $namespace)
-  {
+    /**
+     * @param string $key
+     * @param string $namespace
+     * @return string
+     */
+    private function buildKey(string $key, string $namespace)
+    {
     return $this->namespace . ($namespace ? $namespace . ':' : '') . $key;
-  }
+    }
 
-  /**
+    /**
      * @param string  $message
      * @param boolean $success
      * @return void
@@ -263,10 +263,10 @@ 
     }
 
         /**
-     * @param array  $batchItems
-     * @param string $namespace
-     * @return void
-     */
+         * @param array  $batchItems
+         * @param string $namespace
+         * @return void
+         */
     private function processBatchItems(array $batchItems, string $namespace)
     {
         foreach($batchItems as $item) {
@@ -278,29 +278,29 @@ 
         }
     }
 
-      /**
-  * @param string $fullKey
-  * @return string|null
-  */
-  private function getDump(string $fullKey)
-  {
-      return $this->redis->dump($fullKey);
-  }
-
-
-  /**
-  * @param string $fullKey
-  * @param string|int $ttl
-  * @param mixed $dump
-  * @return bool
-  */
-  private function restoreKey(string $fullKey, string|int $ttl, mixed $dump)
-  {
-      try {
-          $this->redis->restore($fullKey, $ttl * 1000, $dump, 'REPLACE');
-          return true;
-      } catch (Exception $e) {
-          throw CacheRedisException::create($e->getMessage());
-      }
-  }
+        /**
+         * @param string $fullKey
+         * @return string|null
+         */
+    private function getDump(string $fullKey)
+    {
+        return $this->redis->dump($fullKey);
+    }
+
+
+    /**
+     * @param string $fullKey
+     * @param string|int $ttl
+     * @param mixed $dump
+     * @return bool
+     */
+    private function restoreKey(string $fullKey, string|int $ttl, mixed $dump)
+    {
+        try {
+            $this->redis->restore($fullKey, $ttl * 1000, $dump, 'REPLACE');
+            return true;
+        } catch (Exception $e) {
+            throw CacheRedisException::create($e->getMessage());
+        }
+    }
 }

src/Helpers/EnvHelper.php

Indentation +2 added lines, -2 removed lines

@@ -34,8 +34,8 @@
     }
 
     /**
-    * @return void
-    */
+     * @return void
+     */
     public static function copyEnv()
     {
         $rootDir = self::getRootPath();