code_review - Code Metrics - Inspection of "More of making scrutinizer happy" - Srokap/code_review - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 238ea5...316830 )

by Paweł

created 2016-05-15 15:30 UTC

code_review C

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	489
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

91.03%

Importance

Changes	19
Bugs	4	Features	8

Metric	Value
c	19
b	4
f	8
dl	0
loc	489
ccs	203
cts	223
cp	0.9103
rs	5.5667
wmc	72
lcom	1
cbo	5

17 Methods

Rating	Name	Size	Complexity
A	boot()	17	3
A	getConfig()	3	1
A	initConfig()	16	3
A	init()	12	1
A	pagesetup()	11	2
B	menu_register()	26	1
A	getPhpIterator()	6	1
A	filterTagsByDeprecatedPrefix()	3	1
A	filterTagsByPrivatePrefix()	3	1
C	getDeprecatedInfoFromDocBlock()	43	8
A	getPrivateInfoFromDocBlock()	10	2
C	getDeprecatedFunctionsList()	30	7
A	getPrivateFunctionsList()	19	3
C	getPrivateFunctionsFromTokens()	64	13
B	getPluginDirsInDir()	21	6
C	getDeprecatedFunctionsFromTokens()	77	14
B	getVersionsList()	21	5

How to fix Complexity

<?php
/**
 * Main plugin class. 
 * Storage for various handlers.
 * @author Paweł Sroka ([email protected])
 */
class code_review {
namespace YourVendor;

class YourClass { }

	/**
	 * Config array to allow mocking of configuration.
	 *
	 * @var array
	 */
	protected static $config = array();

	/**
	 * @codeCoverageIgnore
	 */
	public static function boot() {
		if (version_compare(elgg_get_version(true), '1.9', '<')) {
			$autoloader = new CodeReviewAutoloader();
			$autoloader->register();
		}

		$enginePath = elgg_get_config('path') . 'engine/';
		if (function_exists('elgg_get_engine_path')) {
			$enginePath = elgg_get_engine_path() . '/';
		}
		self::initConfig(array(
			'engine_path' => $enginePath,
			'path' => elgg_get_config('path'),
			'pluginspath' => elgg_get_plugins_path(),
			'plugins_getter' => 'elgg_get_plugins',
		));
	}

	/**
	 * @return array
	 */
	public static function getConfig() {
		return self::$config;
	}

	/**
	 * @param array $options
	 *
	 * @todo Move into CodeReviewConfig instead
	 */
	public static function initConfig(array $options) {
		self::$config = $options;

		$names = array(
			'T_NAMESPACE',
			'T_NS_C',
			'T_NS_SEPARATOR',
		);

		foreach ($names as $name) {
			if (!defined($name)) {
				// just define it with value unused by tokenizer to avoid errors on old PHP versions
				define($name, 10000);
			}
		}
	}

	/**
	 * @codeCoverageIgnore
	 */
	public static function init() {

		elgg_register_event_handler('pagesetup', 'system', array(__CLASS__, 'pagesetup'));

		elgg_register_plugin_hook_handler('register', 'menu:code_review', array(__CLASS__, 'menu_register'));

		elgg_register_ajax_view('graphics/ajax_loader');
		elgg_register_ajax_view('code_review/analysis');
		
		elgg_register_js('code_review', elgg_get_config('wwwroot') . 'mod/'
			. __CLASS__ . '/views/default/js/code_review.js');
	}

	/**
	 * @codeCoverageIgnore
	 */
	public static function pagesetup() {
		if (elgg_get_context() == 'admin') {
			elgg_register_menu_item('page', array(
				'name' => 'code/diagnostic',
				'href' => 'admin/code/diagnostic',
				'text' => elgg_echo('admin:code:diagnostic'),
				'context' => 'admin',
				'section' => 'develop'
			));
		}
	}

	/**
	 * @codeCoverageIgnore
	 */
	public static function menu_register() {
		$result = array();
		$result[] = ElggMenuItem::factory(array(
			'name' => 'admin/code/diagnostic',
			'href' => 'admin/code/diagnostic',
			'text' => elgg_echo('admin:code:diagnostic'),
		));
		$result[] = ElggMenuItem::factory(array(
			'name' => 'admin/code/diagnostic/deprecated_list',
			'href' => 'admin/code/diagnostic/deprecated_list',
			'text' => elgg_echo('admin:code:diagnostic:deprecated_list'),
//			'target' => '_blank',

		));
		$result[] = ElggMenuItem::factory(array(
			'name' => 'admin/code/diagnostic/private_list',
			'href' => 'admin/code/diagnostic/private_list',
			'text' => elgg_echo('admin:code:diagnostic:private_list'),
//			'target' => '_blank',

		));
		$result[] = ElggMenuItem::factory(array(
			'name' => 'admin/code/diagnostic/functions_list',
			'href' => 'admin/code/diagnostic/functions_list',
			'text' => elgg_echo('admin:code:diagnostic:functions_list'),
		));
		return $result;
	}

