PrivateSettingsTable::__construct() - 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

PrivateSettingsTable::__construct() A

↳ Parent: PrivateSettingsTable

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	4
nc	1
nop	3
dl	0
loc	5
rs	9.4285
c	0
b	0
f	0
ccs	5
cts	5
cp	1
crap	1

<?php

namespace Elgg\Database;

use DatabaseException;
use Elgg\Database;
use ElggCache;

/**
 * Private settings for entities
 *
 * Private settings provide metadata like storage of settings for plugins
 * and users.
 *
 * WARNING: API IN FLUX. DO NOT USE DIRECTLY.
 *
 * @access private
 * @since 2.0.0
 */
class PrivateSettingsTable {

	/**
	 * @var Database
	 */
	protected $db;

	/**
	 * @var EntityTable
	 */
	protected $entities;

	/**
	 * @var string
	 */
	protected $table;

	/**
	 * @var ElggCache
	 */
	protected $cache;

	/**
	 * Constructor
	 *
	 * @param Database    $db       The database
	 * @param EntityTable $entities Entities table
	 * @param ElggCache   $cache    Settings cache
	 */
	public function __construct(Database $db, EntityTable $entities, ElggCache $cache) {
		$this->db = $db;
		$this->entities = $entities;
		$this->cache = $cache;
		$this->table = $this->db->prefix . 'private_settings';
	}

	/**
	 * Gets a private setting for an entity
	 *
	 * Plugin authors can set private data on entities. By default private
	 * data will not be searched or exported.
	 *
	 * @param int    $entity_guid The entity GUID
	 * @param string $name        The name of the setting
	 *
	 * @return mixed The setting value, or null if does not exist
	 * @throws DatabaseException
	 */
	public function get($entity_guid, $name) {
		$values = $this->cache->load($entity_guid);

		if (isset($values[$name])) {
			return $values[$name];
		}

		if (!$this->entities->exists($entity_guid)) {
			return false;
		}

		$qb = Select::fromTable('private_settings');
		$qb->select('name')
			->addSelect('value')
			->where($qb->compare('name', '=', $name, ELGG_VALUE_STRING))
			->andWhere($qb->compare('entity_guid', '=', $entity_guid, ELGG_VALUE_INTEGER));

		$setting = $this->db->getDataRow($qb);
		if ($setting) {

			return $setting->value;
		}

		return null;
	}

	/**
	 * Return an array of all private settings.
	 *
	 * @param int $entity_guid The entity GUID
	 *
	 * @return string[] empty array if no settings
	 * @throws DatabaseException
	 */
	public function getAll($entity_guid) {
		if (!$this->entities->exists($entity_guid)) {
			return [];
		}

		$values = $this->cache->load($entity_guid);
		if (isset($values)) {
			return $values;
		}

		$qb = Select::fromTable('private_settings');
		$qb->select('name')
			->addSelect('value')
			->where($qb->compare('entity_guid', '=', $entity_guid, ELGG_VALUE_INTEGER));

		$result = $this->db->getData($qb);

		$return = [];

		if ($result) {

			foreach ($result as $r) {
				$return[$r->name] = $r->value;
			}
		}

		$this->cache->save($entity_guid, $return);

		return $return;
	}

	/**
	 * Sets a private setting for an entity.
	 *
	 * @param int    $entity_guid The entity GUID
	 * @param string $name        The name of the setting
	 * @param string $value       The value of the setting
	 *
	 * @return bool
	 * @throws DatabaseException
	 */
	public function set($entity_guid, $name, $value) {
		if (!$this->entities->exists($entity_guid)) {
			return false;
		}

		$this->entities->invalidateCache($entity_guid);

		$qb = Select::fromTable('private_settings');
		$qb->select('id')
			->where($qb->compare('name', '=', $name, ELGG_VALUE_STRING))
			->andWhere($qb->compare('entity_guid', '=', $entity_guid, ELGG_VALUE_INTEGER));

		$row = $this->db->getDataRow($qb);

		if ($row) {

			$qb = Update::table('private_settings');
			$qb->set('value', $qb->param($value, ELGG_VALUE_STRING))
				->where($qb->compare('id', '=', $row->id, ELGG_VALUE_INTEGER));

			$result = $this->db->updateData($qb);
		} else {
			$qb = Insert::intoTable('private_settings');
			$qb->values([
				'entity_guid' => $qb->param($entity_guid, ELGG_VALUE_INTEGER),
				'name' => $qb->param($name, ELGG_VALUE_STRING),
				'value' => $qb->param($value, ELGG_VALUE_STRING),
			]);

			$result = $this->db->insertData($qb);
		}

		return $result !== false;
	}

