xcache_cache - Code Metrics - Inspection of "Merge pull request #4306 from jdarwood007/cache_ap..." - albertlast/SMF2.1 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — release-2.1 ( 4bdd41...11eb43 )

by Mathias

created 2017-10-15 06:17 UTC

xcache_cache A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	111
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

Metric	Value
dl	0
loc	111
rs	10
c	0
b	0
f	0
wmc	21
lcom	1
cbo	1

7 Methods

Rating	Name	Size	Complexity
A	__construct()	13	3
B	isSupported()	8	5
A	getData()	6	1
A	putData()	9	2
B	cleanCache()	21	7
A	cacheSettings()	20	2
A	getVersion()	4	1

<?php

/**
 * Simple Machines Forum (SMF)
 *
 * @package SMF
 * @author Simple Machines http://www.simplemachines.org
 * @copyright 2017 Simple Machines and individual contributors
 * @license http://www.simplemachines.org/about/smf/license.php BSD
 *
 * @version 2.1 Beta 4
 */

if (!defined('SMF'))
	die('Hacking attempt...');

/**
 * Our Cache API class
 * @package cacheAPI
 */
class xcache_cache extends cache_api
{
	/**
	 * {@inheritDoc}
	 */
	public function __construct()
	{
		global $modSettings;
function myFunction($a, $b) {
    // Do something
}

		parent::__construct();

		// Xcache requuires a admin username and password in order to issue a clear.
		if (!empty($modSettings['xcache_adminuser']) && !empty($modSettings['xcache_adminpass']))
		{
			ini_set('xcache.admin.user', $modSettings['xcache_adminuser']);
			ini_set('xcache.admin.pass', md5($modSettings['xcache_adminpass']));
		}
	}

	/**
	 * {@inheritDoc}
	 */
	public function isSupported($test = false)
	{
		$supported = function_exists('xcache_get') && function_exists('xcache_set') && ini_get('xcache.var_size') > 0;

		if ($test)
			return $supported;
		return parent::isSupported() && $supported;
	}

	/**
	 * {@inheritDoc}
	 */
	public function getData($key, $ttl = null)
	{
		$key = $this->prefix . strtr($key, ':/', '-_');

		return xcache_get($key);
	}

	/**
	 * {@inheritDoc}
	 */
	public function putData($key, $value, $ttl = null)
	{
		$key = $this->prefix . strtr($key, ':/', '-_');

		if ($value === null)
			return xcache_unset($key);
		else
			return xcache_set($key, $value, $ttl);
	}

	/**
	 * {@inheritDoc}
	 */
	public function cleanCache($type = '')
	{
		global $modSettings;
function myFunction($a, $b) {
    // Do something
}

		// Xcache requuires a admin username and password in order to issue a clear. Ideally this would log an error, but it seems like something that could fill up the error log quickly.
		if (empty($modSettings['xcache_adminuser']) || empty($modSettings['xcache_adminpass']))
		{
			// We are going to at least invalidate it.
			$this->invalidateCache();
			return false;
		}

		// if passed a type, clear that type out
		if ($type === '' || $type === 'user')
			xcache_clear_cache(XC_TYPE_VAR, 0);
		if ($type === '' || $type === 'data')
			xcache_clear_cache(XC_TYPE_PHP, 0);

		$this->invalidateCache();
		return true;
	}

	/**
	 * {@inheritDoc}
	 */
	public function cacheSettings(array &$config_vars)
	{
		global $context, $txt;
function myFunction($a, $b) {
    // Do something
}

		$config_vars[] = $txt['cache_xcache_settings'];
		$config_vars[] = array('xcache_adminuser', $txt['cache_xcache_adminuser'], 'db', 'text', 0, 'xcache_adminuser');

		// While we could md5 this when saving, this could be tricky to be sure it doesn't get corrupted on additional saves.
		$config_vars[] = array('xcache_adminpass', $txt['cache_xcache_adminpass'], 'db', 'text', 0);

		if (!isset($context['settings_post_javascript']))
			$context['settings_post_javascript'] = '';

		$context['settings_post_javascript'] .= '
			$("#cache_accelerator").change(function (e) {
				var cache_type = e.currentTarget.value;
				$("#xcache_adminuser").prop("disabled", cache_type != "xcache");
				$("#xcache_adminpass").prop("disabled", cache_type != "xcache");
			});';
	}

	/**
	 * {@inheritDoc}
	 */
	public function getVersion()
	{
		return XCACHE_VERSION;
	}
}