	/**
	 * @param string $subPath
	 * @return RegexIterator
	 */
	public static function getPhpIterator($subPath = '/') {
		$i = new RecursiveDirectoryIterator(self::$config['engine_path'] . $subPath, RecursiveDirectoryIterator::SKIP_DOTS);
		$i = new RecursiveIteratorIterator($i, RecursiveIteratorIterator::LEAVES_ONLY);
		$i = new RegexIterator($i, "/.*\.php/");
		return $i;
	}

	public static function getVersionsList() {
		$i = self::getPhpIterator('lib/');
		$i = new RegexIterator($i, "/deprecated-.*/");
		
		$vv = array();
		
		foreach ($i as $file) {
			if ($file instanceof SplFileInfo) {
				if (preg_match('#^deprecated-([0-9\.]*)$#', $file->getBasename('.php'), $matches)) {
					$version = $matches[1];
				} else {
					$version = null;
				}
				if ($version !== null) {
					$vv[] = $version;
				}
			}
		}
		usort($vv, 'version_compare');
		return $vv;
	}

	/**
	 * @val string
	 */
	const DEPRECATED_TAG_PREFIX = 'deprecated';


	/**
	 * @val string
	 */
	const PRIVATE_TAG_PREFIX = 'private';

	/**
	 * Filtering predicate
	 *
	 * @param $e
	 * @return bool
	 */
	public static function filterTagsByDeprecatedPrefix($e) {
		return strpos($e, self::DEPRECATED_TAG_PREFIX) === 0;
	}

	/**
	 * Filtering predicate
	 *
	 * @param $e
	 * @return bool
	 */
	public static function filterTagsByPrivatePrefix($e) {
		return strpos($e, self::PRIVATE_TAG_PREFIX) === 0;
	}

	private static function getDeprecatedInfoFromDocBlock($deprecatedInfo, $maxVersion) {
		if (strpos($deprecatedInfo, '@' . self::DEPRECATED_TAG_PREFIX) === false){
			return false;
		} else {
			$deprecatedInfo = explode('* @', $deprecatedInfo);
			$deprecatedInfo = array_filter($deprecatedInfo, array(__CLASS__, 'filterTagsByDeprecatedPrefix'));
			$deprecatedInfo = array_shift($deprecatedInfo);
			$deprecatedInfo = substr($deprecatedInfo, strlen(self::DEPRECATED_TAG_PREFIX));

			//strip leading whitechars and stars and closing tags
			$deprecatedInfo = preg_replace('#\n\s*(?:\*\/?\s*)+#', "\n", $deprecatedInfo);
			//save and strip leading version info
			$version = null;
			preg_match('#^\s*([0-9]+\.[0-9]+)#', $deprecatedInfo, $matches);
			if ($matches) {

				$version = $matches[1];
			}
			$deprecatedInfo = preg_replace('#\s*[0-9](?:\.[0-9]+){1,2}\.?\s*#', "", $deprecatedInfo);
			//strip embedded @link docblock entries
			$deprecatedInfo = preg_replace('#\{\@[a-z]+\s([^\}]+)\}#', '$1', $deprecatedInfo);
			//trim possible whitechars at the end
			$deprecatedInfo = trim($deprecatedInfo);

			$shortDeprecatedInfo = $deprecatedInfo;
			if (($pos = strpos($shortDeprecatedInfo, "\n")) !== false) {
				$shortDeprecatedInfo = substr($shortDeprecatedInfo, 0, $pos);
			}

			$result = array(
				'deprecated' => true,
//				'fixinfo' => strlen($deprecatedInfo) > 0 ? $deprecatedInfo : false,

				'fixinfoshort' => strlen($shortDeprecatedInfo) > 0 ? $shortDeprecatedInfo : false,
			);
			if ($version !== null) {
				//skip versions higher than selected
				if ($maxVersion && version_compare($version, $maxVersion) > 0) {
					return false;
				}
				$result['version'] = $version;
			}
			return $result;
		}
	}

