BaseManager::encode() - Code Metrics - Inspection of "adds support for explicitly defining cache directo..." - jaredchu/Simple-Cache - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#3)

unknown

created 2018-05-24 10:29 UTC

BaseManager::encode() A

↳ Parent: BaseManager

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	1

<?php
/**
 * Created by PhpStorm.
 * User: jaredchu
 * Date: 04/08/2017
 * Time: 11:36
 */

namespace JC\Cache;

/**
 * Class CacheManager
 * @package JC
 *
 * Manage the list of caching file and object
 * Save in $cFilename
 */
abstract class BaseManager
{
    /**
     * @var string
     */
    protected static $cFileName;

    /**
     * @var string
     */
    protected static $cacheDirectory;

    /**
     * @param string $cacheDirectory
     */
    public static function setCacheDirectory($cacheDirectory) {
        self::$cacheDirectory = $cacheDirectory;
    }

    /**
     * @param $cFileName
     */
    public static function setCFileName($cFileName)
    {
        static::$cFileName = $cFileName;
    }

    /**
     * @return string
     */
    public static function getCFileName()
    {
        return static::$cFileName;
    }

    /**
     * @return string
     *
     * Return absolute file path which store cache list
     */
    public static function getCFilePath()
    {
        $cacheDirectory = empty(self::$cacheDirectory) ? sys_get_temp_dir() : self::$cacheDirectory;
        return $cacheDirectory . '/' . static::getCFileName();
    }

    /**
     * Unique string for each server
     * @param string $salt
     * @return string
     */
    public static function getUniqueString($salt = '')
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        $uniqueString = isset($_SERVER['SERVER_SIGNATURE']) ? $_SERVER['SERVER_SIGNATURE'] . __DIR__ : __DIR__;
        return md5($uniqueString . $salt);
    }

    /**
     * @param $key
     * @return bool|string
     *
     * Return absolute file path of caching object
     */
    public static function get($key)
    {
        $cacheList = static::getCacheList();
        if (isset($cacheList[$key])) {
            if (($cacheList[$key][0] == 0 || $cacheList[$key][0] >= time())) {
                return $cacheList[$key][1];
            } else {
                unlink($cacheList[$key][1]);
                static::remove($key);
            }
        }

        return false;
    }

    /**
     * @param $key
     * @param $filePath
     * @return bool
     *
     * Save $key and $filePath in cacheList
     */
    public static function set($key, $filePath, $ttl)
    {
        $cacheList = static::getCacheList();

        if ($ttl != 0) {
            $ttl += time();
        }
        $cacheList[$key] = [$ttl, $filePath];

        return static::setCacheList($cacheList);
    }

    /**
     * @param $key
     * @return bool
     *
     * Remove caching object file and remove from cache list
     */
    public static function remove($key)
    {
        $cacheList = static::getCacheList();
        unset($cacheList[$key]);

        return static::setCacheList($cacheList);
    }

    /**
     * @param $key
     * @return bool
     */
    public static function has($key)
    {
        $cacheList = static::getCacheList();
        if (is_array($cacheList)) {
            return array_key_exists($key, $cacheList);
        }

        return false;
    }

    /**
     * @return array
     *
     * Return cache list in array
     */
    protected static function getCacheList()
    {
        if (file_exists(static::getCFilePath())) {
            return static::decode(file_get_contents(static::getCFilePath()));
        }

        return array();
    }

    /**
     * @param $cacheList
     * @return bool
     */
    protected static function setCacheList($cacheList)
    {
        return (bool)file_put_contents(static::getCFilePath(), static::encode($cacheList));
    }

    /**
     * @param $array
     * @return string
     */
    protected static function encode($array)
    {
        return json_encode($array);
    }

    /**
     * @param $string
     * @return array
     */
    protected static function decode($string)
    {
        return json_decode($string, true);
    }
}


