Setting::enableCaching() - Code Metrics - Inspection of "Implementing updates based on GitHub comments. Upd..." - bradcornford/Setter - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 8d8ea9...818c04 )

by Bradley

created 2016-05-03 12:13 UTC

Setting::enableCaching() A

↳ Parent: Setting

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	0

<?php namespace Cornford\Setter;

use Cornford\Setter\Contracts\CacheableInterface;
use Cornford\Setter\Contracts\SettableInterface;
use Cornford\Setter\Exceptions\SettingArgumentException;
use DateTime;

class Setting extends SettingBase implements SettableInterface, CacheableInterface {

	/**
	 * Set a setting by key and value
	 *
	 * @param string  $key
	 * @param string  $value
	 *
	 * @return boolean
	 */
	public function set($key, $value)
	{
		$query = $this->database

			->table('settings');
		$value = json_encode($value);

		if ($this->has($key)) {
			$result = $query->where('key', $key)
				->update(array('value' => $value));
		} else {
			$result = $query->insert(array('key' => $key, 'value' => $value));
		}

		if ($this->cacheEnabled()) {
			$this->recacheItem($value, $key);
		}

		return $result ? true : false;
	}

	/**
	 * Get a setting by key, optionally set a default or fallback to config lookup
	 *
	 * @param string  $key
	 * @param string  $default
	 *
	 * @return string|array|boolean
	 */
	public function get($key, $default = null)
	{
		if ($this->cacheEnabled() && $this->cacheHas($this->attachCacheTag($key))) {
			return $this->returnCache($key);
		}

		$results = $this->database

			->table('settings')
			->where('settings.key', '=', $key)
			->whereRaw('settings.key LIKE "' . $key . '.%"', array(), 'or')
			->lists('value', 'key');

		if ($results) {
			return $this->returnResults($results, $key);
		}

		if ($default) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
			return $default;
		}

		if ($this->configHas($key)) {
			return $this->returnConfig($key);
		}

		return false;
	}

	/**
	 * Forget a setting by key
	 *
	 * @param string $key
	 *
	 * @return boolean
	 */
	public function forget($key)
	{
		$result = $this->database

			->table('settings')
			->where('key', '=', $key)
			->delete();

		if ($this->cacheEnabled() && $this->cacheHas($this->attachCacheTag($key))) {
			$this->cache
				->forget($this->attachCacheTag($key));
		}

		return $result ? true : false;
	}

	/**
	 * Check a setting exists by key
	 *
	 * @param string $key
	 *
	 * @return boolean
	 */
	public function has($key)
	{
		if ($this->cacheEnabled() && $this->cacheHas($this->attachCacheTag($key))) {
			$result = true;
		} else {
			$result = $this->database

				->table('settings')
				->select('settings.value')
				->where('settings.key', '=', $key)
				->count();
		}

		return ($result ? true : false);
	}

	/**
	 * Get all stored settings
	 *
	 * @return array
	 */
	public function all()
	{
		$results = $this->database

			->table('settings')
			->lists('value', 'key');

		return $this->arrangeResults($results);
	}

	/**
	 * Clear all stored settings
	 *
	 * @return boolean
	 */
	public function clear()
	{
		$result = $this->database

			->table('settings')
			->truncate();

		if ($this->cacheEnabled()) {
			$this->cacheClear();			
		}

		return $result ? true : false;
	}

	/**
	 * Set the expiry
	 *
	 * @param boolean|integer|Datetime $expiry
	 *
	 * @throws SettingArgumentException
	 *
	 * @return self
	 */
	public function expires($expiry)
	{
		$this->cacheExpires($expiry);

		return $this;
	}

	/**
	 * Cache enabled?
	 *
	 * @return boolean
	 */
	public function cacheEnabled()
	{
		return ($this->getCacheEnabled() === true);
	}

	/**
	 * Enable caching.
	 *
	 * @return void
	 */
	public function enableCache()
	{
		$this->setCacheEnabled(true);
	}

	/**
	 * Disable caching.
	 *
	 * @return void
	 */
	public function disableCache()
	{
		$this->setCacheEnabled(false);
	}

	/**
	 * Set the cache expiry
	 *
	 * @param boolean|integer|Datetime $expiry
	 *
	 * @throws SettingArgumentException
	 *
	 * @return self
	 */
	public function cacheExpires($expiry)

	{
		if (!is_bool($expiry) && !is_integer($expiry) && !$expiry instanceof DateTime) {
			throw new SettingArgumentException('Expiry is required in boolean, integer or DateTime format.');
		}

		$this->cacheExpiry = $expiry;

		return $this;
	}

}