	private static function getPrivateInfoFromDocBlock($privateInfo) {

		if (strpos($privateInfo, '@' . self::PRIVATE_TAG_PREFIX) === false){
			return false;
		} else {
			$result = array(
				'private' => true
			);
			return $result;
		}
	}

	/**
	 * @param string $maxVersion
	 * @return array
	 */
	public static function getDeprecatedFunctionsList($maxVersion = '') {
		$i1 = self::getPhpIterator('lib/');
		$i1 = new RegexIterator($i1, "/deprecated-.*/");
		$i2 = self::getPhpIterator('classes/');

		$i = new AppendIterator();
		$i->append($i1);
		$i->append($i2);
		
		$functs = array();
		
		foreach ($i as $file) {
			if ($file instanceof SplFileInfo) {
				if (preg_match('#^deprecated-([0-9\.]*)$#', $file->getBasename('.php'), $matches)) {
					$version = $matches[1];
				} else {
					$version = null;
				}
				
				//skip versions higher than selected
				if ($maxVersion && $version !== null && version_compare($version, $maxVersion) > 0) {
					continue;
				}

				$tokens = new PhpFileParser($file->getPathname());
				$functs = array_merge($functs, self::getDeprecatedFunctionsFromTokens($tokens, $file, $version, $maxVersion));
			}
		}
		return $functs;
	}

	/**
	 * @param string $maxVersion
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
	 * @return array
	 */
	public static function getPrivateFunctionsList() {
		$i1 = new DirectoryIterator(self::$config['engine_path'] . 'lib/');
		$i1 = new RegexIterator($i1, "/.*\.php/");
		$i2 = self::getPhpIterator('classes/');

		$i = new AppendIterator();
		$i->append($i1);
		$i->append($i2);

		$functs = array();

		foreach ($i as $file) {
			if ($file instanceof SplFileInfo) {
				$tokens = new PhpFileParser($file->getPathname());
				$functs = array_merge($functs, self::getPrivateFunctionsFromTokens($tokens, $file));
			}
		}
		return $functs;
	}

	/**
	 * Redurns deprecated functions from particular file.
	 *
	 * @param PhpFileParser $tokens
	 * @param SplFileInfo   $file
	 * @param               $version
	 * @param               $maxVersion max version to return
	 * @return array
	 */
	private static function getDeprecatedFunctionsFromTokens(PhpFileParser $tokens, SplFileInfo $file, $version, $maxVersion) {
		$namespace = '';
		$className = null;
		$functs = array();
		foreach ($tokens as $key => $token) {
			if ($tokens->isEqualToToken(T_INTERFACE, $key)) {
				//we don't process interfaces for deprecated functions
				break;
			}
			if ($tokens->isEqualToToken(T_NAMESPACE, $key)) {
				$pos = $key+2;
				$namespace = '';
				while (isset($tokens[$pos]) && $tokens[$pos] !== ';') {
					$namespace .= $tokens[$pos][1];
						$pos++;
				}
				$namespace = '\\' . $namespace . '\\';
			}
			if ($tokens->isEqualToToken(T_CLASS, $key)) {
				//mark class name for all following functions
				$className = $namespace . $tokens[$key+2][1];
			}

			//TODO we need to filter out closures

			if ($tokens->isEqualToToken(T_FUNCTION, $key)) {
				if ($className !== null) {
					$functionName = $className . '::' . $tokens[$key+2][1];
					try {
						$reflection = new ReflectionMethod($className, $tokens[$key+2][1]);
					} catch (ReflectionException $e) {
//						var_dump($className, $functionName, $e->getMessage());

						continue;
					}

				} else {
					$functionName = $tokens[$key+2][1];
					try {
						$reflection = new ReflectionFunction($functionName);
					} catch (ReflectionException $e) {
//						var_dump($functionName, $e->getMessage());

						continue;
					}
				}

				//check if non empty version and try go guess
				$data = array(
					'name' => $functionName,
					'version' => $version,
					'file' => $file->getPathname(),
					'line' => $token[2],
				);

				$docBlock = $reflection->getDocComment();
				if ($docBlock) {
					$info = self::getDeprecatedInfoFromDocBlock($docBlock, $maxVersion);
					if (!$info) {
						if ($version) {
							// no details, but we have version, so everything is deprecated here
							$info = array(
								'deprecated' => true,
								'version' => $version,
								'fixinfoshort' => false,
							);
						} else {
							//skipping - not deprecated
							continue;
						}
					}
					$data = array_merge($data, $info);
				}

				$functs[strtolower($functionName)] = new CodeReview_Issues_Deprecated($data);
			}
		}
		return $functs;
	}

