cache_api::isSupported() - 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

cache_api::isSupported() A

↳ Parent: cache_api

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	5
nc	2
nop	1
dl	0
loc	8
rs	9.4285
c	0
b	0
f	0

<?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...');

/**
 * Interface cache_api_interface
 */
interface cache_api_interface
{
	/**
	 * Checks whether we can use the cache method performed by this API.
	 *
	 * @access public
	 * @param boolean $test Test if this is supported or enabled.
	 * @return boolean Whether or not the cache is supported
	 */
	public function isSupported($test = false);

	/**
	 * Connects to the cache method. This defines our $key. If this fails, we return false, otherwise we return true.
	 *
	 * @access public
	 * @return boolean Whether or not the cache method was connected to.
	 */
	public function connect();

	/**
	 * Overrides the default prefix. If left alone, this will use the default key defined in the class.
	 *
	 * @access public
	 * @param string $key The key to use
	 * @return boolean If this was successful or not.
	 */
	public function setPrefix($key = '');

	/**
	 * Gets the prefix as defined from set or the default.
	 *
	 * @access public
	 * @return string the value of $key.
	 */
	public function getPrefix();

	/**
	 * Sets a default Time To Live, if this isn't specified we let the class define it.
	 *
	 * @access public
	 * @param int $ttl The default TTL
	 * @return boolean If this was successful or not.
	 */
	public function setDefaultTTL($ttl = 120);

	/**
	 * Gets the TTL as defined from set or the default.
	 *
	 * @access public
	 * @return string the value of $ttl.
	 */
	public function getDefaultTTL();

	/**
	 * Gets data from the cache.
	 *
	 * @access public
	 * @param string $key The key to use, the prefix is applied to the key name.
	 * @param string $ttl Overrides the default TTL.

	 * @return mixed The result from the cache, if there is no data or it is invalid, we return null.
	 */
	public function getData($key, $ttl = null);

	/**
	 * Saves to data the cache.
	 *
	 * @access public
	 * @param string $key The key to use, the prefix is applied to the key name.
	 * @param mixed $value The data we wish to save.
	 * @param string $ttl Overrides the default TTL.

	 * @return bool Whether or not we could save this to the cache.
	 */
	public function putData($key, $value, $ttl = null);

	/**
	 * Clean out the cache.
	 *
	 * @param string $type If supported, the type of cache to clear, blank/data or user.
	 * @return bool Whether or not we could clean the cache.
	 */
	public function cleanCache($type = '');

	/**
	 * Invalidate all cached data.
	 *
	 * @return bool Whether or not we could invalidate the cache.
	 */
	public function invalidateCache();

	/**
	 * Closes connections to the cache method.
	 *
	 * @access public
	 * @return bool Whether or not we could close connections.
	 */
	public function quit();

	/**
	 * Specify custom settings that the cache API supports.
	 *
	 * @access public
	 * @param array $config_vars Additional config_vars, see ManageSettings.php for usage.
	 * @return void No return is needed.
	 */
	public function cacheSettings(array &$config_vars);

	/**
	 * Gets the latest version of SMF this is compatible with.
	 *
	 * @access public
	 * @return string the value of $key.
	 */
	public function getCompatibleVersion();

	/**
	 * Gets the min version that we support.
	 *
	 * @access public
	 * @return string the value of $key.
	 */
	public function getMiniumnVersion();

	/**
	 * Gets the Version of the Caching API.
	 *
	 * @access public
	 * @return string the value of $key.
	 */
	public function getVersion();
}

/**
 * Class cache_api
 */
abstract class cache_api implements cache_api_interface
{
	/**
	 * @var string The last version of SMF that this was tested on. Helps protect against API changes.
	 */
	protected $version_compatible = 'SMF 2.1 Beta 4';

	/**
	 * @var string The minimum SMF version that this will work with
	 */
	protected $min_smf_version = 'SMF 2.1 Beta 4';

	/**
	 * @var string The prefix for all keys.
	 */
	protected $prefix = '';

	/**
	 * @var int The default TTL.
	 */
	protected $ttl = 120;

	/**
	 * Does basic setup of a cache method when we create the object but before we call connect.
	 *
	 * @access public
	 */
	public function __construct()
	{
		$this->setPrefix('');
	}

	/**
	 * {@inheritDoc}
	 */
	public function isSupported($test = false)
	{
		global $cache_enable;
function myFunction($a, $b) {
    // Do something
}

		if ($test)
			return true;
		return !empty($cache_enable);
	}

	/**
	 * {@inheritDoc}
	 */
	public function connect()
	{
	}

	/**
	 * {@inheritDoc}
	 */
	public function setPrefix($prefix = '')
	{
		global $boardurl, $cachedir;
function myFunction($a, $b) {
    // Do something
}

		// Find a valid good file to do mtime checks on.
		if (file_exists($cachedir . '/' . 'index.php'))
			$filemtime = $cachedir . '/' . 'index.php';
		elseif (is_dir($cachedir . '/'))
			$filemtime = $cachedir . '/';
		else
			$filemtime = $boardurl . '/index.php';

		// Set the default if no prefix was specified.
		if (empty($prefix))
			$this->prefix = md5($boardurl . filemtime($filemtime)) . '-SMF-';
		else
			$this->prefix = $prefix;

		return true;
	}

