Yiisoft\Cache\CacheKeyNormalizer

Complexity

Total Complexity

7

Size/Duplication

Total Lines	30
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	0

1 Method

Rating	Name	Duplication	Size	Complexity
B	normalize()	0	13	7

<?php

declare(strict_types=1);

namespace Yiisoft\Cache;

use Yiisoft\Cache\Exception\InvalidArgumentException;

use function json_encode;
use function json_last_error_msg;
use function is_int;
use function is_string;
use function md5;
use function mb_strlen;
use function strpbrk;

/**
 * CacheKeyNormalizer normalizes the cache key to a string.
 */
final class CacheKeyNormalizer
{
    /**
     * Normalizes the cache key from a given key.
     *
     * If the given key is a string that does not contain characters `{}()/\@:` and no more than 64 characters,
     * then the key will be returned back as it is, integers will be converted to strings. Otherwise,
     * a normalized key is generated by serializing the given key and applying MD5 hashing.
     *
     * @see https://www.php-fig.org/psr/psr-16/#12-definitions
     *
     * @param mixed $key The key to be normalized.
     *
     * @throws InvalidArgumentException For invalid key.
     *
     * @return string The normalized cache key.
     */
    public function normalize($key): string
    {
        if (is_string($key) || is_int($key)) {
            $key = (string) $key;
            $length = mb_strlen($key, '8bit');
            return (strpbrk($key, '{}()/\@:') || $length < 1 || $length > 64) ? md5($key) : $key;
        }

        if (($key = json_encode($key)) === false) {
            throw new InvalidArgumentException('Invalid key. ' . json_last_error_msg());
        }

        return md5($key);
    }
}