?>

1			<?php
2
3			/**
4			* Simple Machines Forum (SMF)
5			*
6			* @package SMF
7			* @author Simple Machines http://www.simplemachines.org
8			* @copyright 2017 Simple Machines and individual contributors
9			* @license http://www.simplemachines.org/about/smf/license.php BSD
10			*
11			* @version 2.1 Beta 4
12			*/
13
14			if (!defined('SMF'))
15			die('Hacking attempt...');
16
17			/**
18			* Our Cache API class
19			* @package cacheAPI
20			*/
21			class xcache_cache extends cache_api
22			{
23			/**
24			* {@inheritDoc}
25			*/
26			public function __construct()
27			{
28			global $modSettings;
			0 ignored issues – show Compatibility Best Practice introduced 2017-08-25 21:51 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
29
30			parent::__construct();
31
32			// Xcache requuires a admin username and password in order to issue a clear.
33			if (!empty($modSettings['xcache_adminuser']) && !empty($modSettings['xcache_adminpass']))
34			{
35			ini_set('xcache.admin.user', $modSettings['xcache_adminuser']);
36			ini_set('xcache.admin.pass', md5($modSettings['xcache_adminpass']));
37			}
38			}
39
40			/**
41			* {@inheritDoc}
42			*/
43			public function isSupported($test = false)
44			{
45			$supported = function_exists('xcache_get') && function_exists('xcache_set') && ini_get('xcache.var_size') > 0;
46
47			if ($test)
48			return $supported;
49			return parent::isSupported() && $supported;
50			}
51
52			/**
53			* {@inheritDoc}
54			*/
55			public function getData($key, $ttl = null)
56			{
57			$key = $this->prefix . strtr($key, ':/', '-_');
58
59			return xcache_get($key);
60			}
61
62			/**
63			* {@inheritDoc}
64			*/
65			public function putData($key, $value, $ttl = null)
66			{
67			$key = $this->prefix . strtr($key, ':/', '-_');
68
69			if ($value === null)
70			return xcache_unset($key);
71			else
72			return xcache_set($key, $value, $ttl);
73			}
74
75			/**
76			* {@inheritDoc}
77			*/
78			public function cleanCache($type = '')
79			{
80			global $modSettings;
			0 ignored issues – show Compatibility Best Practice introduced 2017-08-25 21:51 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
81
82			// Xcache requuires a admin username and password in order to issue a clear. Ideally this would log an error, but it seems like something that could fill up the error log quickly.
83			if (empty($modSettings['xcache_adminuser']) \|\| empty($modSettings['xcache_adminpass']))
84			{
85			// We are going to at least invalidate it.
86			$this->invalidateCache();
87			return false;
88			}
89
90			// if passed a type, clear that type out
91			if ($type === '' \|\| $type === 'user')
92			xcache_clear_cache(XC_TYPE_VAR, 0);
93			if ($type === '' \|\| $type === 'data')
94			xcache_clear_cache(XC_TYPE_PHP, 0);
95
96			$this->invalidateCache();
97			return true;
98			}
99
100			/**
101			* {@inheritDoc}
102			*/
103			public function cacheSettings(array &$config_vars)
104			{
105			global $context, $txt;
			0 ignored issues – show Compatibility Best Practice introduced 2017-08-25 21:51 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
106
107			$config_vars[] = $txt['cache_xcache_settings'];
108			$config_vars[] = array('xcache_adminuser', $txt['cache_xcache_adminuser'], 'db', 'text', 0, 'xcache_adminuser');
109
110			// While we could md5 this when saving, this could be tricky to be sure it doesn't get corrupted on additional saves.
111			$config_vars[] = array('xcache_adminpass', $txt['cache_xcache_adminpass'], 'db', 'text', 0);
112
113			if (!isset($context['settings_post_javascript']))
114			$context['settings_post_javascript'] = '';
115
116			$context['settings_post_javascript'] .= '
117			$("#cache_accelerator").change(function (e) {
118			var cache_type = e.currentTarget.value;
119			$("#xcache_adminuser").prop("disabled", cache_type != "xcache");
120			$("#xcache_adminpass").prop("disabled", cache_type != "xcache");
121			});';
122			}
123
124			/**
125			* {@inheritDoc}
126			*/
127			public function getVersion()
128			{
129			return XCACHE_VERSION;
130			}
131			}
132
133			?>

albertlast / SMF2.1

Push — release-2.1 ( 4bdd41...11eb43 )

xcache_cache A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

7 Methods

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like