FileCache::deleteCacheFile() - Code Metrics - PiedWeb/FileCache - Measure and Improve Code Quality continuously with Scrutinizer

FileCache::deleteCacheFile() A
last analyzed 2019-01-16 07:16 UTC

↳ Parent: FileCache

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	1
dl	0
loc	3
ccs	2
cts	2
cp	1
crap	1
rs	10
c	0
b	0
f	0

<?php
namespace PiedWeb\FileCache;

class FileCache
{
    /**
     * Prefix your cache files
     * @var string
     */
    protected $prefix;

    /**
     * Folder where your cache files are stored
     * @var string
     */
    protected $folder;

    /**
     * Constructor
     *
     * @param string $folder Folder containing cache files. Default /tmp
     * @param string $prefix Prefix for the cache files. Default empty.
     */
    public function __construct(string $folder = '/tmp', string $prefix = '')
    {
        $this->setCacheFolder($folder);
        $this->setPrefix($prefix);
    }

    /**
     * Instanciator
     *
     * @param string $folder Folder containing cache files. Default /tmp
     * @param string $prefix Prefix for the cache files. Default empty.
     *
     * return self
     */
    public static function instance(string $folder = '/tmp', string $prefix = '')
    {
        $class = get_called_class();
        return new  $class($folder, $prefix);
    }

    /**
     * Chainable prefix setter
     *
     * @param string $prefix
     *
     * @return self
     */
    protected function setPrefix(string $prefix)
    {
        $this->prefix = $prefix;

        return $this;
    }

    /**
     * Set the cache folder (chainable folder setter)
     *
     * @param string $folder
     *
     * @return self
     */
    protected function setCacheFolder(string $folder)
    {
        $this->folder = $folder;

        return $this;
    }

    /**
     * Get cache file path
     *
     * @param mixed $key
     *
     * @return string
     */
    public function getCacheFilePath($key)
    {
        return $this->folder.'/'.$this->prefix.sha1($key);
    }

    /**
     * Return your cache data else create and return data
     *
     * @param string $key    String wich permit to identify your cache file
     * @param int    $maxAge Time the cache is valid. Default 86400 (1 day).
     * @param mixed  $data   It can be a function wich generate data to cache or a variable wich will be directly stored
     *
     * @return mixed Return your $data or the esponse from your function (or it cache)
     */
    public function getElseCreate($key, int $maxAge, $data)
    {
        $cachedData = $this->get($key, $maxAge);

        if ($cachedData === false) {
            $cachedData = is_callable($data) ? call_user_func($data) : $data;
            $this->set($key, $cachedData);
        }

        return $cachedData;
    }

    /**
     * Get your cached data if exist else return false
     *
     * @param string $key    String wich permit to identify your cache file
     * @param int    $maxAge Time the cache is valid. Default 86400 (1 day). 0 = always valid
     *
     * @return mixed Return FALSE if cache not found or not valid (BUT WHAT IF WE STORE A BOOL EQUAL TO FALSE ?!)
     */
    public function get($key, int $maxAge = 86400)
    {
        $cacheFile = $this->getCacheFilePath($key);
        if ($this->isCacheFileValid($cacheFile, $maxAge)) {
            return unserialize(file_get_contents($this->getCacheFilePath($key)));
        }

        return false;
    }

    /**
     * Set your data in cache
     *
     * @param string $key  String wich permit to identify your cache file
     * @param mixed  $data Variable wich will be directly stored
     *
     * @return self
     */
    public function set($key, $data)
    {
        file_put_contents($this->getCacheFilePath($key), serialize($data));

        return $this;
    }

    /**
     * Cache is valid ?
     *
     * @param string $key    String wich permit to identify your cache file
     * @param int    $maxAge Time the cache is valid. Default 86400 (1 day).
     *
     * @return bool
     */
    public function isCacheValid($key, int $maxAge)
    {
        $cacheFile = $this->getCacheFilePath($key);

        return $this->isCacheFileValid($cacheFile, $maxAge);
    }

    /**
     * Cache File is valid ?
     *
     * @param string $cacheFile Cache file path
     * @param int    $maxAge    Time the cache is valid. Default 86400 (1 day).
     *
     * @return bool
     */
    protected function isCacheFileValid($cacheFile, $maxAge)
    {
        $expire = time() - $maxAge;

        return !file_exists($cacheFile) || (filemtime($cacheFile) <= $expire && $maxAge !== 0)  ? false : true;
    }

    /**
     * @return bool (same as unlink php function)
     */
    public function deleteCacheFile($key)
    {
        return unlink($this->getCacheFilePath($key));
    }

    /**
     * Delete all cache files with the $prefix
     *
     * @return int Number of deleted files
     *
     * @throw \Exception If the prefix is empty
     */
    public function deleteCacheFilesByPrefix()
    {
        if (empty($this->prefix)) {
            throw new Exception('FileCache::Prefix is empty : Can\'t delete cache files by prefix.');

        }

        $deletedFilesCounter = 0;
        $files = glob($this->folder.'/'.$this->prefix.'*', GLOB_NOSORT);
        foreach ($files as $file) {
            unlink($file);
            ++$deletedFilesCounter;
        }

        return $deletedFilesCounter;
    }
}


