Setting::clear() - Code Metrics - bradcornford/Setter - Measure and Improve Code Quality continuously with Scrutinizer

Setting::clear() A
last analyzed 2020-03-04 09:44 UTC

↳ Parent: Setting

Complexity

Conditions	3
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	12
rs	9.8666
c	0
b	0
f	0
cc	3
nc	4
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->databaseInstance
			->table('settings');
		$value = json_encode($value);

		if ($this->has($key)) {
			$result = $query->where('key', $key)
				->update(array('value' => $value));
			$result = ($result == 0 ? true : $result);
		} 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->getUncached() && $this->cacheEnabled() && $this->cacheHas($key)) {
			return $this->returnCache($key);
		}

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

		$this->setUncached(false);

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

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

		if ($default !== null) {
			return $default;
		}

		return false;
	}

	/**
	 * Forget a setting by key
	 *
	 * @param string $key
	 *
	 * @return boolean
	 */
	public function forget($key)
	{
		$result = $this->databaseInstance
			->table('settings')
			->where('key', '=', $key)
			->delete();

		if ($this->cacheEnabled() && $this->cacheHas($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($key)) {
			$result = true;
		} else {
			$result = $this->databaseInstance
				->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->databaseInstance
			->table('settings')
			->lists('value', 'key');

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

	/**
	 * Clear all stored settings
	 *
	 * @return boolean
	 */
	public function clear()
	{
		$result = $this->databaseInstance
			->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;
	}

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

		return $this;
	}

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

		return $this;
	}

	/**
	 * Sets the uncached flag to request an item from the DB and re-cache the item.
	 *
	 * @return self
	 */
	public function uncached()
	{
		$this->setUncached(true);

		return $this;
	}

	/**
	 * Set the cache expiry
	 *
	 * @param boolean|integer|Datetime $expiry
	 *
	 * @throws SettingArgumentException
	 *
	 * @return self
	 */
	public function cacheExpires($expiry)
	{
		$this->setCacheExpiry($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->databaseInstance
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			$result = ($result == 0 ? true : $result);
28			} else {
29			$result = $query->insert(array('key' => $key, 'value' => $value));
30			}
31
32			if ($this->cacheEnabled()) {
33			$this->recacheItem($value, $key);
34			}
35
36			return $result ? true : false;
37			}
38
39			/**
40			* Get a setting by key, optionally set a default or fallback to config lookup
41			*
42			* @param string $key
43			* @param string $default
44			*
45			* @return string\|array\|boolean
46			*/
47			public function get($key, $default = null)
48			{
49			if (!$this->getUncached() && $this->cacheEnabled() && $this->cacheHas($key)) {
50			return $this->returnCache($key);
51			}
52
53			$results = $this->databaseInstance
54			->table('settings')
55			->where('settings.key', '=', $key)
56			->whereRaw('settings.key LIKE "' . $key . '.%"', array(), 'or')
57			->lists('value', 'key');
58
59			$this->setUncached(false);
60
61			if ($results) {
62			return $this->returnResults($results, $key);
63			}
64
65			if ($this->configHas($key)) {
66			return $this->returnConfig($key);
67			}
68
69			if ($default !== null) {
70			return $default;
71			}
72
73			return false;
74			}
75
76			/**
77			* Forget a setting by key
78			*
79			* @param string $key
80			*
81			* @return boolean
82			*/
83			public function forget($key)
84			{
85			$result = $this->databaseInstance
86			->table('settings')
87			->where('key', '=', $key)
88			->delete();
89
90			if ($this->cacheEnabled() && $this->cacheHas($key)) {
91			$this->cache
92			->forget($this->attachCacheTag($key));
93			}
94
95			return $result ? true : false;
96			}
97
98			/**
99			* Check a setting exists by key
100			*
101			* @param string $key
102			*
103			* @return boolean
104			*/
105			public function has($key)
106			{
107			if ($this->cacheEnabled() && $this->cacheHas($key)) {
108			$result = true;
109			} else {
110			$result = $this->databaseInstance
111			->table('settings')
112			->select('settings.value')
113			->where('settings.key', '=', $key)
114			->count();
115			}
116
117			return ($result ? true : false);
118			}
119
120			/**
121			* Get all stored settings
122			*
123			* @return array
124			*/
125			public function all()
126			{
127			$results = $this->databaseInstance
128			->table('settings')
129			->lists('value', 'key');
130
131			return $this->arrangeResults($results);
132			}
133
134			/**
135			* Clear all stored settings
136			*
137			* @return boolean
138			*/
139			public function clear()
140			{
141			$result = $this->databaseInstance
142			->table('settings')
143			->truncate();
144
145			if ($this->cacheEnabled()) {
146			$this->cacheClear();
147			}
148
149			return $result ? true : false;
150			}
151
152			/**
153			* Set the expiry
154			*
155			* @param boolean\|integer\|Datetime $expiry
156			*
157			* @throws SettingArgumentException
158			*
159			* @return self
160			*/
161			public function expires($expiry)
162			{
163			$this->cacheExpires($expiry);
164
165			return $this;
166			}
167
168			/**
169			* Enable caching.
170			*
171			* @return self
172			*/
173			public function enableCache()
174			{
175			$this->setCacheEnabled(true);
176
177			return $this;
178			}
179
180			/**
181			* Disable caching.
182			*
183			* @return self
184			*/
185			public function disableCache()
186			{
187			$this->setCacheEnabled(false);
188
189			return $this;
190			}
191
192			/**
193			* Sets the uncached flag to request an item from the DB and re-cache the item.
194			*
195			* @return self
196			*/
197			public function uncached()
198			{
199			$this->setUncached(true);
200
201			return $this;
202			}
203
204			/**
205			* Set the cache expiry
206			*
207			* @param boolean\|integer\|Datetime $expiry
208			*
209			* @throws SettingArgumentException
210			*
211			* @return self
212			*/
213			public function cacheExpires($expiry)
214			{
215			$this->setCacheExpiry($expiry);
216
217			return $this;
218			}
219
220			}
221

bradcornford / Setter

Setting::clear() A last analyzed 2020-03-04 09:44 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Setting::clear() A
last analyzed 2020-03-04 09:44 UTC