CodeReview\Config

Complexity

Total Complexity

22

Size/Duplication

Total Lines	199
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	1

Test Coverage

Coverage

39.06%

Importance

Changes	1
Bugs	0	Features	0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	__get()	0	3	1
A	getOption()	0	3	2
A	__set()	0	3	1
C	getPluginIds()	0	32	8
A	parseInput()	0	16	1
A	isFixProblemsEnabled()	0	3	1
A	getMaxVersion()	0	7	2
A	getSubPath()	0	3	1
A	isIncludeDisabledPluginsEnabled()	0	3	1
A	isSkipInactivePluginsEnabled()	0	3	1
A	isDeprecatedFunctionsTestEnabled()	0	3	1
A	isPrivateFunctionsTestEnabled()	0	3	1

<?php
namespace CodeReview;

/**
 * Simple configuration container handling basic options parsing nad providing convenient methods.
 */
class Config {

	const T_PLUGINS_ALL = 0;
	const T_PLUGINS_ACTIVE = 1;
	const T_PLUGINS_INACTIVE = 2;

	/**
	 * @var array
	 */
	protected $options = array();

	/**
	 * Selected subdirectory of rootpath to find problems in
	 *
	 * @var string|null
	 */
	protected $subPath = null;

	/**
	 * Maximum version to analyze
	 *
	 * @var string
	 */
	protected $maxVersion = '';

	/**
	 * Should we include disabled plugins within mod/ directory for analysis
	 *
	 * @var bool
	 */
	protected $includeDisabledPlugins = false;

	/**
	 * Should we perform deprecated functions usage search.
	 *
	 * @var bool
	 */
	protected $findDeprecatedFunctions = true;

	/**
	 * Should we perform private functions usage search.
	 *
	 * @var bool
	 */
	protected $findPrivateFunctions = true;

	/**
	 * Should we attempt to fix bad code? THIS IS DANGEROUS OPTION, CAREFUL!
	 *
	 * @var bool
	 */
	protected $fixProblems = false;

	/**
	 * @param array $options
	 */
	public function __construct(array $options = array()) {
		$this->options = (array)$options;
	}

	/**
	 * @param $key
	 * @return mixed
	 */
	public function __get($key) {
		return $this->options[$key];
	}

	/**
	 * @param      $key
	 * @param null $default
	 * @return null
	 */
	public function getOption($key, $default = null) {
		return isset($this->options[$key]) ? $this->options[$key] : $default;
	}

	/**
	 * @param $key
	 * @param $value
	 */
	public function __set($key, $value) {
		$this->options[$key] = $value;
	}

	/**
	 * @param $type
	 * @return array
	 */
	public function getPluginIds($type) {
		$pluginsDirs = false;

		$config = \code_review::getConfig();

		switch ($type) {
			case self::T_PLUGINS_INACTIVE:
				$pluginsDirs = $this->getPluginIds(self::T_PLUGINS_ALL);
				$actives = call_user_func($config['plugins_getter'], 'active');
				foreach ($actives as $plugin) {
					if ($plugin instanceof ElggPlugin) {

The class CodeReview\ElggPlugin does not exist. Did you forget a USE statement, or did you not list all dependencies?

						$pluginsDirs = array_diff($pluginsDirs, array($plugin->getID()));
					} else {
						$pluginsDirs = array_diff($pluginsDirs, array($plugin));
					}
				}
				break;
			case self::T_PLUGINS_ACTIVE:
				$pluginsDirs = call_user_func($config['plugins_getter'], 'active');
				foreach ($pluginsDirs as $key => $plugin) {
					if ($plugin instanceof ElggPlugin) {

The class CodeReview\ElggPlugin does not exist. Did you forget a USE statement, or did you not list all dependencies?

						$pluginsDirs[$key] = $plugin->getID();
					}
				}
				break;
			case self::T_PLUGINS_ALL:
				$pluginsDirs = \code_review::getPluginDirsInDir($config['pluginspath']);
				break;

		}
		return $pluginsDirs;
	}

	/*
	 * Shorthand methods
	 */

	/**
	 * @param array $vars
	 */
	public function parseInput(array $vars) {

		//sanitize provided path
		$subPath = elgg_extract('subpath', $vars, '/');
		$subPath = trim($subPath, '/\\');
		$subPath = str_replace('\\', '/', $subPath);
		$subPath = str_replace('..', '', $subPath);
		$subPath = $subPath . '/';

		$this->subPath = $subPath;
		$this->maxVersion = elgg_extract('version', $vars, '');
		$this->includeDisabledPlugins = elgg_extract('include_disabled_plugins', $vars, false);
		$this->findDeprecatedFunctions = elgg_extract('find_deprecated_functions', $vars, true);
		$this->findPrivateFunctions = elgg_extract('find_private_functions', $vars, true);
		$this->fixProblems = elgg_extract('fix_problems', $vars);
	}

	/**
	 * @return bool
	 */
	public function isFixProblemsEnabled() {
		return (bool)$this->getOption('fixProblems', false);
	}

	/**
	 * @return string
	 */
	public function getMaxVersion() {
		if (!$this->maxVersion) {
			//TODO decouple Elgg core dependency
			return elgg_get_version(true);
		}
		return $this->maxVersion;
	}

	/**
	 * @return string
	 */
	public function getSubPath() {
		return (string)$this->subPath;
	}

	/**
	 * @return bool
	 */
	public function isIncludeDisabledPluginsEnabled() {
		return (bool)$this->getOption('includeDisabledPlugins', false);
	}

	/**
	 * @return bool
	 */
	public function isSkipInactivePluginsEnabled() {
		return !$this->isIncludeDisabledPluginsEnabled();
	}

	/**
	 * @return bool
	 */
	public function isDeprecatedFunctionsTestEnabled() {
		return (bool)$this->getOption('findDeprecatedFunctions', true);
	}

	/**
	 * @return bool
	 */
	public function isPrivateFunctionsTestEnabled() {
		return (bool)$this->getOption('findPrivateFunctions', true);
	}
}