Cornford\Setter\Setting

Complexity

Total Complexity

29

Size/Duplication

Total Lines	213
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	set()	0	20	5
B	get()	0	28	7
A	forget()	0	14	4
A	has()	0	14	4
A	all()	0	8	1
A	clear()	0	12	3
A	expires()	0	6	1
A	enableCache()	0	6	1
A	disableCache()	0	6	1
A	uncached()	0	6	1
A	cacheExpires()	0	6	1

<?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;
	}

}