Desarrolla2\Cache\File\TrieFilename

Complexity

Total Complexity

9

Size/Duplication

Total Lines	97
Duplicated Lines	0 %

Test Coverage

Coverage

72.72%

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getLevels()	0	3	1
A	getFormat()	0	3	1
A	isHashed()	0	3	1
A	wildcardPath()	0	5	1
A	__construct()	0	5	1
A	__invoke()	0	16	4

<?php
/**
 * This file is part of the Cache package.
 *
 * Copyright (c) Daniel González
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @author Daniel González <daniel@desarrolla2.com>
 * @author Arnold Daniels <arnold@jasny.net>
 */

declare(strict_types=1);

namespace Desarrolla2\Cache\File;

/**
 * Create a path for a key as prefix tree directory structure.
 *
 * @see https://en.wikipedia.org/wiki/Trie
 */
class TrieFilename
{
    /**
     * @var string
     */
    protected $format;

    /**
     * @var int
     */
    protected $levels;

    /**
     * @var bool
     */
    protected $hash;


    /**
     * TrieFilename constructor.
     *
     * @param string $format
     * @param int    $levels  The depth of the structure
     * @param bool   $hash    MD5 hash the key to get a better spread
     */
    public function __construct(string $format, int $levels = 1, bool $hash = false)
    {
        $this->format = $format;
        $this->levels = $levels;
        $this->hash = $hash;
    }

    /**
     * Get the format
     *
     * @return string
     */
    public function getFormat(): string
    {
        return $this->format;
    }

    /**
     * Get the depth of the structure
     *
     * @return int
     */
    public function getLevels(): int
    {
        return $this->levels;
    }

    /**
     * Will the key be hashed to create the trie.
     *
     * @return bool
     */
    public function isHashed(): bool
    {
        return $this->hash;
    }


    /**
     * Create the path for a key
     *
     * @param string $key
     * @return string
     */
    public function __invoke(string $key): string
    {
        if (empty($key)) {
            return $this->wildcardPath();
        }

        $dirname = $this->hash ? base_convert(md5($key), 16, 36) : $key;
        $filename = sprintf($this->format, $key);

        $path = '';

        for ($length = 1; $length <= $this->levels; $length++) {
            $path .= substr($dirname, 0, $length) . DIRECTORY_SEPARATOR;
        }

        return $path . $filename;
    }

    /**
     * Get a path for all files (using glob)
     *
     * @return string
     */
    protected function wildcardPath(): string
    {
        $filename = sprintf($this->format, '*');

        return str_repeat('*' . DIRECTORY_SEPARATOR, $this->levels) . $filename;
    }
}