SugiPHP\Cache\FileStore

Complexity

Total Complexity

15

Size/Duplication

Total Lines	107
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	5
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	add()	0	8	2
A	set()	0	9	2
A	get()	0	20	3
A	has()	0	4	2
A	delete()	0	4	1
A	flush()	0	9	3
A	filename()	0	4	1

<?php
/**
 * Saves cached values in the file.
 *
 * @package SugiPHP.Cache
 * @author  Plamen Popov <tzappa@gmail.com>
 * @license http://opensource.org/licenses/mit-license.php (MIT License)
 */

namespace SugiPHP\Cache;

class FileStore implements StoreInterface
{
    /**
     * Path to directory where cache files will be saved.
     */
    protected $path;

    /**
     * Creates a File store
     *
     * @param string
     */
    public function __construct($path)
    {
        $this->path = rtrim($path, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
    }

    /**
     * {@inheritdoc}
     */
    public function add($key, $value, $ttl = 0)
    {
        if ($this->has($key)) {
            return false;
        }

        return $this->set($key, $value, $ttl);
    }

    /**
     * {@inheritdoc}
     */
    public function set($key, $value, $ttl = 0)
    {
        $file = $this->filename($key);
        $expire = ($ttl) ? time() + $ttl : "9999999999";
        // serializing is done mainly to distinguish type of the $value - string, number, etc.
        $contents = $expire.serialize($value);

        return (boolean) (@file_put_contents($file, $contents, LOCK_EX));
    }

    /**
     * {@inheritdoc}
     */
    public function get($key)
    {
        $file = $this->filename($key);
        if (!is_file($file)) {
            return null;
        }

        $contents = file_get_contents($file);

        // check TTL
        $expire = substr($contents, 0, 10);
        if ($expire < time()) {
            // if cache is expired delete cache file
            $this->delete($key);

            return null;
        }

        return unserialize(substr($contents, 10));
    }

    /**
     * {@inheritdoc}
     */
    public function has($key)
    {
        return (is_null($this->get($key))) ? false : true;
    }

    /**
     * {@inheritdoc}
     */
    public function delete($key)
    {
        @unlink($this->filename($key));

It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

    }

    /**
     * {@inheritdoc}
     */
    public function flush()
    {
        $files = glob($this->path."*.cache");
        if ($files) {

The expression $files of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

            foreach ($files as $file) {
                @unlink($file);

It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

            }
        }
    }

    /**
     * Generates a filename based on the $key parameter
     *
     * @param string $key
     *
     * @return string
     */
    protected function filename($key)
    {
        return $this->path.md5($key).".cache";
    }
}