Mark LaDoux

Setting Library 2.0.0 Release

I’ve gone ahead and rewrote my CI Setting library. This library works like CI_Config, only it uses a database instead of configuration files to store settings. I made it a separate library, rather than extend the CI core library, because CI_Config loads before the database, and I didn’t want to deal with that mess. This was simpler. I’ve done a solution that added database directly to CI_Config, but it was messy, and less configurable by its very nature. Anyway, here’s the code.

Configuration File:

<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');

$config['table'] = 'settings';

/* End of file setting.php */
/* Location: ./application/config/development/setting.php */

Library:

<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
/**
 * Setting Library
 * 
 * Retrieves settings from a database much like the config library retrieves
 * them from files. Complete rewrite from the old one.
 * 
 * NEW
 * ===
 * 
 * Added overrides so that you can specify configs or options on a case
 * by case basis, allowing you to reuse this library with other controllers
 * and models, which may or may not use the same keywords. Also added the
 * ability to specify an alternative database.
 * 
 * @author    Mark LaDoux
 * @copyright Copyright © 2013 Mark LaDoux
 * @version   2.0.0
 */

class Setting
{
	/**
	 * Config File
	 * 
	 * @access protected
	 * @var    string
	 */
	protected $config_file = null;

	/**
	 * Database table
	 * 
	 * @access protected
	 * @var    string
	 */
	protected $table = null;

	/**
	 * Retrieve object from CodeIgniter instance
	 * 
	 * @param  object $param
	 * @return object
	 */
	public function __get($param)
	{
		$object =& get_instance()->$param;
		return $object;
	}

	/**
	 * Load library dependencies and configurations
	 * 
	 * @access public
	 * @return void
	 */
	public function __construct($cfg = array())
	{
		// check overrides
		if(! is_array($cfg))
		{
			// overrides are formatted incorrectly, show an error.
			show_error(
				"Setting library expects an array for manual configuration", 
				503
			);
		}

		// load database
		if(isset($cfg['database']))
		{
			// allow setting library to be configured to use an alternative
			// database. Please refer to CI user guide on as to what to set
			// to this key.
			$this->load->database($cfg['database']);
		}
		else
		{
			// load database based on default configurations.
			$this->load->database();
		}

		// load configuration
		if(isset($cfg['config_file']))
		{
			// allow for the loading of alternative configurations
			$this->config->load($cfg['config_file'], true, true);
			$this->config_file = $cfg['config_file'];
		}
		else
		{
			// load the default configuration file
			$this->config->load('setting', true, true);
			$this->config_file = 'setting';
		}

		// perform overrides
		if (isset($cfg['table'])) {

			// load overriden value
			$this->table = $cfg['table'];
		}
		else
		{
			// load value from a configuration file.
			$this->table = $this->config->item('table', $this->config_file);
		}

		// check to make sure class is configured
		if($this->table === null)
		{
			show_error(
				"Setting library is not configured!",
				503);
		}
	}

	/**
	 * Retrieve a value from a database
	 * 
	 * @access public
	 * @param  string $key
	 * @return mixed
	 */
	public function get($key, $check = false)
	{
		// select the data
		$this->db->where('item', $key);
		$this->db->limit(1);

		// run the query
		$query = $this->db->get($this->table);

		if($check === true)
		{
			// check results
			$output = ($query->num_rows() > 0) ? true : false;
		}
		else
		{
			// get results
			if($query->num_rows() == 0)
			{
				$output = null;
			}
			else
			{
				$result = $query->row();
				$output = $this->_decode($result->value);
			}
		}

		// free up memory
		$query->free_result();

		// return output
		return $output;
	}

	/**
	 * Prepares data for entry into the database, and determines if it needs
	 * to go through an update or an insert process.
	 * 
	 * @access public
	 * @param  array  $data
	 * @return void
	 */
	public function set($data = array())
	{
		if(! is_array($data))
		{
			show_error('Setting class expects item => value pairs to be in an array',
				503
			);
		}

		// cycle through the values
		foreach ($data as $item => $value) 
		{
			// determine if item exists in DB
			$check = $this->get($item, true);

			// encode value for entry
			$clean = $this->_encode($value);

			if($check)
			{
				// update existing item => value pair
				$this->_update($item, $clean);
			}
			else
			{
				// insert new item => value pair
				$this->_insert($item, $clean);
			}
		}
	}

	/**
	 * Encode data so it can go into the database
	 * 
	 * @access protected
	 * @param  mixed     $data
	 * @return string
	 */
	protected function _encode($data)
	{
		// serialize any arrays
		if(is_array($data))
		{
			$out = serialize($data);
		}

		// transform values that won't enter the database normally
		if($data === false) $out = '{{false}}';
		if($data === true)  $out = '{{true}}';
		if($data === null)  $out = '{{null}}';
		if($data == '')     $out = '{{empty}}';

		// return output
		return $out;
	}

	/**
	 * Decode data retrieved from database
	 * 
	 * @access protected
	 * @param  string    $data
	 * @return mixed
	 */
	protected function _decode($data)
	{
		// unserialize any arrays
		$check = @unserialize($data);
		if(is_array($check)) $out = $check;

		// transform encoded values back into their true values
		if($data == '{{false}}') $out = false;
		if($data == '{{true}}')  $out = true;
		if($data == '{{null}}')  $out = null;
		if($data == '{{empty}}') $out = '';

		// return output
		return $out;
	}

	/**
	 * Insert a new item into the database
	 * 
	 * @access protected
	 * @param  string    $item
	 * @param  string    $value
	 * @return void
	 */
	protected function _insert($item, $value)
	{
		// set key => value pairs
		$data['item']  = $item;
		$data['value'] = $value;

		// insert data into the database
		$this->db->insert($this->table, $data);
	}

	/**
	 * Update the value of an existing item in the database
	 * 
	 * @access protected
	 * @param  string    $item
	 * @param  string    $value
	 * @return void
	 */
	protected function _update($item, $value)
	{
		// set key => value pairs
		$data['value'] = $value;

		// locate the existing record
		$this->db->where('item', $item);

		// update the value
		$this->db->update($this->table, $data);
	}
}

/* End of file setting.php */
/* Location: ./application/libraries/setting.php */

I hearby give permission to use or modify this software however you wish, so long as you retain the copyright and credit me. I do not claim that it’s perfect, and I won’t be held responsible for any problems or damages that it may cause you. If you do find an issue with it, please do share with me. I’ll write up the sql for it later and share it soon, but keep in mind, you only need two fields, one for the item name, and one for the item value.

Tags: CodeIgniter, Development, PHP, Software