	/**
	 * Redurns deprecated functions from particular file.
	 *
	 * @param PhpFileParser $tokens
	 * @param SplFileInfo   $file
	 * @param               $version
	 * @return array
	 */
	private static function getPrivateFunctionsFromTokens(PhpFileParser $tokens, SplFileInfo $file) {
		$namespace = '';
		$className = null;
		$functs = array();
		foreach ($tokens as $key => $token) {
			if ($tokens->isEqualToToken(T_INTERFACE, $key)) {
				//we don't process interfaces for deprecated functions
				break;
			}
			if ($tokens->isEqualToToken(T_NAMESPACE, $key)) {
				$pos = $key+2;
				$namespace = '';
				while (isset($tokens[$pos]) && $tokens[$pos] !== ';') {
					$namespace .= $tokens[$pos][1];
					$pos++;
				}
				$namespace = '\\' . $namespace . '\\';
			}
			if ($tokens->isEqualToToken(T_CLASS, $key)) {
				//mark class name for all following functions
				$className = $namespace . $tokens[$key+2][1];
			}

			if ($tokens->isEqualToToken(T_FUNCTION, $key)) {
				if ($className !== null) {
					$functionName = $className . '::' . $tokens[$key+2][1];
					try {
						$reflection = new ReflectionMethod($className, $tokens[$key+2][1]);
					} catch (ReflectionException $e) {
						break;
					}
				} else {
					$functionName = $tokens[$key+2][1];
					try {
						$reflection = new ReflectionFunction($functionName);
					} catch (ReflectionException $e) {
						break;
					}
				}

				//check if non empty version and try go guess
				$data = array(
					'name' => $functionName,
					'file' => $file->getPathname(),
					'line' => $token[2],
				);

				$docBlock = $reflection->getDocComment();
				if ($docBlock) {
					if (preg_match('/@access\s+private/', $docBlock) < 1) {
						//skipping - not private
						continue;
					}
					$data = new CodeReview_Issues_Private($data);
				} else {
					//non documented means private
					$data = new CodeReview_Issues_NotDocumented($data);
				}

				$functs[strtolower($functionName)] = $data;
			}
		}
		return $functs;
	}

	/**
	 * Returns a list of plugin directory names from a base directory.
	 * Copied from 1.9 core due to elgg_get_plugin_ids_in_dir removal in 1.9
	 *
	 * @param string $dir A dir to scan for plugins. Defaults to config's plugins_path.
	 *                    Must have a trailing slash.
	 *
	 * @return array Array of directory names (not full paths)
	 */
	public static function getPluginDirsInDir($dir = null) {
		if ($dir === null) {
			$dir = self::$config['pluginspath'];
		}

		$plugin_dirs = array();
		$handle = opendir($dir);

		if ($handle) {
			while ($plugin_dir = readdir($handle)) {
				// must be directory and not begin with a .
				if (substr($plugin_dir, 0, 1) !== '.' && is_dir($dir . $plugin_dir)) {
					$plugin_dirs[] = $plugin_dir;
				}
			}
		}

		sort($plugin_dirs);

		return $plugin_dirs;
	}
}