	/**
	 * {@inheritDoc}
	 */
	public function getPrefix()
	{
		return $this->prefix;
	}

	/**
	 * {@inheritDoc}
	 */
	public function setDefaultTTL($ttl = 120)
	{
		$this->ttl = $ttl;

		return true;
	}

	/**
	 * {@inheritDoc}
	 */
	public function getDefaultTTL()
	{
		return $this->ttl;
	}

	/**
	 * {@inheritDoc}
	 */
	public function getData($key, $ttl = null)
	{
	}

	/**
	 * {@inheritDoc}
	 */
	public function putData($key, $value, $ttl = null)
	{
	}

	/**
	 * {@inheritDoc}
	 */
	public function cleanCache($type = '')
	{
	}

	/**
	 * Invalidate all cached data.
	 *
	 * @return bool Whether or not we could invalidate the cache.
	 */
	public function invalidateCache()
	{
		global $cachedir;
function myFunction($a, $b) {
    // Do something
}

		// Invalidate cache, to be sure!
		// ... as long as index.php can be modified, anyway.
		if (is_writable($cachedir . '/' . 'index.php'))
			@touch($cachedir . '/' . 'index.php');
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}

		return true;
	}

	/**
	 * {@inheritDoc}
	 */
	public function quit()
	{
	}

	/**
	 * {@inheritDoc}
	 */
	public function cacheSettings(array &$config_vars)
	{
	}

	/**
	 * {@inheritDoc}
	 */
	public function getCompatibleVersion()
	{
		return $this->version_compatible;
	}

	/**
	 * {@inheritDoc}
	 */
	public function getMiniumnVersion()
	{
		return $this->min_smf_version;
	}

	/**
	 * {@inheritDoc}
	 */
	public function getVersion()
	{
		return $this->min_smf_version;
	}
}

?>

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

cache_api::isSupported() A

Complexity

Size

Duplication

