ConfigTable::get() - Code Metrics - Inspection of "Merge pull request #11567 from mrclay/11563_routes" - Elgg/Elgg - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( c0a3a7...3b84a4 )

by Jeroen

created 2018-01-08 10:08 UTC

ConfigTable::get() A

↳ Parent: ConfigTable

Complexity

Conditions	2
Paths	2

Size

Total Lines	15
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
cc	2
eloc	7
nc	2
nop	1
dl	0
loc	15
rs	9.4285
c	0
b	0
f	0
ccs	0
cts	7
cp	0
crap	6

<?php
namespace Elgg\Database;

/**
 * Manipulates values in the dbprefix_config table. Do not use to read/write $CONFIG.
 *
 * WARNING: API IN FLUX. DO NOT USE DIRECTLY.
 *
 * @access private
 * @since  1.10.0
 */
class ConfigTable {
		
	/**
	 * @var \Elgg\Database
	 */
	protected $db;
	
	/**
	 * @var \Elgg\BootService
	 */
	protected $boot;
	
	/**
	 * @var \Elgg\Logger
	 */
	protected $logger;

	/**
	 * Constructor
	 *
	 * @param \Elgg\Database    $db     Database
	 * @param \Elgg\BootService $boot   BootService
	 * @param \Elgg\Logger      $logger Logger
	 */
	public function __construct(\Elgg\Database $db, \Elgg\BootService $boot, \Elgg\Logger $logger) {
		$this->db = $db;
		$this->boot = $boot;
		$this->logger = $logger;
	}

	/**
	 * Removes a config setting.
	 *
	 * @param string $name The name of the field.
	 *
	 * @return bool Success or failure
	 */
	function remove($name) {

		$query = "
			DELETE FROM {$this->db->prefix}config
			WHERE name = :name
		";

		$params = [
			':name' => $name,
		];
		
		$this->boot->invalidateCache();
	
		return $this->db->deleteData($query, $params) !== false;
	}
	
	/**
	 * Add or update a config setting.
	 *
	 * Plugin authors should use elgg_save_config().
	 *
	 * If the config name already exists, it will be updated to the new value.
	 *
	 * @note Internal: These settings are stored in the dbprefix_config table and read
	 * during system boot into the config service.
	 *
	 * @note Internal: The value is serialized so we maintain type information.
	 *
	 * @param string $name  The name of the configuration value
	 * @param mixed  $value Its value
	 *
	 * @return bool
	 */
	function set($name, $value) {

		// cannot store anything longer than 255 characters in db, so catch before we set
		if (elgg_strlen($name) > 255) {
			$this->logger->error("The name length for configuration variables cannot be greater than 255");
			return false;
		}
	
		$sql = "
			INSERT INTO {$this->db->prefix}config
			SET name = :name,
				value = :value
			ON DUPLICATE KEY UPDATE value = :value
		";
		
		$params = [
			':name' => $name,
			':value' => serialize($value),
		];
				
		$result = $this->db->insertData($sql, $params);

		$this->boot->invalidateCache();
	
		return $result !== false;
	}
	
	/**
	 * Gets a configuration value
	 *
	 * Plugin authors should use elgg_get_config().
	 *
	 * @note Internal: These settings are stored in the dbprefix_config table and read
	 * during system boot into the config service.
	 *
	 * @param string $name The name of the config value
	 *
	 * @return mixed|null
	 */
	function get($name) {

		$sql = "
			SELECT value
			FROM {$this->db->prefix}config
			WHERE name = :name
		";
			
		$params[':name'] = $name;

		
		$result = $this->db->getDataRow($sql, null, $params);
		if ($result) {

			return unserialize($result->value);
		}
	
		return null;
	}

	/**
	 * Load all config values from the config table (and datalists if not yet
	 * upgraded to 3.0)
	 *
	 * @todo move into BootData once we no longer have to support the 2.x schema
	 *
	 * @return array
	 */
	public function getAll() {
		$values = [];

		$sql = "
			SELECT *
			FROM {$this->db->prefix}config
		";
		foreach ($this->db->getData($sql) as $row) {
			$values[$row->name] = unserialize($row->value);
		}

		if (!array_key_exists('installed', $values)) {
			// try to fetch from old pre 3.0 datalists table
			// need to do this to be able to perform an upgrade from 2.x to 3.0
			try {
				$sql = "
					SELECT *
					FROM {$this->db->prefix}datalists
				";
				foreach ($this->db->getData($sql) as $row) {
					$value = $row->value;
					if ($row->name == 'processed_upgrades') {
						// config table already serializes data so no need to double serialize
						$value = unserialize($value);
					}
					$values[$row->name] = $value;
				}
			} catch (\Exception $e) {

			}
		}

		// don't pull in old config values
		/**
		 * @see \Elgg\Config::__construct sets this
		 */
		unset($values['path']);
		unset($values['dataroot']);
		unset($values['default_site']);

		return $values;
	}
}