1			<?php
2			/**
3			* Created by PhpStorm.
4			* User: jaredchu
5			* Date: 04/08/2017
6			* Time: 11:36
7			*/
8
9			namespace JC\Cache;
10
11			/**
12			* Class CacheManager
13			* @package JC
14			*
15			* Manage the list of caching file and object
16			* Save in $cFilename
17			*/
18			abstract class BaseManager
19			{
20			/**
21			* @var string
22			*/
23			protected static $cFileName;
24
25			/**
26			* @var string
27			*/
28			protected static $cacheDirectory;
29
30			/**
31			* @param string $cacheDirectory
32			*/
33			public static function setCacheDirectory($cacheDirectory) {
34			self::$cacheDirectory = $cacheDirectory;
35			}
36
37			/**
38			* @param $cFileName
39			*/
40			public static function setCFileName($cFileName)
41			{
42			static::$cFileName = $cFileName;
43			}
44
45			/**
46			* @return string
47			*/
48			public static function getCFileName()
49			{
50			return static::$cFileName;
51			}
52
53			/**
54			* @return string
55			*
56			* Return absolute file path which store cache list
57			*/
58			public static function getCFilePath()
59			{
60			$cacheDirectory = empty(self::$cacheDirectory) ? sys_get_temp_dir() : self::$cacheDirectory;
61			return $cacheDirectory . '/' . static::getCFileName();
62			}
63
64			/**
65			* Unique string for each server
66			* @param string $salt
67			* @return string
68			*/
69			public static function getUniqueString($salt = '')
			0 ignored issues – show Coding Style introduced 2017-08-10 10:20 UTC by Report Bug Copy Issue Report `getUniqueString` uses the super-global variable `$_SERVER` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
70			{
71			$uniqueString = isset($_SERVER['SERVER_SIGNATURE']) ? $_SERVER['SERVER_SIGNATURE'] . __DIR__ : __DIR__;
72			return md5($uniqueString . $salt);
73			}
74
75			/**
76			* @param $key
77			* @return bool\|string
78			*
79			* Return absolute file path of caching object
80			*/
81			public static function get($key)
82			{
83			$cacheList = static::getCacheList();
84			if (isset($cacheList[$key])) {
85			if (($cacheList[$key][0] == 0 \|\| $cacheList[$key][0] >= time())) {
86			return $cacheList[$key][1];
87			} else {
88			unlink($cacheList[$key][1]);
89			static::remove($key);
90			}
91			}
92
93			return false;
94			}
95
96			/**
97			* @param $key
98			* @param $filePath
99			* @return bool
100			*
101			* Save $key and $filePath in cacheList
102			*/
103			public static function set($key, $filePath, $ttl)
104			{
105			$cacheList = static::getCacheList();
106
107			if ($ttl != 0) {
108			$ttl += time();
109			}
110			$cacheList[$key] = [$ttl, $filePath];
111
112			return static::setCacheList($cacheList);
113			}
114
115			/**
116			* @param $key
117			* @return bool
118			*
119			* Remove caching object file and remove from cache list
120			*/
121			public static function remove($key)
122			{
123			$cacheList = static::getCacheList();
124			unset($cacheList[$key]);
125
126			return static::setCacheList($cacheList);
127			}
128
129			/**
130			* @param $key
131			* @return bool
132			*/
133			public static function has($key)
134			{
135			$cacheList = static::getCacheList();
136			if (is_array($cacheList)) {
137			return array_key_exists($key, $cacheList);
138			}
139
140			return false;
141			}
142
143			/**
144			* @return array
145			*
146			* Return cache list in array
147			*/
148			protected static function getCacheList()
149			{
150			if (file_exists(static::getCFilePath())) {
151			return static::decode(file_get_contents(static::getCFilePath()));
152			}
153
154			return array();
155			}
156
157			/**
158			* @param $cacheList
159			* @return bool
160			*/
161			protected static function setCacheList($cacheList)
162			{
163			return (bool)file_put_contents(static::getCFilePath(), static::encode($cacheList));
164			}
165
166			/**
167			* @param $array
168			* @return string
169			*/
170			protected static function encode($array)
171			{
172			return json_encode($array);
173			}
174
175			/**
176			* @param $string
177			* @return array
178			*/
179			protected static function decode($string)
180			{
181			return json_decode($string, true);
182			}
183			}
184

jaredchu / Simple-Cache

Pull Request — master (#3)

BaseManager::encode() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like