1		<?php
2		namespace PiedWeb\FileCache;
3
4		class FileCache
5		{
6		/**
7		* Prefix your cache files
8		* @var string
9		*/
10		protected $prefix;
11
12		/**
13		* Folder where your cache files are stored
14		* @var string
15		*/
16		protected $folder;
17
18		/**
19		* Constructor
20		*
21		* @param string $folder Folder containing cache files. Default /tmp
22		* @param string $prefix Prefix for the cache files. Default empty.
23		*/
24	12	public function __construct(string $folder = '/tmp', string $prefix = '')
25		{
26	12	$this->setCacheFolder($folder);
27	12	$this->setPrefix($prefix);
28	12	}
29
30		/**
31		* Instanciator
32		*
33		* @param string $folder Folder containing cache files. Default /tmp
34		* @param string $prefix Prefix for the cache files. Default empty.
35		*
36		* return self
37		*/
38	9	public static function instance(string $folder = '/tmp', string $prefix = '')
39		{
40	9	$class = get_called_class();
41	9	return new $class($folder, $prefix);
42		}
43
44		/**
45		* Chainable prefix setter
46		*
47		* @param string $prefix
48		*
49		* @return self
50		*/
51	12	protected function setPrefix(string $prefix)
52		{
53	12	$this->prefix = $prefix;
54
55	12	return $this;
56		}
57
58		/**
59		* Set the cache folder (chainable folder setter)
60		*
61		* @param string $folder
62		*
63		* @return self
64		*/
65	12	protected function setCacheFolder(string $folder)
66		{
67	12	$this->folder = $folder;
68
69	12	return $this;
70		}
71
72		/**
73		* Get cache file path
74		*
75		* @param mixed $key
76		*
77		* @return string
78		*/
79	12	public function getCacheFilePath($key)
80		{
81	12	return $this->folder.'/'.$this->prefix.sha1($key);
82		}
83
84		/**
85		* Return your cache data else create and return data
86		*
87		* @param string $key String wich permit to identify your cache file
88		* @param int $maxAge Time the cache is valid. Default 86400 (1 day).
89		* @param mixed $data It can be a function wich generate data to cache or a variable wich will be directly stored
90		*
91		* @return mixed Return your $data or the esponse from your function (or it cache)
92		*/
93	9	public function getElseCreate($key, int $maxAge, $data)
94		{
95	9	$cachedData = $this->get($key, $maxAge);
96
97	9	if ($cachedData === false) {
98	9	$cachedData = is_callable($data) ? call_user_func($data) : $data;
99	9	$this->set($key, $cachedData);
100		}
101
102	9	return $cachedData;
103		}
104
105		/**
106		* Get your cached data if exist else return false
107		*
108		* @param string $key String wich permit to identify your cache file
109		* @param int $maxAge Time the cache is valid. Default 86400 (1 day). 0 = always valid
110		*
111		* @return mixed Return FALSE if cache not found or not valid (BUT WHAT IF WE STORE A BOOL EQUAL TO FALSE ?!)
112		*/
113	12	public function get($key, int $maxAge = 86400)
114		{
115	12	$cacheFile = $this->getCacheFilePath($key);
116	12	if ($this->isCacheFileValid($cacheFile, $maxAge)) {
117	3	return unserialize(file_get_contents($this->getCacheFilePath($key)));
118		}
119
120	9	return false;
121		}
122
123		/**
124		* Set your data in cache
125		*
126		* @param string $key String wich permit to identify your cache file
127		* @param mixed $data Variable wich will be directly stored
128		*
129		* @return self
130		*/
131	12	public function set($key, $data)
132		{
133	12	file_put_contents($this->getCacheFilePath($key), serialize($data));
134
135	12	return $this;
136		}
137
138		/**
139		* Cache is valid ?
140		*
141		* @param string $key String wich permit to identify your cache file
142		* @param int $maxAge Time the cache is valid. Default 86400 (1 day).
143		*
144		* @return bool
145		*/
146	3	public function isCacheValid($key, int $maxAge)
147		{
148	3	$cacheFile = $this->getCacheFilePath($key);
149
150	3	return $this->isCacheFileValid($cacheFile, $maxAge);
151		}
152
153		/**
154		* Cache File is valid ?
155		*
156		* @param string $cacheFile Cache file path
157		* @param int $maxAge Time the cache is valid. Default 86400 (1 day).
158		*
159		* @return bool
160		*/
161	12	protected function isCacheFileValid($cacheFile, $maxAge)
162		{
163	12	$expire = time() - $maxAge;
164
165	12	return !file_exists($cacheFile) \|\| (filemtime($cacheFile) <= $expire && $maxAge !== 0) ? false : true;
166		}
167
168		/**
169		* @return bool (same as unlink php function)
170		*/
171	9	public function deleteCacheFile($key)
172		{
173	9	return unlink($this->getCacheFilePath($key));
174		}
175
176		/**
177		* Delete all cache files with the $prefix
178		*
179		* @return int Number of deleted files
180		*
181		* @throw \Exception If the prefix is empty
182		*/
183	3	public function deleteCacheFilesByPrefix()
184		{
185	3	if (empty($this->prefix)) {
186		throw new Exception('FileCache::Prefix is empty : Can\'t delete cache files by prefix.');
		0 ignored issues – show Bug introduced 2019-01-06 17:21 UTC by Report Bug Copy Issue Report The type `PiedWeb\FileCache\Exception` was not found. Did you mean `Exception`? If so, make sure to prefix the type with `\`. Loading history...
187		}
188
189	3	$deletedFilesCounter = 0;
190	3	$files = glob($this->folder.'/'.$this->prefix.'*', GLOB_NOSORT);
191	3	foreach ($files as $file) {
192	3	unlink($file);
193	3	++$deletedFilesCounter;
194		}
195
196	3	return $deletedFilesCounter;
197		}
198		}
199

PiedWeb / FileCache

FileCache::deleteCacheFile() A last analyzed 2019-01-16 07:16 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

FileCache::deleteCacheFile() A
last analyzed 2019-01-16 07:16 UTC