1		<?php
2		namespace Elgg\Database;
3
4		/**
5		* Manipulates values in the dbprefix_config table. Do not use to read/write $CONFIG.
6		*
7		* WARNING: API IN FLUX. DO NOT USE DIRECTLY.
8		*
9		* @access private
10		* @since 1.10.0
11		*/
12		class ConfigTable {
13
14		/**
15		* @var \Elgg\Database
16		*/
17		protected $db;
18
19		/**
20		* @var \Elgg\BootService
21		*/
22		protected $boot;
23
24		/**
25		* @var \Elgg\Logger
26		*/
27		protected $logger;
28
29		/**
30		* Constructor
31		*
32		* @param \Elgg\Database $db Database
33		* @param \Elgg\BootService $boot BootService
34		* @param \Elgg\Logger $logger Logger
35		*/
36	4417	public function __construct(\Elgg\Database $db, \Elgg\BootService $boot, \Elgg\Logger $logger) {
37	4417	$this->db = $db;
38	4417	$this->boot = $boot;
39	4417	$this->logger = $logger;
40	4417	}
41
42		/**
43		* Removes a config setting.
44		*
45		* @param string $name The name of the field.
46		*
47		* @return bool Success or failure
48		*/
49	7	function remove($name) {
		0 ignored issues – show Best Practice introduced 2017-10-16 06:19 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
50		$query = "
51	7	DELETE FROM {$this->db->prefix}config
52		WHERE name = :name
53		";
54
55		$params = [
56	7	':name' => $name,
57		];
58
59	7	$this->boot->invalidateCache();
60
61	7	return $this->db->deleteData($query, $params) !== false;
62		}
63
64		/**
65		* Add or update a config setting.
66		*
67		* Plugin authors should use elgg_save_config().
68		*
69		* If the config name already exists, it will be updated to the new value.
70		*
71		* @note Internal: These settings are stored in the dbprefix_config table and read
72		* during system boot into the config service.
73		*
74		* @note Internal: The value is serialized so we maintain type information.
75		*
76		* @param string $name The name of the configuration value
77		* @param mixed $value Its value
78		*
79		* @return bool
80		*/
81	6	function set($name, $value) {
		0 ignored issues – show Best Practice introduced 2017-10-16 06:19 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
82		// cannot store anything longer than 255 characters in db, so catch before we set
83	6	if (elgg_strlen($name) > 255) {
84		$this->logger->error("The name length for configuration variables cannot be greater than 255");
85		return false;
86		}
87
88		$sql = "
89	6	INSERT INTO {$this->db->prefix}config
90		SET name = :name,
91		value = :value
92		ON DUPLICATE KEY UPDATE value = :value
93		";
94
95		$params = [
96	6	':name' => $name,
97	6	':value' => serialize($value),
98		];
99
100	6	$result = $this->db->insertData($sql, $params);
101
102	6	$this->boot->invalidateCache();
103
104	6	return $result !== false;
105		}
106
107		/**
108		* Gets a configuration value
109		*
110		* Plugin authors should use elgg_get_config().
111		*
112		* @note Internal: These settings are stored in the dbprefix_config table and read
113		* during system boot into the config service.
114		*
115		* @param string $name The name of the config value
116		*
117		* @return mixed\|null
118		*/
119		function get($name) {
		0 ignored issues – show Best Practice introduced 2017-10-16 06:19 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
120		$sql = "
121		SELECT value
122		FROM {$this->db->prefix}config
123		WHERE name = :name
124		";
125
126		$params[':name'] = $name;
		0 ignored issues – show Comprehensibility Best Practice introduced 2017-10-16 06:19 UTC by Report Bug Copy Issue Report `$params` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$params = array();` before regardless. Loading history...
127
128		$result = $this->db->getDataRow($sql, null, $params);
129		if ($result) {
		0 ignored issues – show Bug Best Practice introduced 2017-10-16 06:19 UTC by Report Bug Copy Issue Report The expression `$result` of type `array` 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...
130		return unserialize($result->value);
131		}
132
133		return null;
134		}
135
136		/**
137		* Load all config values from the config table (and datalists if not yet
138		* upgraded to 3.0)
139		*
140		* @todo move into BootData once we no longer have to support the 2.x schema
141		*
142		* @return array
143		*/
144	13	public function getAll() {
145	13	$values = [];
146
147		$sql = "
148		SELECT *
149	13	FROM {$this->db->prefix}config
150		";
151	13	foreach ($this->db->getData($sql) as $row) {
152	13	$values[$row->name] = unserialize($row->value);
153		}
154
155	13	if (!array_key_exists('installed', $values)) {
156		// try to fetch from old pre 3.0 datalists table
157		// need to do this to be able to perform an upgrade from 2.x to 3.0
158		try {
159		$sql = "
160		SELECT *
161		FROM {$this->db->prefix}datalists
162		";
163		foreach ($this->db->getData($sql) as $row) {
164		$value = $row->value;
165		if ($row->name == 'processed_upgrades') {
166		// config table already serializes data so no need to double serialize
167		$value = unserialize($value);
168		}
169		$values[$row->name] = $value;
170		}
171		} catch (\Exception $e) {
		0 ignored issues – show Coding Style Comprehensibility introduced 2017-10-16 06:19 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
172		}
173		}
174
175		// don't pull in old config values
176		/**
177		* @see \Elgg\Config::__construct sets this
178		*/
179	13	unset($values['path']);
180	13	unset($values['dataroot']);
181	13	unset($values['default_site']);
182
183	13	return $values;
184		}
185		}
186

Elgg / Elgg

Push — master ( c0a3a7...3b84a4 )

ConfigTable::get() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like