Silviooosilva\CacheerPhp\Helpers\CacheFileHelper

Complexity

Total Complexity

9

Size/Duplication

Total Lines	79
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	1

5 Methods

Rating	Name	Duplication	Size	Complexity
A	arrayIdentifier()	0	3	1
A	validateCacheItem()	0	5	1
A	ttl()	0	7	3
A	convertExpirationToSeconds()	0	17	3
A	mergeCacheData()	0	3	1

<?php

namespace Silviooosilva\CacheerPhp\Helpers;

use Silviooosilva\CacheerPhp\Helpers\CacheerHelper;
use Silviooosilva\CacheerPhp\Exceptions\CacheFileException;

/**
 * Class CacheFileHelper
 * @author Sílvio Silva <https://github.com/silviooosilva>
 * @package Silviooosilva\CacheerPhp
 */
class CacheFileHelper
{

    /**
    * Converts a string expiration format to seconds.
    *
    * @param string $expiration
    * @return int
    */
    public static function convertExpirationToSeconds(string $expiration)
    {
        $units = [
            'second' => 1,
            'minute' => 60,
            'hour'   => 3600,
            'day'    => 86400,
            'week'   => 604800,
            'month'  => 2592000,
            'year'   => 31536000,
        ];
        foreach ($units as $unit => $value) {
            if (strpos($expiration, $unit) !== false) {
                return (int)$expiration * $value;
            }
        }
        throw CacheFileException::create("Invalid expiration format");
    }

    /**
    * Merges cache data with existing data.
    * 
    * @param array $options
    * @return array
    */
    public static function mergeCacheData($cacheData)
    {
        return CacheerHelper::mergeCacheData($cacheData);
    }

    /**
     * Validates a cache item.
     * 
     * @param array $item
     * @return void
     */
    public static function validateCacheItem(array $item)
    {
        CacheerHelper::validateCacheItem(
            $item,
            fn($msg) => CacheFileException::create($msg)
        );
    }

    /**
    * Calculates the TTL (Time To Live) for cache items.
    *
    * @param string|int $ttl
    * @param int $defaultTTL
    * @return mixed
    */
    public static function ttl($ttl = null, ?int $defaultTTL = null) {
        if ($ttl) {
            $ttl = is_string($ttl) ? self::convertExpirationToSeconds($ttl) : $ttl;
        } else {
            $ttl = $defaultTTL;
        }
        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)
  {
    return CacheerHelper::arrayIdentifier($currentCacheData, $cacheData);
  }
}