1		<?php namespace Cornford\Setter;
2
3		use Cornford\Setter\Contracts\CacheableInterface;
4		use Cornford\Setter\Contracts\SettableInterface;
5		use Cornford\Setter\Exceptions\SettingArgumentException;
6		use DateTime;
7
8		class Setting extends SettingBase implements SettableInterface, CacheableInterface {
9
10		/**
11		* Set a setting by key and value
12		*
13		* @param string $key
14		* @param string $value
15		*
16		* @return boolean
17		*/
18		public function set($key, $value)
19		{
20		$query = $this->database
		0 ignored issues – show Bug introduced 2016-05-03 11:44 UTC by Report Bug Copy Issue Report The property `database` does not seem to exist. Did you mean `databaseInstance`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
21		->table('settings');
22		$value = json_encode($value);
23
24		if ($this->has($key)) {
25		$result = $query->where('key', $key)
26		->update(array('value' => $value));
27		} else {
28		$result = $query->insert(array('key' => $key, 'value' => $value));
29		}
30
31		if ($this->cacheEnabled()) {
32		$this->recacheItem($value, $key);
33		}
34
35		return $result ? true : false;
36		}
37
38		/**
39		* Get a setting by key, optionally set a default or fallback to config lookup
40		*
41		* @param string $key
42		* @param string $default
43		*
44		* @return string\|array\|boolean
45		*/
46		public function get($key, $default = null)
47		{
48		if ($this->cacheEnabled() && $this->cacheHas($this->attachCacheTag($key))) {
49		return $this->returnCache($key);
50		}
51
52		$results = $this->database
		0 ignored issues – show Bug introduced 2016-05-03 11:44 UTC by Report Bug Copy Issue Report The property `database` does not seem to exist. Did you mean `databaseInstance`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
53		->table('settings')
54		->where('settings.key', '=', $key)
55		->whereRaw('settings.key LIKE "' . $key . '.%"', array(), 'or')
56		->lists('value', 'key');
57
58		if ($results) {
59		return $this->returnResults($results, $key);
60		}
61
62		if ($default) {
		0 ignored issues – show Bug Best Practice introduced 2016-05-03 11:44 UTC by Report Bug Copy Issue Report The expression `$default` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
63		return $default;
64		}
65
66		if ($this->configHas($key)) {
67		return $this->returnConfig($key);
68		}
69
70		return false;
71		}
72
73		/**
74		* Forget a setting by key
75		*
76		* @param string $key
77		*
78		* @return boolean
79		*/
80		public function forget($key)
81		{
82		$result = $this->database
		0 ignored issues – show Bug introduced 2016-05-03 11:44 UTC by Report Bug Copy Issue Report The property `database` does not seem to exist. Did you mean `databaseInstance`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
83		->table('settings')
84		->where('key', '=', $key)
85		->delete();
86
87		if ($this->cacheEnabled() && $this->cacheHas($this->attachCacheTag($key))) {
88		$this->cache
89		->forget($this->attachCacheTag($key));
90		}
91
92		return $result ? true : false;
93		}
94
95		/**
96		* Check a setting exists by key
97		*
98		* @param string $key
99		*
100		* @return boolean
101		*/
102		public function has($key)
103		{
104		if ($this->cacheEnabled() && $this->cacheHas($this->attachCacheTag($key))) {
105		$result = true;
106		} else {
107		$result = $this->database
		0 ignored issues – show Bug introduced 2016-05-03 11:44 UTC by Report Bug Copy Issue Report The property `database` does not seem to exist. Did you mean `databaseInstance`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
108		->table('settings')
109		->select('settings.value')
110		->where('settings.key', '=', $key)
111		->count();
112		}
113
114		return ($result ? true : false);
115		}
116
117		/**
118		* Get all stored settings
119		*
120		* @return array
121		*/
122		public function all()
123		{
124		$results = $this->database
		0 ignored issues – show Bug introduced 2016-05-03 11:44 UTC by Report Bug Copy Issue Report The property `database` does not seem to exist. Did you mean `databaseInstance`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
125		->table('settings')
126		->lists('value', 'key');
127
128		return $this->arrangeResults($results);
129		}
130
131		/**
132		* Clear all stored settings
133		*
134		* @return boolean
135		*/
136		public function clear()
137		{
138		$result = $this->database
		0 ignored issues – show Bug introduced 2016-05-03 11:44 UTC by Report Bug Copy Issue Report The property `database` does not seem to exist. Did you mean `databaseInstance`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
139		->table('settings')
140		->truncate();
141
142		if ($this->cacheEnabled()) {
143		$this->cacheClear();
144		}
145
146		return $result ? true : false;
147		}
148
149		/**
150		* Set the expiry
151		*
152		* @param boolean\|integer\|Datetime $expiry
153		*
154		* @throws SettingArgumentException
155		*
156		* @return self
157		*/
158		public function expires($expiry)
159		{
160		$this->cacheExpires($expiry);
161
162		return $this;
163		}
164
165		/**
166		* Cache enabled?
167		*
168		* @return boolean
169		*/
170		public function cacheEnabled()
171		{
172		return ($this->getCacheEnabled() === true);
173		}
174
175		/**
176		* Enable caching.
177		*
178		* @return void
179		*/
180		public function enableCache()
181		{
182		$this->setCacheEnabled(true);
183		}
184
185		/**
186		* Disable caching.
187		*
188		* @return void
189		*/
190		public function disableCache()
191		{
192		$this->setCacheEnabled(false);
193		}
194
195		/**
196		* Set the cache expiry
197		*
198		* @param boolean\|integer\|Datetime $expiry
199		*
200		* @throws SettingArgumentException
201		*
202		* @return self
203		*/
204	View Code Duplication	public function cacheExpires($expiry)
		0 ignored issues – show Duplication introduced 2016-05-03 11:44 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
205		{
206		if (!is_bool($expiry) && !is_integer($expiry) && !$expiry instanceof DateTime) {
207		throw new SettingArgumentException('Expiry is required in boolean, integer or DateTime format.');
208		}
209
210		$this->cacheExpiry = $expiry;
211
212		return $this;
213		}
214
215		}
216

bradcornford / Setter

Push — develop ( 8d8ea9...818c04 )

Setting::enableCaching() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like