	/**
	 * Deletes a private setting for an entity.
	 *
	 * @param int    $entity_guid The Entity GUID
	 * @param string $name        The name of the setting
	 *
	 * @return bool
	 * @throws DatabaseException
	 */
	public function remove($entity_guid, $name) {
		$this->entities->invalidateCache($entity_guid);

		$qb = Delete::fromTable('private_settings');
		$qb->where($qb->compare('name', '=', $name, ELGG_VALUE_STRING))
			->andWhere($qb->compare('entity_guid', '=', $entity_guid, ELGG_VALUE_INTEGER));

		return $this->db->deleteData($qb);

	}

	/**
	 * Deletes all private settings for an entity
	 *
	 * @param int $entity_guid The Entity GUID
	 *
	 * @return bool
	 * @throws DatabaseException
	 */
	public function removeAllForEntity($entity_guid) {
		$this->entities->invalidateCache($entity_guid);

		$qb = Delete::fromTable('private_settings');
		$qb->where($qb->compare('entity_guid', '=', $entity_guid, ELGG_VALUE_INTEGER));

		return $this->db->deleteData($qb);

	}

}


1		<?php
2
3		namespace Elgg\Database;
4
5		use DatabaseException;
6		use Elgg\Database;
7		use ElggCache;
8
9		/**
10		* Private settings for entities
11		*
12		* Private settings provide metadata like storage of settings for plugins
13		* and users.
14		*
15		* WARNING: API IN FLUX. DO NOT USE DIRECTLY.
16		*
17		* @access private
18		* @since 2.0.0
19		*/
20		class PrivateSettingsTable {
21
22		/**
23		* @var Database
24		*/
25		protected $db;
26
27		/**
28		* @var EntityTable
29		*/
30		protected $entities;
31
32		/**
33		* @var string
34		*/
35		protected $table;
36
37		/**
38		* @var ElggCache
39		*/
40		protected $cache;
41
42		/**
43		* Constructor
44		*
45		* @param Database $db The database
46		* @param EntityTable $entities Entities table
47		* @param ElggCache $cache Settings cache
48		*/
49	27	public function __construct(Database $db, EntityTable $entities, ElggCache $cache) {
50	27	$this->db = $db;
51	27	$this->entities = $entities;
52	27	$this->cache = $cache;
53	27	$this->table = $this->db->prefix . 'private_settings';
54	27	}
55
56		/**
57		* Gets a private setting for an entity
58		*
59		* Plugin authors can set private data on entities. By default private
60		* data will not be searched or exported.
61		*
62		* @param int $entity_guid The entity GUID
63		* @param string $name The name of the setting
64		*
65		* @return mixed The setting value, or null if does not exist
66		* @throws DatabaseException
67		*/
68	38	public function get($entity_guid, $name) {
69	38	$values = $this->cache->load($entity_guid);
70
71	38	if (isset($values[$name])) {
72		return $values[$name];
73		}
74
75	38	if (!$this->entities->exists($entity_guid)) {
76		return false;
77		}
78
79	38	$qb = Select::fromTable('private_settings');
80	38	$qb->select('name')
81	38	->addSelect('value')
82	38	->where($qb->compare('name', '=', $name, ELGG_VALUE_STRING))
83	38	->andWhere($qb->compare('entity_guid', '=', $entity_guid, ELGG_VALUE_INTEGER));
84
85	38	$setting = $this->db->getDataRow($qb);
86	38	if ($setting) {
		0 ignored issues – show Bug Best Practice introduced 2017-10-16 06:19 UTC by Report Bug Copy Issue Report The expression `$setting` 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...
87	18	return $setting->value;
88		}
89
90	30	return null;
91		}
92
93		/**
94		* Return an array of all private settings.
95		*
96		* @param int $entity_guid The entity GUID
97		*
98		* @return string[] empty array if no settings
99		* @throws DatabaseException
100		*/
101		public function getAll($entity_guid) {
102		if (!$this->entities->exists($entity_guid)) {
103		return [];
104		}
105
106		$values = $this->cache->load($entity_guid);
107		if (isset($values)) {
108		return $values;
109		}
110
111		$qb = Select::fromTable('private_settings');
112		$qb->select('name')
113		->addSelect('value')
114		->where($qb->compare('entity_guid', '=', $entity_guid, ELGG_VALUE_INTEGER));
115
116		$result = $this->db->getData($qb);
117
118		$return = [];
119
120		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...
121		foreach ($result as $r) {
122		$return[$r->name] = $r->value;
123		}
124		}
125
126		$this->cache->save($entity_guid, $return);
127
128		return $return;
129		}
130
131		/**
132		* Sets a private setting for an entity.
133		*
134		* @param int $entity_guid The entity GUID
135		* @param string $name The name of the setting
136		* @param string $value The value of the setting
137		*
138		* @return bool
139		* @throws DatabaseException
140		*/
141	124	public function set($entity_guid, $name, $value) {
142	124	if (!$this->entities->exists($entity_guid)) {
143		return false;
144		}
145
146	124	$this->entities->invalidateCache($entity_guid);
147
148	124	$qb = Select::fromTable('private_settings');
149	124	$qb->select('id')
150	124	->where($qb->compare('name', '=', $name, ELGG_VALUE_STRING))
151	124	->andWhere($qb->compare('entity_guid', '=', $entity_guid, ELGG_VALUE_INTEGER));
152
153	124	$row = $this->db->getDataRow($qb);
154
155	124	if ($row) {
		0 ignored issues – show Bug Best Practice introduced 2017-12-15 18:19 UTC by Report Bug Copy Issue Report The expression `$row` 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...
156	1	$qb = Update::table('private_settings');
157	1	$qb->set('value', $qb->param($value, ELGG_VALUE_STRING))
158	1	->where($qb->compare('id', '=', $row->id, ELGG_VALUE_INTEGER));
159
160	1	$result = $this->db->updateData($qb);
161		} else {
162	124	$qb = Insert::intoTable('private_settings');
163	124	$qb->values([
164	124	'entity_guid' => $qb->param($entity_guid, ELGG_VALUE_INTEGER),
165	124	'name' => $qb->param($name, ELGG_VALUE_STRING),
166	124	'value' => $qb->param($value, ELGG_VALUE_STRING),
167		]);
168
169	124	$result = $this->db->insertData($qb);
170		}
171
172	124	return $result !== false;
173		}
174
175		/**
176		* Deletes a private setting for an entity.
177		*
178		* @param int $entity_guid The Entity GUID
179		* @param string $name The name of the setting
180		*
181		* @return bool
182		* @throws DatabaseException
183		*/
184	3	public function remove($entity_guid, $name) {
185	3	$this->entities->invalidateCache($entity_guid);
186
187	3	$qb = Delete::fromTable('private_settings');
188	3	$qb->where($qb->compare('name', '=', $name, ELGG_VALUE_STRING))
189	3	->andWhere($qb->compare('entity_guid', '=', $entity_guid, ELGG_VALUE_INTEGER));
190
191	3	return $this->db->deleteData($qb);
		0 ignored issues – show Bug Best Practice introduced 2017-12-15 16:24 UTC by Report Bug Copy Issue Report The expression `return $this->db->deleteData($qb)` returns the type `integer` which is incompatible with the documented return type `boolean`. Loading history...
192		}
193
194		/**
195		* Deletes all private settings for an entity
196		*
197		* @param int $entity_guid The Entity GUID
198		*
199		* @return bool
200		* @throws DatabaseException
201		*/
202	213	public function removeAllForEntity($entity_guid) {
203	213	$this->entities->invalidateCache($entity_guid);
204
205	213	$qb = Delete::fromTable('private_settings');
206	213	$qb->where($qb->compare('entity_guid', '=', $entity_guid, ELGG_VALUE_INTEGER));
207
208	213	return $this->db->deleteData($qb);
		0 ignored issues – show Bug Best Practice introduced 2017-12-12 01:22 UTC by Report Bug Copy Issue Report The expression `return $this->db->deleteData($qb)` returns the type `integer` which is incompatible with the documented return type `boolean`. Loading history...
209		}
210
211		}
212

Elgg / Elgg

Push — master ( c0a3a7...3b84a4 )

PrivateSettingsTable::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like