Importance

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

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			* Interface cache_api_interface
19			*/
20			interface cache_api_interface
21			{
22			/**
23			* Checks whether we can use the cache method performed by this API.
24			*
25			* @access public
26			* @param boolean $test Test if this is supported or enabled.
27			* @return boolean Whether or not the cache is supported
28			*/
29			public function isSupported($test = false);
30
31			/**
32			* Connects to the cache method. This defines our $key. If this fails, we return false, otherwise we return true.
33			*
34			* @access public
35			* @return boolean Whether or not the cache method was connected to.
36			*/
37			public function connect();
38
39			/**
40			* Overrides the default prefix. If left alone, this will use the default key defined in the class.
41			*
42			* @access public
43			* @param string $key The key to use
44			* @return boolean If this was successful or not.
45			*/
46			public function setPrefix($key = '');
47
48			/**
49			* Gets the prefix as defined from set or the default.
50			*
51			* @access public
52			* @return string the value of $key.
53			*/
54			public function getPrefix();
55
56			/**
57			* Sets a default Time To Live, if this isn't specified we let the class define it.
58			*
59			* @access public
60			* @param int $ttl The default TTL
61			* @return boolean If this was successful or not.
62			*/
63			public function setDefaultTTL($ttl = 120);
64
65			/**
66			* Gets the TTL as defined from set or the default.
67			*
68			* @access public
69			* @return string the value of $ttl.
70			*/
71			public function getDefaultTTL();
72
73			/**
74			* Gets data from the cache.
75			*
76			* @access public
77			* @param string $key The key to use, the prefix is applied to the key name.
78			* @param string $ttl Overrides the default TTL.
			0 ignored issues – show Documentation introduced 2017-08-25 21:51 UTC by Report Bug Copy Issue Report Should the type for parameter `$ttl` not be `string\|null`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
79			* @return mixed The result from the cache, if there is no data or it is invalid, we return null.
80			*/
81			public function getData($key, $ttl = null);
82
83			/**
84			* Saves to data the cache.
85			*
86			* @access public
87			* @param string $key The key to use, the prefix is applied to the key name.
88			* @param mixed $value The data we wish to save.
89			* @param string $ttl Overrides the default TTL.
			0 ignored issues – show Documentation introduced 2017-08-25 21:51 UTC by Report Bug Copy Issue Report Should the type for parameter `$ttl` not be `string\|null`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
90			* @return bool Whether or not we could save this to the cache.
91			*/
92			public function putData($key, $value, $ttl = null);
93
94			/**
95			* Clean out the cache.
96			*
97			* @param string $type If supported, the type of cache to clear, blank/data or user.
98			* @return bool Whether or not we could clean the cache.
99			*/
100			public function cleanCache($type = '');
101
102			/**
103			* Invalidate all cached data.
104			*
105			* @return bool Whether or not we could invalidate the cache.
106			*/
107			public function invalidateCache();
108
109			/**
110			* Closes connections to the cache method.
111			*
112			* @access public
113			* @return bool Whether or not we could close connections.
114			*/
115			public function quit();
116
117			/**
118			* Specify custom settings that the cache API supports.
119			*
120			* @access public
121			* @param array $config_vars Additional config_vars, see ManageSettings.php for usage.
122			* @return void No return is needed.
123			*/
124			public function cacheSettings(array &$config_vars);
125
126			/**
127			* Gets the latest version of SMF this is compatible with.
128			*
129			* @access public
130			* @return string the value of $key.
131			*/
132			public function getCompatibleVersion();
133
134			/**
135			* Gets the min version that we support.
136			*
137			* @access public
138			* @return string the value of $key.
139			*/
140			public function getMiniumnVersion();
141
142			/**
143			* Gets the Version of the Caching API.
144			*
145			* @access public
146			* @return string the value of $key.
147			*/
148			public function getVersion();
149			}
150
151			/**
152			* Class cache_api
153			*/
154			abstract class cache_api implements cache_api_interface
155			{
156			/**
157			* @var string The last version of SMF that this was tested on. Helps protect against API changes.
158			*/
159			protected $version_compatible = 'SMF 2.1 Beta 4';
160
161			/**
162			* @var string The minimum SMF version that this will work with
163			*/
164			protected $min_smf_version = 'SMF 2.1 Beta 4';
165
166			/**
167			* @var string The prefix for all keys.
168			*/
169			protected $prefix = '';
170
171			/**
172			* @var int The default TTL.
173			*/
174			protected $ttl = 120;
175
176			/**
177			* Does basic setup of a cache method when we create the object but before we call connect.
178			*
179			* @access public
180			*/
181			public function __construct()
182			{
183			$this->setPrefix('');
184			}
185
186			/**
187			* {@inheritDoc}
188			*/
189			public function isSupported($test = false)
190			{
191			global $cache_enable;
			0 ignored issues – show Compatibility Best Practice introduced 2017-10-15 06:24 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...
192
193			if ($test)
194			return true;
195			return !empty($cache_enable);
196			}
197
198			/**
199			* {@inheritDoc}
200			*/
201			public function connect()
202			{
203			}
204
205			/**
206			* {@inheritDoc}
207			*/
208			public function setPrefix($prefix = '')
209			{
210			global $boardurl, $cachedir;
			0 ignored issues – show Compatibility Best Practice introduced 2017-10-15 06:24 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...
211
212			// Find a valid good file to do mtime checks on.
213			if (file_exists($cachedir . '/' . 'index.php'))
214			$filemtime = $cachedir . '/' . 'index.php';
215			elseif (is_dir($cachedir . '/'))
216			$filemtime = $cachedir . '/';
217			else
218			$filemtime = $boardurl . '/index.php';
219
220			// Set the default if no prefix was specified.
221			if (empty($prefix))
222			$this->prefix = md5($boardurl . filemtime($filemtime)) . '-SMF-';
223			else
224			$this->prefix = $prefix;
225
226			return true;
227			}
228
229			/**
230			* {@inheritDoc}
231			*/
232			public function getPrefix()
233			{
234			return $this->prefix;
235			}
236
237			/**
238			* {@inheritDoc}
239			*/
240			public function setDefaultTTL($ttl = 120)
241			{
242			$this->ttl = $ttl;
243
244			return true;
245			}
246
247			/**
248			* {@inheritDoc}
249			*/
250			public function getDefaultTTL()
251			{
252			return $this->ttl;
253			}
254
255			/**
256			* {@inheritDoc}
257			*/
258			public function getData($key, $ttl = null)
259			{
260			}
261
262			/**
263			* {@inheritDoc}
264			*/
265			public function putData($key, $value, $ttl = null)
266			{
267			}
268
269			/**
270			* {@inheritDoc}
271			*/
272			public function cleanCache($type = '')
273			{
274			}
275
276			/**
277			* Invalidate all cached data.
278			*
279			* @return bool Whether or not we could invalidate the cache.
280			*/
281			public function invalidateCache()
282			{
283			global $cachedir;
			0 ignored issues – show Compatibility Best Practice introduced 2017-10-15 06:24 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...
284
285			// Invalidate cache, to be sure!
286			// ... as long as index.php can be modified, anyway.
287			if (is_writable($cachedir . '/' . 'index.php'))
288			@touch($cachedir . '/' . 'index.php');
			0 ignored issues – show Security Best Practice introduced 2016-12-11 19:54 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
289
290			return true;
291			}
292
293			/**
294			* {@inheritDoc}
295			*/
296			public function quit()
297			{
298			}
299
300			/**
301			* {@inheritDoc}
302			*/
303			public function cacheSettings(array &$config_vars)
304			{
305			}
306
307			/**
308			* {@inheritDoc}
309			*/
310			public function getCompatibleVersion()
311			{
312			return $this->version_compatible;
313			}
314
315			/**
316			* {@inheritDoc}
317			*/
318			public function getMiniumnVersion()
319			{
320			return $this->min_smf_version;
321			}
322
323			/**
324			* {@inheritDoc}
325			*/
326			public function getVersion()
327			{
328			return $this->min_smf_version;
329			}
330			}
331
332			?>

albertlast / SMF2.1

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

cache_api::isSupported() A

Complexity

Size

Duplication

Importance

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