1		<?php
2		/**
3		* Main plugin class.
4		* Storage for various handlers.
5		* @author Paweł Sroka ([email protected])
6		*/
7		class code_review {
		0 ignored issues – show Coding Style Compatibility introduced 2016-05-15 12:57 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
8
9		/**
10		* Config array to allow mocking of configuration.
11		*
12		* @var array
13		*/
14		protected static $config = array();
15
16		/**
17		* @codeCoverageIgnore
18		*/
19		public static function boot() {
20		if (version_compare(elgg_get_version(true), '1.9', '<')) {
21		$autoloader = new CodeReviewAutoloader();
22		$autoloader->register();
23		}
24
25		$enginePath = elgg_get_config('path') . 'engine/';
26		if (function_exists('elgg_get_engine_path')) {
27		$enginePath = elgg_get_engine_path() . '/';
28		}
29		self::initConfig(array(
30		'engine_path' => $enginePath,
31		'path' => elgg_get_config('path'),
32		'pluginspath' => elgg_get_plugins_path(),
33		'plugins_getter' => 'elgg_get_plugins',
34		));
35		}
36
37		/**
38		* @return array
39		*/
40	1	public static function getConfig() {
41	1	return self::$config;
42		}
43
44		/**
45		* @param array $options
46		*
47		* @todo Move into CodeReviewConfig instead
48		*/
49	5	public static function initConfig(array $options) {
50	5	self::$config = $options;
51
52		$names = array(
53	5	'T_NAMESPACE',
54	5	'T_NS_C',
55	5	'T_NS_SEPARATOR',
56	5	);
57
58	5	foreach ($names as $name) {
59	5	if (!defined($name)) {
60		// just define it with value unused by tokenizer to avoid errors on old PHP versions
61		define($name, 10000);
62		}
63	5	}
64	5	}
65
66		/**
67		* @codeCoverageIgnore
68		*/
69		public static function init() {
70
71		elgg_register_event_handler('pagesetup', 'system', array(__CLASS__, 'pagesetup'));
72
73		elgg_register_plugin_hook_handler('register', 'menu:code_review', array(__CLASS__, 'menu_register'));
74
75		elgg_register_ajax_view('graphics/ajax_loader');
76		elgg_register_ajax_view('code_review/analysis');
77
78		elgg_register_js('code_review', elgg_get_config('wwwroot') . 'mod/'
79		. __CLASS__ . '/views/default/js/code_review.js');
80		}
81
82		/**
83		* @codeCoverageIgnore
84		*/
85		public static function pagesetup() {
86		if (elgg_get_context() == 'admin') {
87		elgg_register_menu_item('page', array(
88		'name' => 'code/diagnostic',
89		'href' => 'admin/code/diagnostic',
90		'text' => elgg_echo('admin:code:diagnostic'),
91		'context' => 'admin',
92		'section' => 'develop'
93		));
94		}
95		}
96
97		/**
98		* @codeCoverageIgnore
99		*/
100		public static function menu_register() {
101		$result = array();
102		$result[] = ElggMenuItem::factory(array(
103		'name' => 'admin/code/diagnostic',
104		'href' => 'admin/code/diagnostic',
105		'text' => elgg_echo('admin:code:diagnostic'),
106		));
107		$result[] = ElggMenuItem::factory(array(
108		'name' => 'admin/code/diagnostic/deprecated_list',
109		'href' => 'admin/code/diagnostic/deprecated_list',
110		'text' => elgg_echo('admin:code:diagnostic:deprecated_list'),
111		// 'target' => '_blank',
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-05-15 12:57 UTC by Report Bug Copy Issue Report `58%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
112		));
113		$result[] = ElggMenuItem::factory(array(
114		'name' => 'admin/code/diagnostic/private_list',
115		'href' => 'admin/code/diagnostic/private_list',
116		'text' => elgg_echo('admin:code:diagnostic:private_list'),
117		// 'target' => '_blank',
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-05-15 12:57 UTC by Report Bug Copy Issue Report `58%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
118		));
119		$result[] = ElggMenuItem::factory(array(
120		'name' => 'admin/code/diagnostic/functions_list',
121		'href' => 'admin/code/diagnostic/functions_list',
122		'text' => elgg_echo('admin:code:diagnostic:functions_list'),
123		));
124		return $result;
125		}
126
127		/**
128		* @param string $subPath
129		* @return RegexIterator
130		*/
131	4	public static function getPhpIterator($subPath = '/') {
132	4	$i = new RecursiveDirectoryIterator(self::$config['engine_path'] . $subPath, RecursiveDirectoryIterator::SKIP_DOTS);
133	4	$i = new RecursiveIteratorIterator($i, RecursiveIteratorIterator::LEAVES_ONLY);
134	4	$i = new RegexIterator($i, "/.*\.php/");
135	4	return $i;
136		}
137
138	1	public static function getVersionsList() {
139	1	$i = self::getPhpIterator('lib/');
140	1	$i = new RegexIterator($i, "/deprecated-.*/");
141
142	1	$vv = array();
143
144	1	foreach ($i as $file) {
145	1	if ($file instanceof SplFileInfo) {
146	1	if (preg_match('#^deprecated-([0-9\.]*)$#', $file->getBasename('.php'), $matches)) {
147	1	$version = $matches[1];
148	1	} else {
149		$version = null;
150		}
151	1	if ($version !== null) {
152	1	$vv[] = $version;
153	1	}
154	1	}
155	1	}
156	1	usort($vv, 'version_compare');
157	1	return $vv;
158		}
159
160		/**
161		* @val string
162		*/
163		const DEPRECATED_TAG_PREFIX = 'deprecated';
164
165
166		/**
167		* @val string
168		*/
169		const PRIVATE_TAG_PREFIX = 'private';
170
171		/**
172		* Filtering predicate
173		*
174		* @param $e
175		* @return bool
176		*/
177	2	public static function filterTagsByDeprecatedPrefix($e) {
178	2	return strpos($e, self::DEPRECATED_TAG_PREFIX) === 0;
179		}
180
181		/**
182		* Filtering predicate
183		*
184		* @param $e
185		* @return bool
186		*/
187		public static function filterTagsByPrivatePrefix($e) {
188		return strpos($e, self::PRIVATE_TAG_PREFIX) === 0;
189		}
190
191	2	private static function getDeprecatedInfoFromDocBlock($deprecatedInfo, $maxVersion) {
192	2	if (strpos($deprecatedInfo, '@' . self::DEPRECATED_TAG_PREFIX) === false){
193	2	return false;
194		} else {
195	2	$deprecatedInfo = explode('* @', $deprecatedInfo);
196	2	$deprecatedInfo = array_filter($deprecatedInfo, array(__CLASS__, 'filterTagsByDeprecatedPrefix'));
197	2	$deprecatedInfo = array_shift($deprecatedInfo);
198	2	$deprecatedInfo = substr($deprecatedInfo, strlen(self::DEPRECATED_TAG_PREFIX));
199
200		//strip leading whitechars and stars and closing tags
201	2	$deprecatedInfo = preg_replace('#\n\s(?:\\/?\s*)+#', "\n", $deprecatedInfo);
202		//save and strip leading version info
203	2	$version = null;
204	2	preg_match('#^\s*([0-9]+\.[0-9]+)#', $deprecatedInfo, $matches);
205	2	if ($matches) {
		0 ignored issues – show Bug Best Practice introduced 2016-05-15 12:57 UTC by Report Bug Copy Issue Report The expression `$matches` of type `string[]` 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. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
206	2	$version = $matches[1];
207	2	}
208	2	$deprecatedInfo = preg_replace('#\s[0-9](?:\.[0-9]+){1,2}\.?\s#', "", $deprecatedInfo);
209		//strip embedded @link docblock entries
210	2	$deprecatedInfo = preg_replace('#\{\@[a-z]+\s([^\}]+)\}#', '$1', $deprecatedInfo);
211		//trim possible whitechars at the end
212	2	$deprecatedInfo = trim($deprecatedInfo);
213
214	2	$shortDeprecatedInfo = $deprecatedInfo;
215	2	if (($pos = strpos($shortDeprecatedInfo, "\n")) !== false) {
216		$shortDeprecatedInfo = substr($shortDeprecatedInfo, 0, $pos);
217		}
218
219		$result = array(
220	2	'deprecated' => true,
221		// 'fixinfo' => strlen($deprecatedInfo) > 0 ? $deprecatedInfo : false,
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-05-15 12:57 UTC by Report Bug Copy Issue Report `50%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
222	2	'fixinfoshort' => strlen($shortDeprecatedInfo) > 0 ? $shortDeprecatedInfo : false,
223	2	);
224	2	if ($version !== null) {
225		//skip versions higher than selected
226	2	if ($maxVersion && version_compare($version, $maxVersion) > 0) {
227	1	return false;
228		}
229	2	$result['version'] = $version;
230	2	}
231	2	return $result;
232		}
233		}
234
235		private static function getPrivateInfoFromDocBlock($privateInfo) {
		0 ignored issues – show Unused Code introduced 2016-05-15 12:57 UTC by Report Bug Copy Issue Report This method is not used, and could be removed. Loading history...
236		if (strpos($privateInfo, '@' . self::PRIVATE_TAG_PREFIX) === false){
237		return false;
238		} else {
239		$result = array(
240		'private' => true
241		);
242		return $result;
243		}
244		}
245
246		/**
247		* @param string $maxVersion
248		* @return array
249		*/
250	2	public static function getDeprecatedFunctionsList($maxVersion = '') {
251	2	$i1 = self::getPhpIterator('lib/');
252	2	$i1 = new RegexIterator($i1, "/deprecated-.*/");
253	2	$i2 = self::getPhpIterator('classes/');
254
255	2	$i = new AppendIterator();
256	2	$i->append($i1);
257	2	$i->append($i2);
258
259	2	$functs = array();
260
261	2	foreach ($i as $file) {
262	2	if ($file instanceof SplFileInfo) {
263	2	if (preg_match('#^deprecated-([0-9\.]*)$#', $file->getBasename('.php'), $matches)) {
264	2	$version = $matches[1];
265	2	} else {
266	2	$version = null;
267		}
268
269		//skip versions higher than selected
270	2	if ($maxVersion && $version !== null && version_compare($version, $maxVersion) > 0) {
271	1	continue;
272		}
273
274	2	$tokens = new PhpFileParser($file->getPathname());
275	2	$functs = array_merge($functs, self::getDeprecatedFunctionsFromTokens($tokens, $file, $version, $maxVersion));
276	2	}
277	2	}
278	2	return $functs;
279		}
280
281		/**
282		* @param string $maxVersion
		0 ignored issues – show Bug introduced 2016-05-15 12:57 UTC by Report Bug Copy Issue Report There is no parameter named `$maxVersion`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
283		* @return array
284		*/
285	1	public static function getPrivateFunctionsList() {
286	1	$i1 = new DirectoryIterator(self::$config['engine_path'] . 'lib/');
287	1	$i1 = new RegexIterator($i1, "/.*\.php/");
288	1	$i2 = self::getPhpIterator('classes/');
289
290	1	$i = new AppendIterator();
291	1	$i->append($i1);
292	1	$i->append($i2);
293
294	1	$functs = array();
295
296	1	foreach ($i as $file) {
297	1	if ($file instanceof SplFileInfo) {
298	1	$tokens = new PhpFileParser($file->getPathname());
299	1	$functs = array_merge($functs, self::getPrivateFunctionsFromTokens($tokens, $file));
300	1	}
301	1	}
302	1	return $functs;
303		}
304
305		/**
306		* Redurns deprecated functions from particular file.
307		*
308		* @param PhpFileParser $tokens
309		* @param SplFileInfo $file
310		* @param $version
311		* @param $maxVersion max version to return
312		* @return array
313		*/
314	2	private static function getDeprecatedFunctionsFromTokens(PhpFileParser $tokens, SplFileInfo $file, $version, $maxVersion) {
315	2	$namespace = '';
316	2	$className = null;
317	2	$functs = array();
318	2	foreach ($tokens as $key => $token) {
319	2	if ($tokens->isEqualToToken(T_INTERFACE, $key)) {
320		//we don't process interfaces for deprecated functions
321		break;
322		}
323	2	if ($tokens->isEqualToToken(T_NAMESPACE, $key)) {
324	2	$pos = $key+2;
325	2	$namespace = '';
326	2	while (isset($tokens[$pos]) && $tokens[$pos] !== ';') {
327	2	$namespace .= $tokens[$pos][1];
328	2	$pos++;
329	2	}
330	2	$namespace = '\\' . $namespace . '\\';
331	2	}
332	2	if ($tokens->isEqualToToken(T_CLASS, $key)) {
333		//mark class name for all following functions
334	2	$className = $namespace . $tokens[$key+2][1];
335	2	}
336
337		//TODO we need to filter out closures
338
339	2	if ($tokens->isEqualToToken(T_FUNCTION, $key)) {
340	2	if ($className !== null) {
341	2	$functionName = $className . '::' . $tokens[$key+2][1];
342		try {
343	2	$reflection = new ReflectionMethod($className, $tokens[$key+2][1]);
344	2	} catch (ReflectionException $e) {
345		// var_dump($className, $functionName, $e->getMessage());
		1 ignored issue – show Unused Code Comprehensibility introduced 2016-05-15 15:25 UTC by Report Bug Copy Issue Report `69%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
346		continue;
347		}
348
349	2	} else {
350	1	$functionName = $tokens[$key+2][1];
351		try {
352	1	$reflection = new ReflectionFunction($functionName);
353	1	} catch (ReflectionException $e) {
354		// var_dump($functionName, $e->getMessage());
		1 ignored issue – show Unused Code Comprehensibility introduced 2016-05-15 15:25 UTC by Report Bug Copy Issue Report `70%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
355		continue;
356		}
357		}
358
359		//check if non empty version and try go guess
360		$data = array(
361	2	'name' => $functionName,
362	2	'version' => $version,
363	2	'file' => $file->getPathname(),
364	2	'line' => $token[2],
365	2	);
366
367	2	$docBlock = $reflection->getDocComment();
368	2	if ($docBlock) {
369	2	$info = self::getDeprecatedInfoFromDocBlock($docBlock, $maxVersion);
370	2	if (!$info) {
371	2	if ($version) {
372		// no details, but we have version, so everything is deprecated here
373		$info = array(
374	1	'deprecated' => true,
375	1	'version' => $version,
376	1	'fixinfoshort' => false,
377	1	);
378	1	} else {
379		//skipping - not deprecated
380	2	continue;
381		}
382	1	}
383	2	$data = array_merge($data, $info);
384	2	}
385
386	2	$functs[strtolower($functionName)] = new CodeReview_Issues_Deprecated($data);
387	2	}
388	2	}
389	2	return $functs;
390		}
391
392		/**
393		* Redurns deprecated functions from particular file.
394		*
395		* @param PhpFileParser $tokens
396		* @param SplFileInfo $file
397		* @param $version
398		* @return array
399		*/
400	1	private static function getPrivateFunctionsFromTokens(PhpFileParser $tokens, SplFileInfo $file) {
401	1	$namespace = '';
402	1	$className = null;
403	1	$functs = array();
404	1	foreach ($tokens as $key => $token) {
405	1	if ($tokens->isEqualToToken(T_INTERFACE, $key)) {
406		//we don't process interfaces for deprecated functions
407		break;
408		}
409	1	if ($tokens->isEqualToToken(T_NAMESPACE, $key)) {
410	1	$pos = $key+2;
411	1	$namespace = '';
412	1	while (isset($tokens[$pos]) && $tokens[$pos] !== ';') {
413	1	$namespace .= $tokens[$pos][1];
414	1	$pos++;
415	1	}
416	1	$namespace = '\\' . $namespace . '\\';
417	1	}
418	1	if ($tokens->isEqualToToken(T_CLASS, $key)) {
419		//mark class name for all following functions
420	1	$className = $namespace . $tokens[$key+2][1];
421	1	}
422
423	1	if ($tokens->isEqualToToken(T_FUNCTION, $key)) {
424	1	if ($className !== null) {
425	1	$functionName = $className . '::' . $tokens[$key+2][1];
426		try {
427	1	$reflection = new ReflectionMethod($className, $tokens[$key+2][1]);
428	1	} catch (ReflectionException $e) {
429		break;
430		}
431	1	} else {
432	1	$functionName = $tokens[$key+2][1];
433		try {
434	1	$reflection = new ReflectionFunction($functionName);
435	1	} catch (ReflectionException $e) {
436		break;
437		}
438		}
439
440		//check if non empty version and try go guess
441		$data = array(
442	1	'name' => $functionName,
443	1	'file' => $file->getPathname(),
444	1	'line' => $token[2],
445	1	);
446
447	1	$docBlock = $reflection->getDocComment();
448	1	if ($docBlock) {
449	1	if (preg_match('/@access\s+private/', $docBlock) < 1) {
450		//skipping - not private
451	1	continue;
452		}
453	1	$data = new CodeReview_Issues_Private($data);
454	1	} else {
455		//non documented means private
456	1	$data = new CodeReview_Issues_NotDocumented($data);
457		}
458
459	1	$functs[strtolower($functionName)] = $data;
460	1	}
461	1	}
462	1	return $functs;
463		}
464
465		/**
466		* Returns a list of plugin directory names from a base directory.
467		* Copied from 1.9 core due to elgg_get_plugin_ids_in_dir removal in 1.9
468		*
469		* @param string $dir A dir to scan for plugins. Defaults to config's plugins_path.
470		* Must have a trailing slash.
471		*
472		* @return array Array of directory names (not full paths)
473		*/
474	1	public static function getPluginDirsInDir($dir = null) {
475	1	if ($dir === null) {
476		$dir = self::$config['pluginspath'];
477		}
478
479	1	$plugin_dirs = array();
480	1	$handle = opendir($dir);
481
482	1	if ($handle) {
483	1	while ($plugin_dir = readdir($handle)) {
484		// must be directory and not begin with a .
485	1	if (substr($plugin_dir, 0, 1) !== '.' && is_dir($dir . $plugin_dir)) {
486	1	$plugin_dirs[] = $plugin_dir;
487	1	}
488	1	}
489	1	}
490
491	1	sort($plugin_dirs);
492
493	1	return $plugin_dirs;
494		}
495		}

Srokap / code_review

Push — master ( 238ea5...316830 )

code_review C

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

17 Methods

How to fix Complexity

Complex Class

Duplication Side-by-Side

Filter issues like