ci-bonfire / Sprint

myth/Mail/Queue.php

Indentation +32 added lines, -32 removed lines

@@ -1,41 +1,41 @@
 <?php namespace Myth\Mail;
 /**
- * Sprint
- *
- * A set of power tools to enhance the CodeIgniter framework and provide consistent workflow.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- * THE SOFTWARE.
- *
- * @package     Sprint
- * @author      Lonnie Ezell
- * @copyright   Copyright 2014-2015, New Myth Media, LLC (http://newmythmedia.com)
- * @license     http://opensource.org/licenses/MIT  (MIT)
- * @link        http://sprintphp.com
- * @since       Version 1.0
- */
+	 * Sprint
+	 *
+	 * A set of power tools to enhance the CodeIgniter framework and provide consistent workflow.
+	 *
+	 * Permission is hereby granted, free of charge, to any person obtaining a copy
+	 * of this software and associated documentation files (the "Software"), to deal
+	 * in the Software without restriction, including without limitation the rights
+	 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+	 * copies of the Software, and to permit persons to whom the Software is
+	 * furnished to do so, subject to the following conditions:
+	 *
+	 * The above copyright notice and this permission notice shall be included in
+	 * all copies or substantial portions of the Software.
+	 *
+	 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+	 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+	 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+	 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+	 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+	 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+	 * THE SOFTWARE.
+	 *
+	 * @package     Sprint
+	 * @author      Lonnie Ezell
+	 * @copyright   Copyright 2014-2015, New Myth Media, LLC (http://newmythmedia.com)
+	 * @license     http://opensource.org/licenses/MIT  (MIT)
+	 * @link        http://sprintphp.com
+	 * @since       Version 1.0
+	 */
 
 use Myth\Models\CIDbModel;
 
 class Queue extends CIDbModel {
 
-    protected $table_name = 'mail_queue';
+	protected $table_name = 'mail_queue';
 
-    protected $set_created = false;
-    protected $set_modified = false;
+	protected $set_created = false;
+	protected $set_modified = false;
 }

myth/Models/CIDbModel.php

Indentation +1449 added lines, -1449 removed lines

@@ -1,34 +1,34 @@ 
 <?php namespace Myth\Models;
 /**
- * Sprint
- *
- * A set of power tools to enhance the CodeIgniter framework and provide consistent workflow.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- * THE SOFTWARE.
- *
- * @package     Sprint
- * @author      Lonnie Ezell
- * @copyright   Copyright 2014-2015, New Myth Media, LLC (http://newmythmedia.com)
- * @license     http://opensource.org/licenses/MIT  (MIT)
- * @link        http://sprintphp.com
- * @since       Version 1.0
- */
+	 * Sprint
+	 *
+	 * A set of power tools to enhance the CodeIgniter framework and provide consistent workflow.
+	 *
+	 * Permission is hereby granted, free of charge, to any person obtaining a copy
+	 * of this software and associated documentation files (the "Software"), to deal
+	 * in the Software without restriction, including without limitation the rights
+	 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+	 * copies of the Software, and to permit persons to whom the Software is
+	 * furnished to do so, subject to the following conditions:
+	 *
+	 * The above copyright notice and this permission notice shall be included in
+	 * all copies or substantial portions of the Software.
+	 *
+	 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+	 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+	 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+	 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+	 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+	 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+	 * THE SOFTWARE.
+	 *
+	 * @package     Sprint
+	 * @author      Lonnie Ezell
+	 * @copyright   Copyright 2014-2015, New Myth Media, LLC (http://newmythmedia.com)
+	 * @license     http://opensource.org/licenses/MIT  (MIT)
+	 * @link        http://sprintphp.com
+	 * @since       Version 1.0
+	 */
 
 //--------------------------------------------------------------------
 
@@ -102,1479 +102,1479 @@ 
 class CIDbModel
 {
 
-    /**
-     * The model's default table name.
-     *
-     * @var string;
-     */
-    protected $table_name;
-
-    /**
-     * The model's default primary key.
-     *
-     * @var string
-     */
-    protected $primary_key = 'id';
-
-    /**
-     * The type of date/time field used for created_on and modified_on fields.
-     * Valid types are: 'int', 'datetime', 'date'
-     *
-     * @var string
-     * @access protected
-     */
-    protected $date_format = 'datetime';
-
-    /*
+	/**
+	 * The model's default table name.
+	 *
+	 * @var string;
+	 */
+	protected $table_name;
+
+	/**
+	 * The model's default primary key.
+	 *
+	 * @var string
+	 */
+	protected $primary_key = 'id';
+
+	/**
+	 * The type of date/time field used for created_on and modified_on fields.
+	 * Valid types are: 'int', 'datetime', 'date'
+	 *
+	 * @var string
+	 * @access protected
+	 */
+	protected $date_format = 'datetime';
+
+	/*
         Var: $log_user
         If TRUE, will log user id for 'created_by', 'modified_by' and 'deleted_by'.
 
         Access:
             Protected
     */
-    protected $log_user = FALSE;
+	protected $log_user = FALSE;
 
 
 
-    /**
-     * Whether or not to auto-fill a 'created_on' field on inserts.
-     *
-     * @var boolean
-     * @access protected
-     */
-    protected $set_created = TRUE;
+	/**
+	 * Whether or not to auto-fill a 'created_on' field on inserts.
+	 *
+	 * @var boolean
+	 * @access protected
+	 */
+	protected $set_created = TRUE;
 
-    /**
-     * Field name to use to the created time column in the DB table.
-     *
-     * @var string
-     * @access protected
-     */
-    protected $created_field = 'created_on';
+	/**
+	 * Field name to use to the created time column in the DB table.
+	 *
+	 * @var string
+	 * @access protected
+	 */
+	protected $created_field = 'created_on';
 
-    /*
+	/*
         Var: $created_by_field
         Field name to use to the created by column in the DB table.
 
         Access:
             Protected
     */
-    protected $created_by_field = 'created_by';
+	protected $created_by_field = 'created_by';
 
 
 
-    /**
-     * Whether or not to auto-fill a 'modified_on' field on updates.
-     *
-     * @var boolean
-     * @access protected
-     */
-    protected $set_modified = TRUE;
+	/**
+	 * Whether or not to auto-fill a 'modified_on' field on updates.
+	 *
+	 * @var boolean
+	 * @access protected
+	 */
+	protected $set_modified = TRUE;
 
-    /**
-     * Field name to use to the modified time column in the DB table.
-     *
-     * @var string
-     * @access protected
-     */
-    protected $modified_field = 'modified_on';
+	/**
+	 * Field name to use to the modified time column in the DB table.
+	 *
+	 * @var string
+	 * @access protected
+	 */
+	protected $modified_field = 'modified_on';
 
-    /*
+	/*
         Var: $modified_by_field
         Field name to use to the modified by column in the DB table.
 
         Access:
             Protected
     */
-    protected $modified_by_field = 'modified_by';
+	protected $modified_by_field = 'modified_by';
 
 
-    /**
-     * Support for soft_deletes.
-     */
-    protected $soft_deletes = FALSE;
-    protected $soft_delete_key = 'deleted';
-    protected $temp_with_deleted = FALSE;
+	/**
+	 * Support for soft_deletes.
+	 */
+	protected $soft_deletes = FALSE;
+	protected $soft_delete_key = 'deleted';
+	protected $temp_with_deleted = FALSE;
 
-    /*
+	/*
         Var: $deleted_by_field
         Field name to use for the deleted by column in the DB table.
 
         Access:
             Protected
     */
-    protected $deleted_by_field = 'deleted_by';
+	protected $deleted_by_field = 'deleted_by';
 
 
 
-    /**
-     * Various callbacks available to the class. They are simple lists of
-     * method names (methods will be ran on $this).
-     */
-    protected $before_insert = array();
-    protected $after_insert = array();
-    protected $before_update = array();
-    protected $after_update = array();
-    protected $before_find = array();
-    protected $after_find = array();
-    protected $before_delete = array();
-    protected $after_delete = array();
+	/**
+	 * Various callbacks available to the class. They are simple lists of
+	 * method names (methods will be ran on $this).
+	 */
+	protected $before_insert = array();
+	protected $after_insert = array();
+	protected $before_update = array();
+	protected $after_update = array();
+	protected $before_find = array();
+	protected $after_find = array();
+	protected $before_delete = array();
+	protected $after_delete = array();
 
-    protected $callback_parameters = array();
+	protected $callback_parameters = array();
 
 
 
-    /*
+	/*
         If TRUE, inserts will return the last_insert_id. However,
         this can potentially slow down large imports drastically
         so you can turn it off with the return_insert_id(false) method.
      */
-    protected $return_insert_id = true;
-
-    /**
-     * By default, we return items as objects. You can change this for the
-     * entire class by setting this value to 'array' instead of 'object'.
-     * Alternatively, you can do it on a per-instance basis using the
-     * 'as_array()' and 'as_object()' methods.
-     */
-    protected $return_type = 'object';
-    protected $temp_return_type = NULL;
-
-    /**
-     * Protected, non-modifiable attributes
-     */
-    protected $protected_attributes = array();
-
-
-
-    /**
-     * An array of validation rules. This needs to be the same format
-     * as validation rules passed to the Form_validation library.
-     */
-    protected $validation_rules = array();
-
-    /**
-     * Optionally skip the validation. Used in conjunction with
-     * skip_validation() to skip data validation for any future calls.
-     */
-    protected $skip_validation = FALSE;
-
-    /**
-     * An array of extra rules to add to validation rules during inserts only.
-     * Often used for adding 'required' rules to fields on insert, but not udpates.
-     *
-     *   array( 'username' => 'required|strip_tags' );
-     * @var array
-     */
-    protected $insert_validate_rules = array();
-
-
-
-    /**
-     * @var Array Columns for the model's database fields
-     *
-     * This can be set to avoid a database call if using $this->prep_data()
-     */
-    protected $fields = array();
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Does basic setup. Can pass the database connection into the constructor
-     * to use that $db instead of the global CI one.
-     *
-     * @param object $db // A database/driver instance
-     * @param object $form_validation // A form_validation library instance
-     */
-    public function __construct($db = null, $form_validation = null)
-    {
-        // Always protect our attributes
-        array_unshift($this->before_insert, 'protect_attributes');
-        array_unshift($this->before_update, 'protect_attributes');
-
-        // Check our auto-set features and make sure they are part of
-        // our observer system.
-        if ($this->set_created === true) array_unshift($this->before_insert, 'created_on');
-        if ($this->set_modified === true) array_unshift($this->before_update, 'modified_on');
-
-        // Make sure our temp return type is correct.
-        $this->temp_return_type = $this->return_type;
-
-        // Make sure our database is loaded
-        if (!is_null($db)) {
-            $this->db = $db;
-        }
-        else {
-            // Auto Init the damn database....
-            $this->load->database();
-        }
-
-        // Do we have a form_validation library?
-        if (! is_null($form_validation)) {
-            $this->form_validation = $form_validation;
-        }
-        else {
-            $this->load->library('form_validation');
-        }
+	protected $return_insert_id = true;
+
+	/**
+	 * By default, we return items as objects. You can change this for the
+	 * entire class by setting this value to 'array' instead of 'object'.
+	 * Alternatively, you can do it on a per-instance basis using the
+	 * 'as_array()' and 'as_object()' methods.
+	 */
+	protected $return_type = 'object';
+	protected $temp_return_type = NULL;
+
+	/**
+	 * Protected, non-modifiable attributes
+	 */
+	protected $protected_attributes = array();
+
+
+
+	/**
+	 * An array of validation rules. This needs to be the same format
+	 * as validation rules passed to the Form_validation library.
+	 */
+	protected $validation_rules = array();
+
+	/**
+	 * Optionally skip the validation. Used in conjunction with
+	 * skip_validation() to skip data validation for any future calls.
+	 */
+	protected $skip_validation = FALSE;
+
+	/**
+	 * An array of extra rules to add to validation rules during inserts only.
+	 * Often used for adding 'required' rules to fields on insert, but not udpates.
+	 *
+	 *   array( 'username' => 'required|strip_tags' );
+	 * @var array
+	 */
+	protected $insert_validate_rules = array();
+
+
+
+	/**
+	 * @var Array Columns for the model's database fields
+	 *
+	 * This can be set to avoid a database call if using $this->prep_data()
+	 */
+	protected $fields = array();
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Does basic setup. Can pass the database connection into the constructor
+	 * to use that $db instead of the global CI one.
+	 *
+	 * @param object $db // A database/driver instance
+	 * @param object $form_validation // A form_validation library instance
+	 */
+	public function __construct($db = null, $form_validation = null)
+	{
+		// Always protect our attributes
+		array_unshift($this->before_insert, 'protect_attributes');
+		array_unshift($this->before_update, 'protect_attributes');
+
+		// Check our auto-set features and make sure they are part of
+		// our observer system.
+		if ($this->set_created === true) array_unshift($this->before_insert, 'created_on');
+		if ($this->set_modified === true) array_unshift($this->before_update, 'modified_on');
+
+		// Make sure our temp return type is correct.
+		$this->temp_return_type = $this->return_type;
+
+		// Make sure our database is loaded
+		if (!is_null($db)) {
+			$this->db = $db;
+		}
+		else {
+			// Auto Init the damn database....
+			$this->load->database();
+		}
+
+		// Do we have a form_validation library?
+		if (! is_null($form_validation)) {
+			$this->form_validation = $form_validation;
+		}
+		else {
+			$this->load->library('form_validation');
+		}
         
-        log_message('debug', 'CIDbModel Class Initialized');
-    }
-
-    //--------------------------------------------------------------------
-
-    //--------------------------------------------------------------------
-    // CRUD Methods
-    //--------------------------------------------------------------------
-
-    /**
-     * A simple way to grab the first result of a search only.
-     */
-    public function first()
-    {
-        $rows = $this->limit(1, 0)->find_all();
-
-        if (is_array($rows) && count($rows)) {
-            return $rows[0];
-        }
-
-        return $rows;
-    }
-
-    //--------------------------------------------------------------------
-
-
-    /**
-     * Finds a single record based on it's primary key. Will ignore deleted rows.
-     *
-     * @param  mixed $id The primary_key value of the object to retrieve.
-     * @return object
-     */
-    public function find($id)
-    {
-        $this->trigger('before_find', ['id' => $id, 'method' => 'find']);
-
-        // Ignore any soft-deleted rows
-        if ($this->soft_deletes) {
-            // We only need to modify the where statement if
-            // temp_with_deleted is false.
-            if ($this->temp_with_deleted !== true) {
-                $this->db->where($this->soft_delete_key, false);
-            }
-
-            $this->temp_with_deleted = false;
-        }
-
-        $this->db->where($this->primary_key, $id);
-        $row = $this->db->get($this->table_name);
-        $row = $this->temp_return_type == 'array' ? $row->row_array() : $row->row(0, $this->temp_return_type);
-
-        if ( ! empty($row))
-        {
-            $row = $this->trigger('after_find', ['id' => $id, 'method' => 'find', 'fields' => $row]);
-        }
-
-        // Reset our return type
-        $this->temp_return_type = $this->return_type;
-
-        return $row;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Fetch a single record based on an arbitrary WHERE call. Can be
-     * any valid value to $this->db->where(). Will not pull in deleted rows
-     * if using soft deletes.
-     *
-     * @return object
-     */
-    public function find_by()
-    {
-        $where = func_get_args();
-        $this->_set_where($where);
-
-        // Ignore any soft-deleted rows
-        if ($this->soft_deletes) {
-            // We only need to modify the where statement if
-            // temp_with_deleted is false.
-            if ($this->temp_with_deleted !== true) {
-                $this->db->where($this->soft_delete_key, false);
-            }
-
-            $this->temp_with_deleted = false;
-        }
-
-        $this->trigger('before_find', ['method' => 'find_by', 'fields' => $where]);
-
-        $row = $this->db->get($this->table_name);
-        $row = $this->temp_return_type == 'array' ? $row->row_array() : $row->row(0, $this->temp_return_type);
-
-        if ( ! empty($row))
-        {
-            $row = $this->trigger('after_find', ['method' => 'find_by', 'fields' => $row]);
-        }
-
-        // Reset our return type
-        $this->temp_return_type = $this->return_type;
-
-        return $row;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Retrieves a number of items based on an array of primary_values passed in.
-     *
-     * @param  array $values An array of primary key values to find.
-     *
-     * @return object or FALSE
-     */
-    public function find_many($values)
-    {
-        $this->db->where_in($this->primary_key, $values);
-
-        return $this->find_all();
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Retrieves a number of items based on an arbitrary WHERE call. Can be
-     * any set of parameters valid to $db->where.
-     *
-     * @return object or FALSE
-     */
-    public function find_many_by()
-    {
-        $where = func_get_args();
-        $this->_set_where($where);
-
-        return $this->find_all();
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Fetch all of the records in the table. Can be used with scoped calls
-     * to restrict the results.
-     *
-     * @return object or FALSE
-     */
-    public function find_all()
-    {
-        $this->trigger('before_find', ['method' => 'find_all']);
-
-        // Ignore any soft-deleted rows
-        if ($this->soft_deletes) {
-            // We only need to modify the where statement if
-            // temp_with_deleted is false.
-            if ($this->temp_with_deleted !== true) {
-                $this->db->where($this->soft_delete_key, false);
-            }
-
-            $this->temp_with_deleted = false;
-        }
-
-        $rows = $this->db->get($this->table_name);
-        $rows = $this->temp_return_type == 'array' ? $rows->result_array() : $rows->result($this->temp_return_type);
-
-        if (is_array($rows)) {
-            foreach ($rows as $key => &$row) {
-                $row = $this->trigger('after_find', ['method' => 'find_all', 'fields' => $row] );
-            }
-        }
-
-        // Reset our return type
-        $this->temp_return_type = $this->return_type;
-
-        return $rows;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Inserts data into the database.
-     *
-     * @param  array $data An array of key/value pairs to insert to database.
-     * @param  array $skip_validation If TRUE, will skip validation of data for this call only.
-     * @return mixed       The primary_key value of the inserted record, or FALSE.
-     */
-    public function insert($data, $skip_validation = null)
-    {
-        $skip_validation = is_null($skip_validation) ? $this->skip_validation : $skip_validation;
-
-        if ($skip_validation === FALSE) {
-            $data = $this->validate($data, 'insert', $skip_validation);
-        }
-
-        if ($data !== FALSE) {
-            $data = $this->trigger('before_insert', ['method' => 'insert', 'fields' => $data]);
-
-            $this->db->insert($this->table_name, $this->prep_data($data) );
-
-            if ($this->return_insert_id) {
-                $id = $this->db->insert_id();
-
-                $this->trigger('after_insert', ['id' => $id, 'fields' => $data, 'method' => 'insert']);
-
-                return $id;
-            }
-
-            return TRUE;
-        } else {
-            return FALSE;
-        }
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Inserts multiple rows into the database at once. Takes an associative
-     * array of value pairs.
-     *
-     * $data = array(
-     *     array(
-     *         'title' => 'My title'
-     *     ),
-     *     array(
-     *         'title'  => 'My Other Title'
-     *     )
-     * );
-     *
-     * @param  array $data An associate array of rows to insert
-     * @param  array $skip_validation If TRUE, will skip validation of data for this call only.
-     * @return bool
-     */
-    public function insert_batch($data, $skip_validation = null)
-    {
-        $skip_validation = is_null($skip_validation) ? $this->skip_validation : $skip_validation;
-
-        if ($skip_validation === FALSE) {
-            $data = $this->validate($data, 'insert', $skip_validation);
-        }
-
-        if ($data !== FALSE) {
-            $data['batch'] = true;
-            $data = $this->trigger('before_insert', ['method' => 'insert_batch', 'fields' => $data] );
-            unset($data['batch']);
-
-            return $this->db->insert_batch($this->table_name, $data);
-        } else {
-            return FALSE;
-        }
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Performs the SQL standard for a combined DELETE + INSERT, using
-     * PRIMARY and UNIQUE keys to determine which row to replace.
-     *
-     * See CI's documentation for the replace method. We simply wrap
-     * our validation and triggers around their method.
-     *
-     * @param $data
-     * @param null $skip_validation
-     * @return bool
-     */
-    public function replace($data, $skip_validation=null)
-    {
-        $skip_validation = is_null($skip_validation) ? $this->skip_validation : $skip_validation;
-
-        if ($skip_validation === FALSE) {
-            $data = $this->validate($data, 'insert', $skip_validation);
-        }
-
-        if ($data !== FALSE) {
-            $this->db->replace($this->table_name, $this->prep_data($data));
-
-            if ($this->return_insert_id) {
-                $id = $this->db->insert_id();
-
-                $this->trigger('after_insert', ['id' => $id, 'fields' => $data, 'method'=>'replace']);
-
-                return $id;
-            }
-
-            return TRUE;
-        } else {
-            return FALSE;
-        }
-    }
-
-    //--------------------------------------------------------------------
-
-
-    /**
-     * Updates an existing record in the database.
-     *
-     * @param  mixed $id The primary_key value of the record to update.
-     * @param  array $data An array of value pairs to update in the record.
-     * @param  array $skip_validation If TRUE, will skip validation of data for this call only.
-     * @return bool
-     */
-    public function update($id, $data, $skip_validation = null)
-    {
-        $skip_validation = is_null($skip_validation) ? $this->skip_validation : $skip_validation;
-
-        if ($skip_validation === FALSE) {
-            $data = $this->validate($data);
-        }
-
-        // Will be false if it didn't validate.
-        if ($data !== FALSE) {
+		log_message('debug', 'CIDbModel Class Initialized');
+	}
+
+	//--------------------------------------------------------------------
+
+	//--------------------------------------------------------------------
+	// CRUD Methods
+	//--------------------------------------------------------------------
+
+	/**
+	 * A simple way to grab the first result of a search only.
+	 */
+	public function first()
+	{
+		$rows = $this->limit(1, 0)->find_all();
+
+		if (is_array($rows) && count($rows)) {
+			return $rows[0];
+		}
+
+		return $rows;
+	}
+
+	//--------------------------------------------------------------------
+
+
+	/**
+	 * Finds a single record based on it's primary key. Will ignore deleted rows.
+	 *
+	 * @param  mixed $id The primary_key value of the object to retrieve.
+	 * @return object
+	 */
+	public function find($id)
+	{
+		$this->trigger('before_find', ['id' => $id, 'method' => 'find']);
+
+		// Ignore any soft-deleted rows
+		if ($this->soft_deletes) {
+			// We only need to modify the where statement if
+			// temp_with_deleted is false.
+			if ($this->temp_with_deleted !== true) {
+				$this->db->where($this->soft_delete_key, false);
+			}
+
+			$this->temp_with_deleted = false;
+		}
+
+		$this->db->where($this->primary_key, $id);
+		$row = $this->db->get($this->table_name);
+		$row = $this->temp_return_type == 'array' ? $row->row_array() : $row->row(0, $this->temp_return_type);
+
+		if ( ! empty($row))
+		{
+			$row = $this->trigger('after_find', ['id' => $id, 'method' => 'find', 'fields' => $row]);
+		}
+
+		// Reset our return type
+		$this->temp_return_type = $this->return_type;
+
+		return $row;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Fetch a single record based on an arbitrary WHERE call. Can be
+	 * any valid value to $this->db->where(). Will not pull in deleted rows
+	 * if using soft deletes.
+	 *
+	 * @return object
+	 */
+	public function find_by()
+	{
+		$where = func_get_args();
+		$this->_set_where($where);
+
+		// Ignore any soft-deleted rows
+		if ($this->soft_deletes) {
+			// We only need to modify the where statement if
+			// temp_with_deleted is false.
+			if ($this->temp_with_deleted !== true) {
+				$this->db->where($this->soft_delete_key, false);
+			}
+
+			$this->temp_with_deleted = false;
+		}
+
+		$this->trigger('before_find', ['method' => 'find_by', 'fields' => $where]);
+
+		$row = $this->db->get($this->table_name);
+		$row = $this->temp_return_type == 'array' ? $row->row_array() : $row->row(0, $this->temp_return_type);
+
+		if ( ! empty($row))
+		{
+			$row = $this->trigger('after_find', ['method' => 'find_by', 'fields' => $row]);
+		}
+
+		// Reset our return type
+		$this->temp_return_type = $this->return_type;
+
+		return $row;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Retrieves a number of items based on an array of primary_values passed in.
+	 *
+	 * @param  array $values An array of primary key values to find.
+	 *
+	 * @return object or FALSE
+	 */
+	public function find_many($values)
+	{
+		$this->db->where_in($this->primary_key, $values);
+
+		return $this->find_all();
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Retrieves a number of items based on an arbitrary WHERE call. Can be
+	 * any set of parameters valid to $db->where.
+	 *
+	 * @return object or FALSE
+	 */
+	public function find_many_by()
+	{
+		$where = func_get_args();
+		$this->_set_where($where);
+
+		return $this->find_all();
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Fetch all of the records in the table. Can be used with scoped calls
+	 * to restrict the results.
+	 *
+	 * @return object or FALSE
+	 */
+	public function find_all()
+	{
+		$this->trigger('before_find', ['method' => 'find_all']);
+
+		// Ignore any soft-deleted rows
+		if ($this->soft_deletes) {
+			// We only need to modify the where statement if
+			// temp_with_deleted is false.
+			if ($this->temp_with_deleted !== true) {
+				$this->db->where($this->soft_delete_key, false);
+			}
+
+			$this->temp_with_deleted = false;
+		}
+
+		$rows = $this->db->get($this->table_name);
+		$rows = $this->temp_return_type == 'array' ? $rows->result_array() : $rows->result($this->temp_return_type);
+
+		if (is_array($rows)) {
+			foreach ($rows as $key => &$row) {
+				$row = $this->trigger('after_find', ['method' => 'find_all', 'fields' => $row] );
+			}
+		}
+
+		// Reset our return type
+		$this->temp_return_type = $this->return_type;
+
+		return $rows;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Inserts data into the database.
+	 *
+	 * @param  array $data An array of key/value pairs to insert to database.
+	 * @param  array $skip_validation If TRUE, will skip validation of data for this call only.
+	 * @return mixed       The primary_key value of the inserted record, or FALSE.
+	 */
+	public function insert($data, $skip_validation = null)
+	{
+		$skip_validation = is_null($skip_validation) ? $this->skip_validation : $skip_validation;
+
+		if ($skip_validation === FALSE) {
+			$data = $this->validate($data, 'insert', $skip_validation);
+		}
+
+		if ($data !== FALSE) {
+			$data = $this->trigger('before_insert', ['method' => 'insert', 'fields' => $data]);
+
+			$this->db->insert($this->table_name, $this->prep_data($data) );
+
+			if ($this->return_insert_id) {
+				$id = $this->db->insert_id();
+
+				$this->trigger('after_insert', ['id' => $id, 'fields' => $data, 'method' => 'insert']);
+
+				return $id;
+			}
+
+			return TRUE;
+		} else {
+			return FALSE;
+		}
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Inserts multiple rows into the database at once. Takes an associative
+	 * array of value pairs.
+	 *
+	 * $data = array(
+	 *     array(
+	 *         'title' => 'My title'
+	 *     ),
+	 *     array(
+	 *         'title'  => 'My Other Title'
+	 *     )
+	 * );
+	 *
+	 * @param  array $data An associate array of rows to insert
+	 * @param  array $skip_validation If TRUE, will skip validation of data for this call only.
+	 * @return bool
+	 */
+	public function insert_batch($data, $skip_validation = null)
+	{
+		$skip_validation = is_null($skip_validation) ? $this->skip_validation : $skip_validation;
+
+		if ($skip_validation === FALSE) {
+			$data = $this->validate($data, 'insert', $skip_validation);
+		}
+
+		if ($data !== FALSE) {
+			$data['batch'] = true;
+			$data = $this->trigger('before_insert', ['method' => 'insert_batch', 'fields' => $data] );
+			unset($data['batch']);
+
+			return $this->db->insert_batch($this->table_name, $data);
+		} else {
+			return FALSE;
+		}
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Performs the SQL standard for a combined DELETE + INSERT, using
+	 * PRIMARY and UNIQUE keys to determine which row to replace.
+	 *
+	 * See CI's documentation for the replace method. We simply wrap
+	 * our validation and triggers around their method.
+	 *
+	 * @param $data
+	 * @param null $skip_validation
+	 * @return bool
+	 */
+	public function replace($data, $skip_validation=null)
+	{
+		$skip_validation = is_null($skip_validation) ? $this->skip_validation : $skip_validation;
+
+		if ($skip_validation === FALSE) {
+			$data = $this->validate($data, 'insert', $skip_validation);
+		}
+
+		if ($data !== FALSE) {
+			$this->db->replace($this->table_name, $this->prep_data($data));
+
+			if ($this->return_insert_id) {
+				$id = $this->db->insert_id();
+
+				$this->trigger('after_insert', ['id' => $id, 'fields' => $data, 'method'=>'replace']);
+
+				return $id;
+			}
+
+			return TRUE;
+		} else {
+			return FALSE;
+		}
+	}
+
+	//--------------------------------------------------------------------
+
+
+	/**
+	 * Updates an existing record in the database.
+	 *
+	 * @param  mixed $id The primary_key value of the record to update.
+	 * @param  array $data An array of value pairs to update in the record.
+	 * @param  array $skip_validation If TRUE, will skip validation of data for this call only.
+	 * @return bool
+	 */
+	public function update($id, $data, $skip_validation = null)
+	{
+		$skip_validation = is_null($skip_validation) ? $this->skip_validation : $skip_validation;
+
+		if ($skip_validation === FALSE) {
+			$data = $this->validate($data);
+		}
+
+		// Will be false if it didn't validate.
+		if ($data !== FALSE) {
             
-            $data = $this->trigger('before_update', ['id' => $id, 'method' =>'update', 'fields' => $data] );
+			$data = $this->trigger('before_update', ['id' => $id, 'method' =>'update', 'fields' => $data] );
             
-            $this->db->where($this->primary_key, $id);
-            $this->db->set( $this->prep_data($data) );
-            $result = $this->db->update($this->table_name);
-
-            $this->trigger('after_update', ['id' => $id, 'fields' => $data, 'result' => $result, 'method' => 'update']);
-
-            return $result;
-        } else {
-            return FALSE;
-        }
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Updates multiple records in the database at once.
-     *
-     * $data = array(
-     *     array(
-     *         'title'  => 'My title',
-     *         'body'   => 'body 1'
-     *     ),
-     *     array(
-     *         'title'  => 'Another Title',
-     *         'body'   => 'body 2'
-     *     )
-     * );
-     *
-     * The $where_key should be the name of the column to match the record on.
-     * If $where_key == 'title', then each record would be matched on that
-     * 'title' value of the array. This does mean that the array key needs
-     * to be provided with each row's data.
-     *
-     * @param  array $data An associate array of row data to update.
-     * @param  string $where_key The column name to match on.
-     * @return bool
-     */
-    public function update_batch($data, $where_key)
-    {
-        foreach ($data as &$row) {
-            $row = $this->trigger('before_update', ['method' => 'update_batch', 'fields' => $row] );
-        }
-
-        $result = $this->db->update_batch($this->table_name, $data, $where_key);
-
-        foreach ($data as &$row) {
-            $this->trigger('after_update', ['fields' => $data, 'result' => $result, 'method' => 'update_batch']);
-        }
-
-        return $result;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Updates many records by an array of ids.
-     *
-     * While update_batch() allows modifying multiple, arbitrary rows of data
-     * on each row, update_many() sets the same values for each row.
-     *
-     * $ids = array(1, 2, 3, 5, 12);
-     * $data = array(
-     *     'deleted_by' => 1
-     * );
-     *
-     * $this->model->update_many($ids, $data);
-     *
-     * @param  array $ids An array of primary_key values to update.
-     * @param  array $data An array of value pairs to modify in each row.
-     * @param  array $skip_validation If TRUE, will skip validation of data for this call only.
-     * @return bool
-     */
-    public function update_many($ids, $data, $skip_validation = null)
-    {
-        if (!is_array($ids) || count($ids) == 0) return NULL;
-
-        $skip_validation = is_null($skip_validation) ? $this->skip_validation : $skip_validation;
-
-        if ($skip_validation === FALSE) {
-            $data = $this->validate($data, 'update', $skip_validation);
-        }
-
-        $data = $this->trigger('before_update', ['ids' => $ids, 'method' => 'update_many', 'fields' => $data]);
-
-        // Will be false if it didn't validate.
-        if ($data !== FALSE) {
-            $this->db->where_in($this->primary_key, $ids);
-            $this->db->set($data);
-            $result = $this->db->update($this->table_name);
-
-            $this->trigger('after_update', ['ids' => $ids, 'fields' => $data, 'result'=>$result, 'method' => 'update_many']);
-
-            return $result;
-        } else {
-            return FALSE;
-        }
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Update records in the database using a standard WHERE clause.
-     *
-     * Your last parameter should be the $data array with values to update
-     * on the rows. Any additional parameters should be provided to make up
-     * a typical WHERE clause. This could be a single array, or a column name
-     * and a value.
-     *
-     * $data = array('deleted_by' => 1);
-     * $wheres = array('user_id' => 15);
-     *
-     * $this->update_by($wheres, $data);
-     * $this->update_by('user_id', 15, $data);
-     *
-     * @param array $data An array of data pairs to update
-     * @param one or more WHERE-acceptable entries.
-     * @return bool
-     */
-    public function update_by()
-    {
-        $args = func_get_args();
-        $data = array_pop($args);
-        $this->_set_where($args);
-
-        $data = $this->trigger('before_update', ['method' => 'update_by', 'fields' => $data]);
-
-        // Will be false if it didn't validate.
-        if ($this->validate($data) !== FALSE) {
-            $this->db->set( $this->prep_data($data) );
-            $result = $this->db->update($this->table_name);
-
-            $this->trigger('after_update', ['method' => 'update_by', 'fields' => $data, 'result' => $result] );
-
-            return $result;
-        } else {
-            return FALSE;
-        }
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Updates all records and sets the value pairs passed in the array.
-     *
-     * @param  array $data An array of value pairs with the data to change.
-     * @param  array $skip_validation If TRUE, will skip validation of data for this call only.
-     * @return bool
-     */
-    public function update_all($data, $skip_validation = FALSE)
-    {
-        $data = $this->trigger('before_update', ['method' => 'update_all', 'fields' => $data] );
-
-        $skip_validation = is_null($skip_validation) ? $this->skip_validation : $skip_validation;
-
-        if ($skip_validation === FALSE) {
-            $data = $this->validate($data);
-        }
-
-        // Will be false if it didn't validate.
-        if ($data !== FALSE) {
-            $this->db->set( $this->prep_data($data) );
-            $result = $this->db->update($this->table_name);
-
-            $this->trigger('after_update', ['method' => 'update_all', 'fields' => $data, 'result' => $result] );
-
-            return $result;
-        } else {
-            return FALSE;
-        }
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Increments the value of field for a given row, selected by the
-     * primary key for the table.
-     *
-     * @param $id
-     * @param $field
-     * @param int $value
-     * @return mixed
-     */
-    public function increment($id, $field, $value=1)
-    {
-        $value = (int)abs($value);
-
-        $this->db->where($this->primary_key, $id);
-        $this->db->set($field, "{$field}+{$value}", false);
-
-        return $this->db->update($this->table_name);
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Increments the value of field for a given row, selected by the
-     * primary key for the table.
-     *
-     * @param $id
-     * @param $field
-     * @param int $value
-     * @return mixed
-     */
-    public function decrement($id, $field, $value=1)
-    {
-        $value = (int)abs($value);
-
-        $this->db->where($this->primary_key, $id);
-        $this->db->set($field, "{$field}-{$value}", false);
-
-        return $this->db->update($this->table_name);
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Deletes a row by it's primary key value.
-     *
-     * @param  mixed $id The primary key value of the row to delete.
-     * @return bool
-     */
-    public function delete($id)
-    {
-        $this->trigger('before_delete', ['id' => $id, 'method' => 'delete'] );
-
-        $this->db->where($this->primary_key, $id);
+			$this->db->where($this->primary_key, $id);
+			$this->db->set( $this->prep_data($data) );
+			$result = $this->db->update($this->table_name);
+
+			$this->trigger('after_update', ['id' => $id, 'fields' => $data, 'result' => $result, 'method' => 'update']);
+
+			return $result;
+		} else {
+			return FALSE;
+		}
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Updates multiple records in the database at once.
+	 *
+	 * $data = array(
+	 *     array(
+	 *         'title'  => 'My title',
+	 *         'body'   => 'body 1'
+	 *     ),
+	 *     array(
+	 *         'title'  => 'Another Title',
+	 *         'body'   => 'body 2'
+	 *     )
+	 * );
+	 *
+	 * The $where_key should be the name of the column to match the record on.
+	 * If $where_key == 'title', then each record would be matched on that
+	 * 'title' value of the array. This does mean that the array key needs
+	 * to be provided with each row's data.
+	 *
+	 * @param  array $data An associate array of row data to update.
+	 * @param  string $where_key The column name to match on.
+	 * @return bool
+	 */
+	public function update_batch($data, $where_key)
+	{
+		foreach ($data as &$row) {
+			$row = $this->trigger('before_update', ['method' => 'update_batch', 'fields' => $row] );
+		}
+
+		$result = $this->db->update_batch($this->table_name, $data, $where_key);
+
+		foreach ($data as &$row) {
+			$this->trigger('after_update', ['fields' => $data, 'result' => $result, 'method' => 'update_batch']);
+		}
+
+		return $result;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Updates many records by an array of ids.
+	 *
+	 * While update_batch() allows modifying multiple, arbitrary rows of data
+	 * on each row, update_many() sets the same values for each row.
+	 *
+	 * $ids = array(1, 2, 3, 5, 12);
+	 * $data = array(
+	 *     'deleted_by' => 1
+	 * );
+	 *
+	 * $this->model->update_many($ids, $data);
+	 *
+	 * @param  array $ids An array of primary_key values to update.
+	 * @param  array $data An array of value pairs to modify in each row.
+	 * @param  array $skip_validation If TRUE, will skip validation of data for this call only.
+	 * @return bool
+	 */
+	public function update_many($ids, $data, $skip_validation = null)
+	{
+		if (!is_array($ids) || count($ids) == 0) return NULL;
+
+		$skip_validation = is_null($skip_validation) ? $this->skip_validation : $skip_validation;
+
+		if ($skip_validation === FALSE) {
+			$data = $this->validate($data, 'update', $skip_validation);
+		}
+
+		$data = $this->trigger('before_update', ['ids' => $ids, 'method' => 'update_many', 'fields' => $data]);
+
+		// Will be false if it didn't validate.
+		if ($data !== FALSE) {
+			$this->db->where_in($this->primary_key, $ids);
+			$this->db->set($data);
+			$result = $this->db->update($this->table_name);
+
+			$this->trigger('after_update', ['ids' => $ids, 'fields' => $data, 'result'=>$result, 'method' => 'update_many']);
+
+			return $result;
+		} else {
+			return FALSE;
+		}
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Update records in the database using a standard WHERE clause.
+	 *
+	 * Your last parameter should be the $data array with values to update
+	 * on the rows. Any additional parameters should be provided to make up
+	 * a typical WHERE clause. This could be a single array, or a column name
+	 * and a value.
+	 *
+	 * $data = array('deleted_by' => 1);
+	 * $wheres = array('user_id' => 15);
+	 *
+	 * $this->update_by($wheres, $data);
+	 * $this->update_by('user_id', 15, $data);
+	 *
+	 * @param array $data An array of data pairs to update
+	 * @param one or more WHERE-acceptable entries.
+	 * @return bool
+	 */
+	public function update_by()
+	{
+		$args = func_get_args();
+		$data = array_pop($args);
+		$this->_set_where($args);
+
+		$data = $this->trigger('before_update', ['method' => 'update_by', 'fields' => $data]);
+
+		// Will be false if it didn't validate.
+		if ($this->validate($data) !== FALSE) {
+			$this->db->set( $this->prep_data($data) );
+			$result = $this->db->update($this->table_name);
+
+			$this->trigger('after_update', ['method' => 'update_by', 'fields' => $data, 'result' => $result] );
+
+			return $result;
+		} else {
+			return FALSE;
+		}
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Updates all records and sets the value pairs passed in the array.
+	 *
+	 * @param  array $data An array of value pairs with the data to change.
+	 * @param  array $skip_validation If TRUE, will skip validation of data for this call only.
+	 * @return bool
+	 */
+	public function update_all($data, $skip_validation = FALSE)
+	{
+		$data = $this->trigger('before_update', ['method' => 'update_all', 'fields' => $data] );
+
+		$skip_validation = is_null($skip_validation) ? $this->skip_validation : $skip_validation;
+
+		if ($skip_validation === FALSE) {
+			$data = $this->validate($data);
+		}
+
+		// Will be false if it didn't validate.
+		if ($data !== FALSE) {
+			$this->db->set( $this->prep_data($data) );
+			$result = $this->db->update($this->table_name);
+
+			$this->trigger('after_update', ['method' => 'update_all', 'fields' => $data, 'result' => $result] );
+
+			return $result;
+		} else {
+			return FALSE;
+		}
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Increments the value of field for a given row, selected by the
+	 * primary key for the table.
+	 *
+	 * @param $id
+	 * @param $field
+	 * @param int $value
+	 * @return mixed
+	 */
+	public function increment($id, $field, $value=1)
+	{
+		$value = (int)abs($value);
+
+		$this->db->where($this->primary_key, $id);
+		$this->db->set($field, "{$field}+{$value}", false);
+
+		return $this->db->update($this->table_name);
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Increments the value of field for a given row, selected by the
+	 * primary key for the table.
+	 *
+	 * @param $id
+	 * @param $field
+	 * @param int $value
+	 * @return mixed
+	 */
+	public function decrement($id, $field, $value=1)
+	{
+		$value = (int)abs($value);
+
+		$this->db->where($this->primary_key, $id);
+		$this->db->set($field, "{$field}-{$value}", false);
+
+		return $this->db->update($this->table_name);
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Deletes a row by it's primary key value.
+	 *
+	 * @param  mixed $id The primary key value of the row to delete.
+	 * @return bool
+	 */
+	public function delete($id)
+	{
+		$this->trigger('before_delete', ['id' => $id, 'method' => 'delete'] );
+
+		$this->db->where($this->primary_key, $id);
+
+		if ($this->soft_deletes) {
+			$sets = $this->log_user && is_object($this->authenticate)
+				? array($this->soft_delete_key => 1, $this->deleted_by_field => $this->authenticate->id())
+				: array($this->soft_delete_key => 1);
+
+			$result = $this->db->update($this->table_name, $sets);
+		} // Hard Delete
+		else {
+			$result = $this->db->delete($this->table_name);
+		}
+
+		$this->trigger('after_delete', ['id' => $id, 'method' => 'delete', 'result' => $result] );
+
+		return $result;
+	}
+
+	//--------------------------------------------------------------------
+
+	public function delete_by()
+	{
+		$where = func_get_args();
+		$this->_set_where($where);
+
+		$where = $this->trigger('before_delete', ['method' => 'delete_by', 'fields' => $where]);
+
+		if ($this->soft_deletes) {
+			$sets = $this->log_user && is_object($this->authenticate)
+				? array($this->soft_delete_key => 1, $this->deleted_by_field => $this->authenticate->id())
+				: array($this->soft_delete_key => 1);
+
+			$result = $this->db->update($this->table_name, $sets);
+		} else {
+			$result = $this->db->delete($this->table_name);
+		}
+
+		$this->trigger('after_delete', ['method' => 'delete_by', 'fields' => $where, 'result' => $result] );
+
+		return $result;
+	}
+
+	//--------------------------------------------------------------------
+
+	public function delete_many($ids)
+	{
+		if (!is_array($ids) || count($ids) == 0) return NULL;
+
+		$ids = $this->trigger('before_delete', ['ids' => $ids, 'method' => 'delete_many'] );
+
+		$this->db->where_in($this->primary_key, $ids);
+
+		if ($this->soft_deletes) {
+			$sets = $this->log_user && is_object($this->authenticate)
+				? array($this->soft_delete_key => 1, $this->deleted_by_field => $this->authenticate->id())
+				: array($this->soft_delete_key => 1);
+
+			$result = $this->db->update($this->table_name, $sets);
+		} else {
+			$result = $this->db->delete($this->table_name);
+		}
+
+		$this->trigger('after_delete', ['ids' => $ids, 'method' => 'delete_many', 'result' => $result]);
 
-        if ($this->soft_deletes) {
-            $sets = $this->log_user && is_object($this->authenticate)
-                ? array($this->soft_delete_key => 1, $this->deleted_by_field => $this->authenticate->id())
-                : array($this->soft_delete_key => 1);
+		return $result;
+	}
+
+	//--------------------------------------------------------------------
+
+	//--------------------------------------------------------------------
+	// Scope Methods
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets the value of the soft deletes flag.
+	 *
+	 * @param  boolean $val If TRUE, should perform a soft delete. If FALSE, a hard delete.
+	 */
+	public function soft_delete($val = TRUE)
+	{
+		$this->soft_deletes = $val;
 
-            $result = $this->db->update($this->table_name, $sets);
-        } // Hard Delete
-        else {
-            $result = $this->db->delete($this->table_name);
-        }
-
-        $this->trigger('after_delete', ['id' => $id, 'method' => 'delete', 'result' => $result] );
-
-        return $result;
-    }
-
-    //--------------------------------------------------------------------
-
-    public function delete_by()
-    {
-        $where = func_get_args();
-        $this->_set_where($where);
-
-        $where = $this->trigger('before_delete', ['method' => 'delete_by', 'fields' => $where]);
-
-        if ($this->soft_deletes) {
-            $sets = $this->log_user && is_object($this->authenticate)
-                ? array($this->soft_delete_key => 1, $this->deleted_by_field => $this->authenticate->id())
-                : array($this->soft_delete_key => 1);
-
-            $result = $this->db->update($this->table_name, $sets);
-        } else {
-            $result = $this->db->delete($this->table_name);
-        }
-
-        $this->trigger('after_delete', ['method' => 'delete_by', 'fields' => $where, 'result' => $result] );
-
-        return $result;
-    }
-
-    //--------------------------------------------------------------------
-
-    public function delete_many($ids)
-    {
-        if (!is_array($ids) || count($ids) == 0) return NULL;
-
-        $ids = $this->trigger('before_delete', ['ids' => $ids, 'method' => 'delete_many'] );
-
-        $this->db->where_in($this->primary_key, $ids);
-
-        if ($this->soft_deletes) {
-            $sets = $this->log_user && is_object($this->authenticate)
-                ? array($this->soft_delete_key => 1, $this->deleted_by_field => $this->authenticate->id())
-                : array($this->soft_delete_key => 1);
-
-            $result = $this->db->update($this->table_name, $sets);
-        } else {
-            $result = $this->db->delete($this->table_name);
-        }
-
-        $this->trigger('after_delete', ['ids' => $ids, 'method' => 'delete_many', 'result' => $result]);
-
-        return $result;
-    }
-
-    //--------------------------------------------------------------------
-
-    //--------------------------------------------------------------------
-    // Scope Methods
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets the value of the soft deletes flag.
-     *
-     * @param  boolean $val If TRUE, should perform a soft delete. If FALSE, a hard delete.
-     */
-    public function soft_delete($val = TRUE)
-    {
-        $this->soft_deletes = $val;
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Temporarily sets our return type to an array.
-     */
-    public function as_array()
-    {
-        $this->temp_return_type = 'array';
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Temporarily sets our return type to an object.
-     *
-     * If $class is provided, the rows will be returned as objects that
-     * are instances of that class. $class MUST be an fully qualified
-     * class name, meaning that it must include the namespace, if applicable.
-     *
-     * @param string $class
-     * @return $this
-     */
-    public function as_object($class=null)
-    {
-        $this->temp_return_type = ! empty($class) ? $class : 'object';
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Also fetches deleted items for this request only.
-     */
-    public function with_deleted()
-    {
-        $this->temp_with_deleted = TRUE;
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Returns whether the current setup will return
-     * soft deleted rows.
-     *
-     * @return bool
-     */
-    public function get_with_deleted()
-    {
-        return $this->temp_with_deleted;
-    }
-
-    //--------------------------------------------------------------------
-
-
-    /**
-     * Sets the $skip_validation parameter.
-     *
-     * @param bool $skip
-     * @return $this
-     */
-    public function skip_validation($skip = true)
-    {
-        $this->skip_validation = $skip;
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-
-
-    //--------------------------------------------------------------------
-    // Utility Methods
-    //--------------------------------------------------------------------
-
-    /**
-     * Counts number of rows modified by an arbitrary WHERE call.
-     * @return INT
-     */
-    public function count_by()
-    {
-        $where = func_get_args();
-        $this->_set_where($where);
-
-        return $this->db->count_all_results($this->table_name);
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Counts total number of records, disregarding any previous conditions.
-     *
-     * @return int
-     */
-    public function count_all()
-    {
-        return $this->db->count_all($this->table_name);
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Getter for the table name.
-     *
-     * @return string The name of the table used by this class.
-     */
-    public function table()
-    {
-        return $this->table_name;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Set the return_insert_id value.
-     *
-     * @param  boolean $return If TRUE, insert will return the insert_id.
-     */
-    public function return_insert_id($return = true)
-    {
-        $this->return_insert_id = (bool)$return;
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * A convenience method to return only a single field of the specified row.
-     *
-     * @param mixed $id The primary_key value to match against.
-     * @param string $field The field to search for.
-     *
-     * @return bool|mixed The value of the field.
-     */
-    public function get_field($id = NULL, $field = '')
-    {
-        $this->db->select($field);
-        $this->db->where($this->primary_key, $id);
-        $query = $this->db->get($this->table_name);
-
-        if ($query && $query->num_rows() > 0) {
-            return $query->row()->$field;
-        }
-
-        return FALSE;
-
-    }
-
-    //---------------------------------------------------------------
-
-    /**
-     * Checks whether a field/value pair exists within the table.
-     *
-     * @param string $field The field to search for.
-     * @param string $value The value to match $field against.
-     *
-     * @return bool TRUE/FALSE
-     */
-    public function is_unique($field, $value)
-    {
-        $this->db->where($field, $value);
-        $query = $this->db->get($this->table_name);
-
-        if ($query && $query->num_rows() == 0) {
-            return TRUE;
-        }
-
-        return FALSE;
-
-    }
-
-    //---------------------------------------------------------------
-
-    /**
-     * Adds a field to the protected_attributes array.
-     *
-     * @param $field
-     *
-     * @return mixed
-     */
-    public function protect($field)
-    {
-        $this->protected_attributes[] = $field;
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Get the field names for this model's table.
-     *
-     * Returns the model's database fields stored in $this->fields
-     * if set, else it tries to retrieve the field list from
-     * $this->db->list_fields($this->table_name);
-     *
-     * @return array    Returns the database fields for this model
-     */
-    public function get_fields()
-    {
-        if (empty($this->fields)) {
-            $this->fields = $this->db->list_fields($this->table_name);
-        }
-
-        return $this->fields;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Extracts the model's fields (except the key and those handled by
-     * Observers) from the $post_data and returns an array of name => value pairs
-     *
-     * @param Array $post_data The post data, usually $this->input->post() when called from the controller
-     *
-     * @return Array    An array of name => value pairs containing the data for the model's fields
-     */
-    public function prep_data($post_data)
-    {
-        $data = array();
-        $skippedFields = array();
-
-        if (empty($post_data))
-        {
-            return [];
-        }
-
-        // Though the model doesn't support multiple keys well, $this->key
-        // could be an array or a string...
-        $skippedFields = array_merge($skippedFields, (array)$this->primary_key);
-
-        // Remove any protected attributes
-        $skippedFields = array_merge($skippedFields, $this->protected_attributes);
-
-        $fields = $this->get_fields();
-
-        // If the field is the primary key, one of the created/modified/deleted
-        // fields, or has not been set in the $post_data, skip it
-        foreach ($post_data as $field => $value) {
-            if (in_array($field, $skippedFields) ||
-                ! in_array($field, $fields))
-            {
-                continue;
-            }
-
-            $data[$field] = $value;
-        }
-
-        return $data;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Returns the last query string, if available. Simply a wrapper for
-     * CodeIgniter's database method of the same name.
-     *
-     * @return string
-     */
-    public function last_query ()
-    {
-        return $this->db->last_query();
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Returns the elapsed time for the last query that was executed, if
-     * available, or NULL if not available, like if debug mode is off.
-     *
-     * @return mixed
-     */
-    public function last_query_time ()
-    {
-        $times = $this->db->query_times;
-
-        if (! is_array($this->db->query_times) || ! count($this->db->query_times))
-        {
-            return null;
-        }
-
-        return end($times);
-    }
-
-    //--------------------------------------------------------------------
-
-    //--------------------------------------------------------------------
-    // Observers
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets the created on date for the object based on the
-     * current date/time and date_format. Will not overwrite existing.
-     *
-     * @param array $row The array of data to be inserted
-     *
-     * @return array
-     */
-    public function created_on($row)
-    {
-        if (empty($row['fields']))
-        {
-            return null;
-        }
-
-        $row = $row['fields'];
-
-        // Created_on
-        if (! array_key_exists($this->created_field, $row))
-        {
-            $row[$this->created_field] = $this->set_date();
-        }
-
-        // Created by
-        if ($this->log_user && ! array_key_exists($this->created_by_field, $row) && is_object($this->authenticate))
-        {
-            // If you're here because of an error with $this->authenticate
-            // not being available, it's likely due to you not using
-            // the AuthTrait and/or setting log_user after model is instantiated.
-            $row[$this->created_by_field] = (int)$this->authenticate->id();
-        }
-
-        return $row;
-    } // end created_on()
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets the modified_on date for the object based on the
-     * current date/time and date_format. Will not overwrite existing.
-     *
-     * @param array $row The array of data to be inserted
-     *
-     * @return array
-     */
-    public function modified_on($row)
-    {
-        if (empty($row['fields']))
-        {
-            return null;
-        }
-
-        $row = $row['fields'];
-
-        if (is_array($row) && ! array_key_exists($this->modified_field, $row))
-        {
-            $row[$this->modified_field] = $this->set_date();
-        }
-
-        // Modified by
-        if ($this->log_user && ! array_key_exists($this->modified_by_field, $row) && is_object($this->authenticate))
-        {
-            // If you're here because of an error with $this->authenticate
-            // not being available, it's likely due to you not using
-            // the AuthTrait and/or setting log_user after model is instantiated.
-            $row[$this->modified_by_field] = $this->authenticate->id();
-        }
-
-        return $row;
-    }
-
-    //--------------------------------------------------------------------
-
-    //--------------------------------------------------------------------
-    // Internal Methods
-    //--------------------------------------------------------------------
-
-    /**
-     * Set WHERE parameters
-     */
-    protected function _set_where($params)
-    {
-        if (count($params) == 1) {
-            $this->db->where($params[0]);
-        } else {
-            $this->db->where($params[0], $params[1]);
-        }
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Triggers a model-specific event and call each of it's observers.
-     *
-     * @param string $event The name of the event to trigger
-     * @param mixed $data The data to be passed to the callback functions.
-     *
-     * @return mixed
-     */
-    public function trigger($event, $data = false)
-    {
-        if (! isset($this->$event) || ! is_array($this->$event))
-        {
-            if (isset($data['fields']))
-            {
-                return $data['fields'];
-            }
-
-            return $data;
-        }
-
-        foreach ($this->$event as $method)
-        {
-            if (strpos($method, '('))
-            {
-                preg_match('/([a-zA-Z0-9\_\-]+)(\(([a-zA-Z0-9\_\-\., ]+)\))?/', $method, $matches);
-                $this->callback_parameters = explode(',', $matches[3]);
-            }
-
-            $data = call_user_func_array(array($this, $method), array($data));
-        }
-
-        // In case no method called or method returned
-        // the entire data array, we typically just need the $fields
-        if (isset($data['fields']))
-        {
-            return $data['fields'];
-        }
-
-        // A few methods might need to return 'ids'
-        if (isset($data['ids']))
-        {
-            return $data['ids'];
-        }
-
-        return $data;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Validates the data passed into it based upon the form_validation rules
-     * setup in the $this->validate property.
-     *
-     * If $type == 'insert', any additional rules in the class var $insert_validate_rules
-     * for that field will be added to the rules.
-     *
-     * @param  array $data An array of validation rules
-     * @param  string $type Either 'update' or 'insert'.
-     * @return array/bool       The original data or FALSE
-     */
-    public function validate($data, $type = 'update', $skip_validation = null)
-    {
-        $skip_validation = is_null($skip_validation) ? $this->skip_validation : $skip_validation;
-
-        if ($skip_validation) {
-            return $data;
-        }
-
-        // We need the database to be loaded up at this point in case
-        // we want to use callbacks that hit the database.
-        if (empty($this->db))
-        {
-            $this->load->database();
-        }
-
-        if (!empty($this->validation_rules)) {
-            $this->form_validation->set_data($data);
-
-            if (is_array($this->validation_rules)) {
-                // Any insert additions?
-                if ($type == 'insert'
-                    && !empty($this->insert_validate_rules)
-                    && is_array($this->insert_validate_rules)
-                ) {
-                    foreach ($this->validation_rules as &$row) {
-                        if (isset($this->insert_validate_rules[$row['field']])) {
-                            $row ['rules'] .= '|' . $this->insert_validate_rules[$row['field']];
-                        }
-                    }
-                }
-
-                $this->form_validation->set_rules($this->validation_rules);
-
-                if ($this->form_validation->run('', $this) === TRUE) {
-                    return $data;
-                } else {
-                    return FALSE;
-                }
-            } else {
-                if ($this->form_validation->run($this->validate, $this) === TRUE) {
-                    return $data;
-                } else {
-                    return FALSE;
-                }
-            }
-        } else {
-            return $data;
-        }
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Protect attributes by removing them from $row array. Useful for
-     * removing id, or submit buttons names if you simply throw your $_POST
-     * array at your model. :)
-     *
-     * @param object /array $row The value pair item to remove.
-     */
-    public function protect_attributes($row)
-    {
-        foreach ($this->protected_attributes as $attr) {
-            if (is_object($row)) {
-                unset($row->$attr);
-            } else {
-                unset($row[$attr]);
-            }
-        }
-
-        return $row;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * A utility function to allow child models to use the type of
-     * date/time format that they prefer. This is primarily used for
-     * setting created_on and modified_on values, but can be used by
-     * inheriting classes.
-     *
-     * The available time formats are:
-     * * 'int'      - Stores the date as an integer timestamp.
-     * * 'datetime' - Stores the date and time in the SQL datetime format.
-     * * 'date'     - Stores teh date (only) in the SQL date format.
-     *
-     * @param mixed $user_date An optional PHP timestamp to be converted.
-     *
-     * @access protected
-     *
-     * @return int|null|string The current/user time converted to the proper format.
-     */
-    protected function set_date($user_date = NULL)
-    {
-        $curr_date = !empty($user_date) ? $user_date : time();
-
-        switch ($this->date_format) {
-            case 'int':
-                return $curr_date;
-                break;
-            case 'datetime':
-                return date('Y-m-d H:i:s', $curr_date);
-                break;
-            case 'date':
-                return date('Y-m-d', $curr_date);
-                break;
-        }
-
-    }//end set_date()
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Returns an array containing the 'code' and 'message' of the
-     * database's error, as provided by CI's database drivers.
-     *
-     * @return mixed
-     */
-    public function error($db_array_only=false)
-    {
-        // Send any validation errors if we have any.
-        if (function_exists('validation_errors') && validation_errors() && ! $db_array_only)
-        {
-            return validation_errors();
-        }
-
-        // No validation errors? Return the db error.
-        $error = $this->db->error();
-
-        if ($db_array_only)
-        {
-            return $error;
-        }
-
-        if (! empty($error['code']))
-        {
-            return "Database Error {$error['code']}: {$error['message']}.";
-        }
-
-        // No errors found.
-        return '';
-    }
-
-    //--------------------------------------------------------------------
-
-    //--------------------------------------------------------------------
-    // Magic Methods
-    //--------------------------------------------------------------------
-
-    /**
-     * __get magic
-     *
-     * Allows models to access CI's loaded classes using the same
-     * syntax as controllers.
-     *
-     * This is the same as what CI's model uses, but we keep it
-     * here since that's the ONLY thing that CI's model does.
-     *
-     * @param    string $key
-     */
-    public function __get($key)
-    {
-        // Give them first crack at any protected class vars
-        if (isset($this->$key))
-        {
-            return $this->$key;
-        }
-
-        // Debugging note:
-        //	If you're here because you're getting an error message
-        //	saying 'Undefined Property: system/core/Model.php', it's
-        //	most likely a typo in your model code.
-        return get_instance()->$key;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Provide direct access to any of CodeIgniter's DB methods but
-     * make it look like it's part of the class, purely for convenience.
-     *
-     * @param $name
-     * @param $params
-     */
-    public function __call($name, $params=null)
-    {
-        if (method_exists($this->db, $name))
-        {
-            call_user_func_array([$this->db, $name], $params);
-            return $this;
-        }
-    }
-
-    //--------------------------------------------------------------------
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Temporarily sets our return type to an array.
+	 */
+	public function as_array()
+	{
+		$this->temp_return_type = 'array';
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Temporarily sets our return type to an object.
+	 *
+	 * If $class is provided, the rows will be returned as objects that
+	 * are instances of that class. $class MUST be an fully qualified
+	 * class name, meaning that it must include the namespace, if applicable.
+	 *
+	 * @param string $class
+	 * @return $this
+	 */
+	public function as_object($class=null)
+	{
+		$this->temp_return_type = ! empty($class) ? $class : 'object';
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Also fetches deleted items for this request only.
+	 */
+	public function with_deleted()
+	{
+		$this->temp_with_deleted = TRUE;
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Returns whether the current setup will return
+	 * soft deleted rows.
+	 *
+	 * @return bool
+	 */
+	public function get_with_deleted()
+	{
+		return $this->temp_with_deleted;
+	}
+
+	//--------------------------------------------------------------------
+
+
+	/**
+	 * Sets the $skip_validation parameter.
+	 *
+	 * @param bool $skip
+	 * @return $this
+	 */
+	public function skip_validation($skip = true)
+	{
+		$this->skip_validation = $skip;
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
+
+	//--------------------------------------------------------------------
+	// Utility Methods
+	//--------------------------------------------------------------------
+
+	/**
+	 * Counts number of rows modified by an arbitrary WHERE call.
+	 * @return INT
+	 */
+	public function count_by()
+	{
+		$where = func_get_args();
+		$this->_set_where($where);
+
+		return $this->db->count_all_results($this->table_name);
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Counts total number of records, disregarding any previous conditions.
+	 *
+	 * @return int
+	 */
+	public function count_all()
+	{
+		return $this->db->count_all($this->table_name);
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Getter for the table name.
+	 *
+	 * @return string The name of the table used by this class.
+	 */
+	public function table()
+	{
+		return $this->table_name;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Set the return_insert_id value.
+	 *
+	 * @param  boolean $return If TRUE, insert will return the insert_id.
+	 */
+	public function return_insert_id($return = true)
+	{
+		$this->return_insert_id = (bool)$return;
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * A convenience method to return only a single field of the specified row.
+	 *
+	 * @param mixed $id The primary_key value to match against.
+	 * @param string $field The field to search for.
+	 *
+	 * @return bool|mixed The value of the field.
+	 */
+	public function get_field($id = NULL, $field = '')
+	{
+		$this->db->select($field);
+		$this->db->where($this->primary_key, $id);
+		$query = $this->db->get($this->table_name);
+
+		if ($query && $query->num_rows() > 0) {
+			return $query->row()->$field;
+		}
+
+		return FALSE;
+
+	}
+
+	//---------------------------------------------------------------
+
+	/**
+	 * Checks whether a field/value pair exists within the table.
+	 *
+	 * @param string $field The field to search for.
+	 * @param string $value The value to match $field against.
+	 *
+	 * @return bool TRUE/FALSE
+	 */
+	public function is_unique($field, $value)
+	{
+		$this->db->where($field, $value);
+		$query = $this->db->get($this->table_name);
+
+		if ($query && $query->num_rows() == 0) {
+			return TRUE;
+		}
+
+		return FALSE;
+
+	}
+
+	//---------------------------------------------------------------
+
+	/**
+	 * Adds a field to the protected_attributes array.
+	 *
+	 * @param $field
+	 *
+	 * @return mixed
+	 */
+	public function protect($field)
+	{
+		$this->protected_attributes[] = $field;
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Get the field names for this model's table.
+	 *
+	 * Returns the model's database fields stored in $this->fields
+	 * if set, else it tries to retrieve the field list from
+	 * $this->db->list_fields($this->table_name);
+	 *
+	 * @return array    Returns the database fields for this model
+	 */
+	public function get_fields()
+	{
+		if (empty($this->fields)) {
+			$this->fields = $this->db->list_fields($this->table_name);
+		}
+
+		return $this->fields;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Extracts the model's fields (except the key and those handled by
+	 * Observers) from the $post_data and returns an array of name => value pairs
+	 *
+	 * @param Array $post_data The post data, usually $this->input->post() when called from the controller
+	 *
+	 * @return Array    An array of name => value pairs containing the data for the model's fields
+	 */
+	public function prep_data($post_data)
+	{
+		$data = array();
+		$skippedFields = array();
+
+		if (empty($post_data))
+		{
+			return [];
+		}
+
+		// Though the model doesn't support multiple keys well, $this->key
+		// could be an array or a string...
+		$skippedFields = array_merge($skippedFields, (array)$this->primary_key);
+
+		// Remove any protected attributes
+		$skippedFields = array_merge($skippedFields, $this->protected_attributes);
+
+		$fields = $this->get_fields();
+
+		// If the field is the primary key, one of the created/modified/deleted
+		// fields, or has not been set in the $post_data, skip it
+		foreach ($post_data as $field => $value) {
+			if (in_array($field, $skippedFields) ||
+				! in_array($field, $fields))
+			{
+				continue;
+			}
+
+			$data[$field] = $value;
+		}
+
+		return $data;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Returns the last query string, if available. Simply a wrapper for
+	 * CodeIgniter's database method of the same name.
+	 *
+	 * @return string
+	 */
+	public function last_query ()
+	{
+		return $this->db->last_query();
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Returns the elapsed time for the last query that was executed, if
+	 * available, or NULL if not available, like if debug mode is off.
+	 *
+	 * @return mixed
+	 */
+	public function last_query_time ()
+	{
+		$times = $this->db->query_times;
+
+		if (! is_array($this->db->query_times) || ! count($this->db->query_times))
+		{
+			return null;
+		}
+
+		return end($times);
+	}
+
+	//--------------------------------------------------------------------
+
+	//--------------------------------------------------------------------
+	// Observers
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets the created on date for the object based on the
+	 * current date/time and date_format. Will not overwrite existing.
+	 *
+	 * @param array $row The array of data to be inserted
+	 *
+	 * @return array
+	 */
+	public function created_on($row)
+	{
+		if (empty($row['fields']))
+		{
+			return null;
+		}
+
+		$row = $row['fields'];
+
+		// Created_on
+		if (! array_key_exists($this->created_field, $row))
+		{
+			$row[$this->created_field] = $this->set_date();
+		}
+
+		// Created by
+		if ($this->log_user && ! array_key_exists($this->created_by_field, $row) && is_object($this->authenticate))
+		{
+			// If you're here because of an error with $this->authenticate
+			// not being available, it's likely due to you not using
+			// the AuthTrait and/or setting log_user after model is instantiated.
+			$row[$this->created_by_field] = (int)$this->authenticate->id();
+		}
+
+		return $row;
+	} // end created_on()
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets the modified_on date for the object based on the
+	 * current date/time and date_format. Will not overwrite existing.
+	 *
+	 * @param array $row The array of data to be inserted
+	 *
+	 * @return array
+	 */
+	public function modified_on($row)
+	{
+		if (empty($row['fields']))
+		{
+			return null;
+		}
+
+		$row = $row['fields'];
+
+		if (is_array($row) && ! array_key_exists($this->modified_field, $row))
+		{
+			$row[$this->modified_field] = $this->set_date();
+		}
+
+		// Modified by
+		if ($this->log_user && ! array_key_exists($this->modified_by_field, $row) && is_object($this->authenticate))
+		{
+			// If you're here because of an error with $this->authenticate
+			// not being available, it's likely due to you not using
+			// the AuthTrait and/or setting log_user after model is instantiated.
+			$row[$this->modified_by_field] = $this->authenticate->id();
+		}
+
+		return $row;
+	}
+
+	//--------------------------------------------------------------------
+
+	//--------------------------------------------------------------------
+	// Internal Methods
+	//--------------------------------------------------------------------
+
+	/**
+	 * Set WHERE parameters
+	 */
+	protected function _set_where($params)
+	{
+		if (count($params) == 1) {
+			$this->db->where($params[0]);
+		} else {
+			$this->db->where($params[0], $params[1]);
+		}
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Triggers a model-specific event and call each of it's observers.
+	 *
+	 * @param string $event The name of the event to trigger
+	 * @param mixed $data The data to be passed to the callback functions.
+	 *
+	 * @return mixed
+	 */
+	public function trigger($event, $data = false)
+	{
+		if (! isset($this->$event) || ! is_array($this->$event))
+		{
+			if (isset($data['fields']))
+			{
+				return $data['fields'];
+			}
+
+			return $data;
+		}
+
+		foreach ($this->$event as $method)
+		{
+			if (strpos($method, '('))
+			{
+				preg_match('/([a-zA-Z0-9\_\-]+)(\(([a-zA-Z0-9\_\-\., ]+)\))?/', $method, $matches);
+				$this->callback_parameters = explode(',', $matches[3]);
+			}
+
+			$data = call_user_func_array(array($this, $method), array($data));
+		}
+
+		// In case no method called or method returned
+		// the entire data array, we typically just need the $fields
+		if (isset($data['fields']))
+		{
+			return $data['fields'];
+		}
+
+		// A few methods might need to return 'ids'
+		if (isset($data['ids']))
+		{
+			return $data['ids'];
+		}
+
+		return $data;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Validates the data passed into it based upon the form_validation rules
+	 * setup in the $this->validate property.
+	 *
+	 * If $type == 'insert', any additional rules in the class var $insert_validate_rules
+	 * for that field will be added to the rules.
+	 *
+	 * @param  array $data An array of validation rules
+	 * @param  string $type Either 'update' or 'insert'.
+	 * @return array/bool       The original data or FALSE
+	 */
+	public function validate($data, $type = 'update', $skip_validation = null)
+	{
+		$skip_validation = is_null($skip_validation) ? $this->skip_validation : $skip_validation;
+
+		if ($skip_validation) {
+			return $data;
+		}
+
+		// We need the database to be loaded up at this point in case
+		// we want to use callbacks that hit the database.
+		if (empty($this->db))
+		{
+			$this->load->database();
+		}
+
+		if (!empty($this->validation_rules)) {
+			$this->form_validation->set_data($data);
+
+			if (is_array($this->validation_rules)) {
+				// Any insert additions?
+				if ($type == 'insert'
+					&& !empty($this->insert_validate_rules)
+					&& is_array($this->insert_validate_rules)
+				) {
+					foreach ($this->validation_rules as &$row) {
+						if (isset($this->insert_validate_rules[$row['field']])) {
+							$row ['rules'] .= '|' . $this->insert_validate_rules[$row['field']];
+						}
+					}
+				}
+
+				$this->form_validation->set_rules($this->validation_rules);
+
+				if ($this->form_validation->run('', $this) === TRUE) {
+					return $data;
+				} else {
+					return FALSE;
+				}
+			} else {
+				if ($this->form_validation->run($this->validate, $this) === TRUE) {
+					return $data;
+				} else {
+					return FALSE;
+				}
+			}
+		} else {
+			return $data;
+		}
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Protect attributes by removing them from $row array. Useful for
+	 * removing id, or submit buttons names if you simply throw your $_POST
+	 * array at your model. :)
+	 *
+	 * @param object /array $row The value pair item to remove.
+	 */
+	public function protect_attributes($row)
+	{
+		foreach ($this->protected_attributes as $attr) {
+			if (is_object($row)) {
+				unset($row->$attr);
+			} else {
+				unset($row[$attr]);
+			}
+		}
+
+		return $row;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * A utility function to allow child models to use the type of
+	 * date/time format that they prefer. This is primarily used for
+	 * setting created_on and modified_on values, but can be used by
+	 * inheriting classes.
+	 *
+	 * The available time formats are:
+	 * * 'int'      - Stores the date as an integer timestamp.
+	 * * 'datetime' - Stores the date and time in the SQL datetime format.
+	 * * 'date'     - Stores teh date (only) in the SQL date format.
+	 *
+	 * @param mixed $user_date An optional PHP timestamp to be converted.
+	 *
+	 * @access protected
+	 *
+	 * @return int|null|string The current/user time converted to the proper format.
+	 */
+	protected function set_date($user_date = NULL)
+	{
+		$curr_date = !empty($user_date) ? $user_date : time();
+
+		switch ($this->date_format) {
+			case 'int':
+				return $curr_date;
+				break;
+			case 'datetime':
+				return date('Y-m-d H:i:s', $curr_date);
+				break;
+			case 'date':
+				return date('Y-m-d', $curr_date);
+				break;
+		}
+
+	}//end set_date()
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Returns an array containing the 'code' and 'message' of the
+	 * database's error, as provided by CI's database drivers.
+	 *
+	 * @return mixed
+	 */
+	public function error($db_array_only=false)
+	{
+		// Send any validation errors if we have any.
+		if (function_exists('validation_errors') && validation_errors() && ! $db_array_only)
+		{
+			return validation_errors();
+		}
+
+		// No validation errors? Return the db error.
+		$error = $this->db->error();
+
+		if ($db_array_only)
+		{
+			return $error;
+		}
+
+		if (! empty($error['code']))
+		{
+			return "Database Error {$error['code']}: {$error['message']}.";
+		}
+
+		// No errors found.
+		return '';
+	}
+
+	//--------------------------------------------------------------------
+
+	//--------------------------------------------------------------------
+	// Magic Methods
+	//--------------------------------------------------------------------
+
+	/**
+	 * __get magic
+	 *
+	 * Allows models to access CI's loaded classes using the same
+	 * syntax as controllers.
+	 *
+	 * This is the same as what CI's model uses, but we keep it
+	 * here since that's the ONLY thing that CI's model does.
+	 *
+	 * @param    string $key
+	 */
+	public function __get($key)
+	{
+		// Give them first crack at any protected class vars
+		if (isset($this->$key))
+		{
+			return $this->$key;
+		}
+
+		// Debugging note:
+		//	If you're here because you're getting an error message
+		//	saying 'Undefined Property: system/core/Model.php', it's
+		//	most likely a typo in your model code.
+		return get_instance()->$key;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Provide direct access to any of CodeIgniter's DB methods but
+	 * make it look like it's part of the class, purely for convenience.
+	 *
+	 * @param $name
+	 * @param $params
+	 */
+	public function __call($name, $params=null)
+	{
+		if (method_exists($this->db, $name))
+		{
+			call_user_func_array([$this->db, $name], $params);
+			return $this;
+		}
+	}
+
+	//--------------------------------------------------------------------
 
 
 }

myth/Route.php

Indentation +639 added lines, -639 removed lines

@@ -43,644 +43,644 @@
 class Route
 {
 
-    // Our routes, ripe for the picking.
-    public $routes = array();
-
-    // Holds key/value pairs of named routes
-    public static $names = array();
-
-    // Used for grouping routes together.
-    public $group = null;
-
-    // Holds the 'areas' of the site.
-    public static $areas = array();
-
-    // The default controller to use in case
-    // 'default_controller' is not in the routes file.
-    protected $default_home = 'home';
-
-    // The default constraint to use in route building
-    protected $default_constraint = 'any';
-
-    protected $constraints = [
-        'any'  => '(:any)',
-        'num'  => '(:num)',
-        'id'   => '(:num)',
-        'name' => "([a-zA-Z']+)"
-    ];
-
-    protected $current_subdomain = null;
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Combines the routes that we've defined with the Route class with the
-     * routes passed in. This is intended to be used  after all routes have been
-     * defined to merge CI's default $route array with our routes.
-     *
-     * Example:
-     *     $route['default_controller'] = 'home';
-     *     Route::resource('posts');
-     *     $route = Route::map($route);
-     *
-     * @param array $routes
-     * @internal param array $route The array to merge
-     * @return array         The merge route array.
-     */
-    public function map($routes = array())
-    {
-        $controller = isset($routes['default_controller']) ? $routes['default_controller'] : $this->default_home;
-
-        $routes = array_merge($routes, $this->routes);
-
-        foreach ($routes as $from => $to) {
-            $routes[$from] = str_ireplace('{default_controller}', $controller, $to);
-        }
-
-        return $routes;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * A single point to the basic routing. Can be used in place of CI's $route
-     * array if desired. Used internally by many of the methods.
-     *
-     * Available options are currently:
-     *      'as'        - remembers the route via a name that can be called outside of it.
-     *      'offset'    - Offsets and parameters ($1, $2, etc) in routes by the specified amount.
-     *                    Useful while doing versioning of API's, etc.
-     *
-     * Example:
-     *      $route->any('news', 'posts/index');
-     *
-     * @param string $from
-     * @param string $to
-     * @param array  $options
-     * @return void
-     */
-    public function any($from, $to, $options = array())
-    {
-        $this->create($from, $to, $options);
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets the default constraint to be used in the system. Typically
-     * for use with the 'resources' method.
-     *
-     * @param $constraint
-     */
-    public function setDefaultConstraint($constraint)
-    {
-        if (array_key_exists($constraint, $this->constraints)) {
-            $this->default_constraint = $constraint;
-        }
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Registers a new constraint to be used internally. Useful for creating
-     * very specific regex patterns, or simply to allow your routes to be
-     * a tad more readable.
-     *
-     * Example:
-     *      $route->registerConstraint('hero', '(^.*)');
-     *
-     *      $route->any('home/{hero}', 'heroes/journey');
-     *
-     *      // Route then looks like:
-     *      $route['home/(^.*)'] = 'heroes/journey';
-     *
-     * @param      $name
-     * @param      $pattern
-     * @param bool $overwrite
-     */
-    public function registerConstraint($name, $pattern, $overwrite = false)
-    {
-        // Ensure consistency
-        $name    = trim($name, '{} ');
-        $pattern = '(' . trim($pattern, '() ') . ')';
-
-        // Not here? Add it and leave...
-        if (! array_key_exists($name, $this->constraints)) {
-            $this->constraints[$name] = $pattern;
-
-            return;
-        }
-
-        // Here? Then it exists. Should we overwrite it?
-        if ($overwrite) {
-            $this->constraints[$name] = $pattern;
-        }
-    }
-
-    //--------------------------------------------------------------------
-
-    //--------------------------------------------------------------------
-    // Named Routes
-    //--------------------------------------------------------------------
-
-    /**
-     * Returns the value of a named route. Useful for getting named
-     * routes for use while building with site_url() or in templates
-     * where you don't need to instantiate the route class.
-     *
-     * Example:
-     *      $route->any('news', 'posts/index', ['as' => 'blog']);
-     *
-     *      // Returns http://mysite.com/news
-     *      site_url( Route::named('blog') );
-     *
-     * @param  [type] $name [description]
-     * @return [type]       [description]
-     */
-    public static function named($name)
-    {
-        if (isset(self::$names[$name])) {
-            return self::$names[$name];
-        }
-
-        return null;
-    }
-
-    //--------------------------------------------------------------------
-
-    //--------------------------------------------------------------------
-    // Grouping Routes
-    //--------------------------------------------------------------------
-
-    /**
-     * Group a series of routes under a single URL segment. This is handy
-     * for grouping items into an admin area, like:
-     *
-     * Example:
-     *     $route->group('admin', function() {
-     *            $route->resources('users');
-     *     });
-     *
-     * @param  string   $name     The name to group/prefix the routes with.
-     * @param  \Closure $callback An anonymous function that allows you route inside of this group.
-     * @return void
-     */
-    public function group($name, \Closure $callback)
-    {
-        $old_group = $this->group;
-
-        // To register a route, we'll set a flag so that our router
-        // so it will see the groupname.
-        $this->group = ltrim($old_group . '/' . $name, '/');
-
-        call_user_func($callback);
-
-        // Make sure to clear the group name so we don't accidentally
-        // group any ones we didn't want to.
-        $this->group = $old_group;
-    }
-
-    //--------------------------------------------------------------------
-
-    //--------------------------------------------------------------------
-    // HTTP Verb-based routing
-    //--------------------------------------------------------------------
-    // Routing works here because, as the routes config file is read in,
-    // the various HTTP verb-based routes will only be added to the in-memory
-    // routes if it is a call that should respond to that verb.
-    //
-    // The options array is typically used to pass in an 'as' or var, but may
-    // be expanded in the future. See the docblock for 'any' method above for
-    // current list of globally available options.
-    //
-
-    /**
-     * Specifies a single route to match for multiple HTTP Verbs.
-     *
-     * Example:
-     *  $route->match( ['get', 'post'], 'users/(:num)', 'users/$1);
-     *
-     * @param array $verbs
-     * @param       $from
-     * @param       $to
-     * @param array $options
-     */
-    public function match($verbs = [], $from, $to, $options = [])
-    {
-        foreach ($verbs as $verb) {
-            $verb = strtolower($verb);
-
-            $this->{$verb}($from, $to, $options);
-        }
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Specifies a route that is only available to GET requests.
-     *
-     * @param       $from
-     * @param       $to
-     * @param array $options
-     */
-    public function get($from, $to, $options = [])
-    {
-        if (isset($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] == 'GET') {
-            $this->create($from, $to, $options);
-        }
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Specifies a route that is only available to POST requests.
-     *
-     * @param       $from
-     * @param       $to
-     * @param array $options
-     */
-    public function post($from, $to, $options = [])
-    {
-        if (isset($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] == 'POST') {
-            $this->create($from, $to, $options);
-        }
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Specifies a route that is only available to PUT requests.
-     *
-     * @param       $from
-     * @param       $to
-     * @param array $options
-     */
-    public function put($from, $to, $options = [])
-    {
-        if (isset($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] == 'PUT') {
-            $this->create($from, $to, $options);
-        }
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Specifies a route that is only available to DELETE requests.
-     *
-     * @param       $from
-     * @param       $to
-     * @param array $options
-     */
-    public function delete($from, $to, $options = [])
-    {
-        if (isset($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] == 'DELETE') {
-            $this->create($from, $to, $options);
-        }
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Specifies a route that is only available to HEAD requests.
-     *
-     * @param       $from
-     * @param       $to
-     * @param array $options
-     */
-    public function head($from, $to, $options = [])
-    {
-        if (isset($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] == 'HEAD') {
-            $this->create($from, $to, $options);
-        }
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Specifies a route that is only available to PATCH requests.
-     *
-     * @param       $from
-     * @param       $to
-     * @param array $options
-     */
-    public function patch($from, $to, $options = [])
-    {
-        if (isset($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] == 'PATCH') {
-            $this->create($from, $to, $options);
-        }
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Specifies a route that is only available to OPTIONS requests.
-     *
-     * @param       $from
-     * @param       $to
-     * @param array $options
-     */
-    public function options($from, $to, $options = [])
-    {
-        if (isset($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] == 'OPTIONS') {
-            $this->create($from, $to, $options);
-        }
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Creates a collections of HTTP-verb based routes for a controller.
-     *
-     * Possible Options:
-     *      'controller'    - Customize the name of the controller used in the 'to' route
-     *      'module'        - Prepend a module name to the generate 'to' routes
-     *      'constraint'    - The regex used by the Router. Defaults to '(:any)'
-     *
-     * Example:
-     *      $route->resources('photos');
-     *
-     *      // Generates the following routes:
-     *      HTTP Verb | Path        | Action        | Used for...
-     *      ----------+-------------+---------------+-----------------
-     *      GET         /photos             index           display a list of photos
-     *      GET         /photos/new         creation_form   return an HTML form for creating a new photo
-     *      GET         /photos/{id}        show            display a specific photo
-     *      GET         /photos/{id}/edit   editing_form    return an HTML form for editing the photo
-     *      POST        /photos             create          create a new photo
-     *      PUT         /photos/{id}        update          update an existing photo
-     *      DELETE      /photos/{id}/delete delete          delete an existing photo
-     *
-     * @param  string $name    The name of the controller to route to.
-     * @param  array  $options An list of possible ways to customize the routing.
-     */
-    public function resources($name, $options = [])
-    {
-        // In order to allow customization of the route the
-        // resources are sent to, we need to have a new name
-        // to store the values in.
-        $new_name = $name;
-
-        // If a new controller is specified, then we replace the
-        // $name value with the name of the new controller.
-        if (isset($options['controller'])) {
-            $new_name = $options['controller'];
-        }
-
-        // If a new module was specified, simply put that path
-        // in front of the controller.
-        if (isset($options['module'])) {
-            $new_name = $options['module'] . '/' . $new_name;
-        }
-
-        // In order to allow customization of allowed id values
-        // we need someplace to store them.
-        $id = isset($this->constraints[$this->default_constraint]) ? $this->constraints[$this->default_constraint] :
-            '(:any)';
-
-        if (isset($options['constraint'])) {
-            $id = $options['constraint'];
-        }
-
-        $this->get($name, $new_name . '/list_all', $options);
-        $this->get($name . '/' . $id, $new_name . '/show/$1', $options);
-        $this->post($name, $new_name . '/create', $options);
-        $this->put($name . '/' . $id, $new_name . '/update/$1', $options);
-        $this->delete($name . '/' . $id, $new_name . '/delete/$1', $options);
-        $this->options($name, $new_name . '/index', $options);
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Lets the system know about different 'areas' within the site, like
-     * the admin area, that maps to certain controllers.
-     *
-     * @param  string $area       The name of the area.
-     * @param  string $controller The controller name to look for.
-     * @param         $options
-     */
-    public function area($area, $controller = null, $options = [])
-    {
-        // No controller? Match the area name.
-        $controller = is_null($controller) ? $area : $controller;
-
-        // Save the area so we can recognize it later.
-        self::$areas[$area] = $controller;
-
-        // Create routes for this area.
-        $this->create($area . '/(:any)/(:any)/(:any)/(:any)/(:any)', '$1/' . $controller . '/$2/$3/$4/$5', $options);
-        $this->create($area . '/(:any)/(:any)/(:any)/(:any)', '$1/' . $controller . '/$2/$3/$4', $options);
-        $this->create($area . '/(:any)/(:any)/(:any)', '$1/' . $controller . '/$2/$3', $options);
-        $this->create($area . '/(:any)/(:any)', '$1/' . $controller . '/$2', $options);
-        $this->create($area . '/(:any)', '$1/' . $controller, $options);
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Returns the name of the area based on the controller name.
-     *
-     * @param  string $controller The name of the controller
-     * @return string             The name of the corresponding area
-     */
-    public static function getAreaName($controller)
-    {
-        foreach (self::$areas as $area => $cont) {
-            if ($controller == $cont) {
-                return $area;
-            }
-        }
-
-        return null;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Limits the routes to a specified ENVIRONMENT or they won't run.
-     *
-     * @param $env
-     * @param callable $callback
-     *
-     * @return bool|null
-     */
-    public function environment($env, \Closure $callback)
-    {
-        if (ENVIRONMENT == $env)
-        {
-            call_user_func($callback);
-            return true;
-        }
-
-        return null;
-    }
-
-    //--------------------------------------------------------------------
-
-
-
-    /**
-     * Allows you to easily block access to any number of routes by setting
-     * that route to an empty path ('').
-     *
-     * Example:
-     *     Route::block('posts', 'photos/(:num)');
-     *
-     *     // Same as...
-     *     $route['posts']          = '';
-     *     $route['photos/(:num)']  = '';
-     */
-    public function block()
-    {
-        $paths = func_get_args();
-
-        if (! is_array($paths) || ! count($paths)) {
-            return;
-        }
-
-        foreach ($paths as $path) {
-            $this->create($path, '');
-        }
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Empties all named and un-named routes from the system.
-     *
-     * @return void
-     */
-    public function reset()
-    {
-        $this->routes = array();
-        $this->names  = array();
-        $this->group  = null;
-        self::$areas  = array();
-    }
-
-    //--------------------------------------------------------------------
-
-    //--------------------------------------------------------------------
-    // Private Methods
-    //--------------------------------------------------------------------
-
-    /**
-     * Does the heavy lifting of creating an actual route. You must specify
-     * the request method(s) that this route will work for. They can be separated
-     * by a pipe character "|" if there is more than one.
-     *
-     * @param  string $from
-     * @param  array  $to
-     * @param array   $options
-     *
-     * @return array          The built route.
-     */
-    private function create($from, $to, $options = array())
-    {
-        $prefix = is_null($this->group) ? '' : $this->group . '/';
-
-        $from = $prefix . $from;
-
-        // Are we saving the name for this one?
-        if (isset($options['as']) && !empty($options['as'])) {
-            self::$names[$options['as']] = $from;
-        }
-
-        // Limiting to subdomains?
-        if (isset($options['subdomain']) && !empty($options['subdomain'])) {
-            // If we don't match the current subdomain, then
-            // we don't need to add the route.
-            if (!$this->checkSubdomains($options['subdomain'])) {
-                return;
-            }
-        }
-
-        // Are we offsetting the parameters?
-        // If so, take care of them here in one
-        // fell swoop.
-        if (isset($options['offset'])) {
-            // Get a constant string to work with.
-            $to = preg_replace('/(\$\d+)/', '$X', $to);
-
-            for ($i = (int)$options['offset'] + 1; $i < (int)$options['offset'] + 7; $i ++) {
-                $to = preg_replace_callback(
-                    '/\$X/',
-                    function ($m) use ($i) {
-                        return '$' . $i;
-                    },
-                    $to,
-                    1
-                );
-            }
-        }
-
-        // Convert any custom constraints to the CI/pattern equivalent
-        foreach ($this->constraints as $name => $pattern) {
-            $from = str_replace('{' . $name . '}', $pattern, $from);
-        }
-
-        $this->routes[$from] = $to;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Compares the subdomain(s) passed in against the current subdomain
-     * on this page request.
-     *
-     * @param $subdomains
-     * @return bool
-     */
-    private function checkSubdomains($subdomains)
-    {
-        if (is_null($this->current_subdomain)) {
-            $this->determineCurrentSubdomain();
-        }
-
-        if (!is_array($subdomains)) {
-            $subdomains = array($subdomains);
-        }
-
-        $matched = false;
-
-        array_walk(
-            $subdomains,
-            function ($subdomain) use (&$matched) {
-                if ($subdomain == $this->current_subdomain || $subdomain == '*') {
-                    $matched = true;
-                }
-            }
-        );
-
-        return $matched;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Examines the HTTP_HOST to get a best match for the subdomain. It
-     * won't be perfect, but should work for our needs.
-     */
-    private function determineCurrentSubdomain()
-    {
-        $parsedUrl = parse_url($_SERVER['HTTP_HOST']);
-
-        $host = explode('.', $parsedUrl['host']);
-
-        // If we only have 2 parts, then we don't have a subdomain.
-        // This won't be totally accurate, since URL's like example.co.uk
-        // would still pass, but it helps to separate the chaff...
-        if (!is_array($host) || count($host) == 2) {
-            // Set it to false so we don't make it back here again.
-            $this->current_subdomain = false;
-            return;
-        }
-
-        // Now, we'll simply take the first element of the array. This should
-        // be fine even in cases like example.co.uk, since they won't be looking
-        // for 'example' when they try to match the subdomain, in most all cases.
-        $this->current_subdomain = array_shift($host);
-    }
-    //--------------------------------------------------------------------
+	// Our routes, ripe for the picking.
+	public $routes = array();
+
+	// Holds key/value pairs of named routes
+	public static $names = array();
+
+	// Used for grouping routes together.
+	public $group = null;
+
+	// Holds the 'areas' of the site.
+	public static $areas = array();
+
+	// The default controller to use in case
+	// 'default_controller' is not in the routes file.
+	protected $default_home = 'home';
+
+	// The default constraint to use in route building
+	protected $default_constraint = 'any';
+
+	protected $constraints = [
+		'any'  => '(:any)',
+		'num'  => '(:num)',
+		'id'   => '(:num)',
+		'name' => "([a-zA-Z']+)"
+	];
+
+	protected $current_subdomain = null;
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Combines the routes that we've defined with the Route class with the
+	 * routes passed in. This is intended to be used  after all routes have been
+	 * defined to merge CI's default $route array with our routes.
+	 *
+	 * Example:
+	 *     $route['default_controller'] = 'home';
+	 *     Route::resource('posts');
+	 *     $route = Route::map($route);
+	 *
+	 * @param array $routes
+	 * @internal param array $route The array to merge
+	 * @return array         The merge route array.
+	 */
+	public function map($routes = array())
+	{
+		$controller = isset($routes['default_controller']) ? $routes['default_controller'] : $this->default_home;
+
+		$routes = array_merge($routes, $this->routes);
+
+		foreach ($routes as $from => $to) {
+			$routes[$from] = str_ireplace('{default_controller}', $controller, $to);
+		}
+
+		return $routes;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * A single point to the basic routing. Can be used in place of CI's $route
+	 * array if desired. Used internally by many of the methods.
+	 *
+	 * Available options are currently:
+	 *      'as'        - remembers the route via a name that can be called outside of it.
+	 *      'offset'    - Offsets and parameters ($1, $2, etc) in routes by the specified amount.
+	 *                    Useful while doing versioning of API's, etc.
+	 *
+	 * Example:
+	 *      $route->any('news', 'posts/index');
+	 *
+	 * @param string $from
+	 * @param string $to
+	 * @param array  $options
+	 * @return void
+	 */
+	public function any($from, $to, $options = array())
+	{
+		$this->create($from, $to, $options);
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets the default constraint to be used in the system. Typically
+	 * for use with the 'resources' method.
+	 *
+	 * @param $constraint
+	 */
+	public function setDefaultConstraint($constraint)
+	{
+		if (array_key_exists($constraint, $this->constraints)) {
+			$this->default_constraint = $constraint;
+		}
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Registers a new constraint to be used internally. Useful for creating
+	 * very specific regex patterns, or simply to allow your routes to be
+	 * a tad more readable.
+	 *
+	 * Example:
+	 *      $route->registerConstraint('hero', '(^.*)');
+	 *
+	 *      $route->any('home/{hero}', 'heroes/journey');
+	 *
+	 *      // Route then looks like:
+	 *      $route['home/(^.*)'] = 'heroes/journey';
+	 *
+	 * @param      $name
+	 * @param      $pattern
+	 * @param bool $overwrite
+	 */
+	public function registerConstraint($name, $pattern, $overwrite = false)
+	{
+		// Ensure consistency
+		$name    = trim($name, '{} ');
+		$pattern = '(' . trim($pattern, '() ') . ')';
+
+		// Not here? Add it and leave...
+		if (! array_key_exists($name, $this->constraints)) {
+			$this->constraints[$name] = $pattern;
+
+			return;
+		}
+
+		// Here? Then it exists. Should we overwrite it?
+		if ($overwrite) {
+			$this->constraints[$name] = $pattern;
+		}
+	}
+
+	//--------------------------------------------------------------------
+
+	//--------------------------------------------------------------------
+	// Named Routes
+	//--------------------------------------------------------------------
+
+	/**
+	 * Returns the value of a named route. Useful for getting named
+	 * routes for use while building with site_url() or in templates
+	 * where you don't need to instantiate the route class.
+	 *
+	 * Example:
+	 *      $route->any('news', 'posts/index', ['as' => 'blog']);
+	 *
+	 *      // Returns http://mysite.com/news
+	 *      site_url( Route::named('blog') );
+	 *
+	 * @param  [type] $name [description]
+	 * @return [type]       [description]
+	 */
+	public static function named($name)
+	{
+		if (isset(self::$names[$name])) {
+			return self::$names[$name];
+		}
+
+		return null;
+	}
+
+	//--------------------------------------------------------------------
+
+	//--------------------------------------------------------------------
+	// Grouping Routes
+	//--------------------------------------------------------------------
+
+	/**
+	 * Group a series of routes under a single URL segment. This is handy
+	 * for grouping items into an admin area, like:
+	 *
+	 * Example:
+	 *     $route->group('admin', function() {
+	 *            $route->resources('users');
+	 *     });
+	 *
+	 * @param  string   $name     The name to group/prefix the routes with.
+	 * @param  \Closure $callback An anonymous function that allows you route inside of this group.
+	 * @return void
+	 */
+	public function group($name, \Closure $callback)
+	{
+		$old_group = $this->group;
+
+		// To register a route, we'll set a flag so that our router
+		// so it will see the groupname.
+		$this->group = ltrim($old_group . '/' . $name, '/');
+
+		call_user_func($callback);
+
+		// Make sure to clear the group name so we don't accidentally
+		// group any ones we didn't want to.
+		$this->group = $old_group;
+	}
+
+	//--------------------------------------------------------------------
+
+	//--------------------------------------------------------------------
+	// HTTP Verb-based routing
+	//--------------------------------------------------------------------
+	// Routing works here because, as the routes config file is read in,
+	// the various HTTP verb-based routes will only be added to the in-memory
+	// routes if it is a call that should respond to that verb.
+	//
+	// The options array is typically used to pass in an 'as' or var, but may
+	// be expanded in the future. See the docblock for 'any' method above for
+	// current list of globally available options.
+	//
+
+	/**
+	 * Specifies a single route to match for multiple HTTP Verbs.
+	 *
+	 * Example:
+	 *  $route->match( ['get', 'post'], 'users/(:num)', 'users/$1);
+	 *
+	 * @param array $verbs
+	 * @param       $from
+	 * @param       $to
+	 * @param array $options
+	 */
+	public function match($verbs = [], $from, $to, $options = [])
+	{
+		foreach ($verbs as $verb) {
+			$verb = strtolower($verb);
+
+			$this->{$verb}($from, $to, $options);
+		}
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Specifies a route that is only available to GET requests.
+	 *
+	 * @param       $from
+	 * @param       $to
+	 * @param array $options
+	 */
+	public function get($from, $to, $options = [])
+	{
+		if (isset($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] == 'GET') {
+			$this->create($from, $to, $options);
+		}
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Specifies a route that is only available to POST requests.
+	 *
+	 * @param       $from
+	 * @param       $to
+	 * @param array $options
+	 */
+	public function post($from, $to, $options = [])
+	{
+		if (isset($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] == 'POST') {
+			$this->create($from, $to, $options);
+		}
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Specifies a route that is only available to PUT requests.
+	 *
+	 * @param       $from
+	 * @param       $to
+	 * @param array $options
+	 */
+	public function put($from, $to, $options = [])
+	{
+		if (isset($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] == 'PUT') {
+			$this->create($from, $to, $options);
+		}
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Specifies a route that is only available to DELETE requests.
+	 *
+	 * @param       $from
+	 * @param       $to
+	 * @param array $options
+	 */
+	public function delete($from, $to, $options = [])
+	{
+		if (isset($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] == 'DELETE') {
+			$this->create($from, $to, $options);
+		}
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Specifies a route that is only available to HEAD requests.
+	 *
+	 * @param       $from
+	 * @param       $to
+	 * @param array $options
+	 */
+	public function head($from, $to, $options = [])
+	{
+		if (isset($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] == 'HEAD') {
+			$this->create($from, $to, $options);
+		}
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Specifies a route that is only available to PATCH requests.
+	 *
+	 * @param       $from
+	 * @param       $to
+	 * @param array $options
+	 */
+	public function patch($from, $to, $options = [])
+	{
+		if (isset($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] == 'PATCH') {
+			$this->create($from, $to, $options);
+		}
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Specifies a route that is only available to OPTIONS requests.
+	 *
+	 * @param       $from
+	 * @param       $to
+	 * @param array $options
+	 */
+	public function options($from, $to, $options = [])
+	{
+		if (isset($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] == 'OPTIONS') {
+			$this->create($from, $to, $options);
+		}
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Creates a collections of HTTP-verb based routes for a controller.
+	 *
+	 * Possible Options:
+	 *      'controller'    - Customize the name of the controller used in the 'to' route
+	 *      'module'        - Prepend a module name to the generate 'to' routes
+	 *      'constraint'    - The regex used by the Router. Defaults to '(:any)'
+	 *
+	 * Example:
+	 *      $route->resources('photos');
+	 *
+	 *      // Generates the following routes:
+	 *      HTTP Verb | Path        | Action        | Used for...
+	 *      ----------+-------------+---------------+-----------------
+	 *      GET         /photos             index           display a list of photos
+	 *      GET         /photos/new         creation_form   return an HTML form for creating a new photo
+	 *      GET         /photos/{id}        show            display a specific photo
+	 *      GET         /photos/{id}/edit   editing_form    return an HTML form for editing the photo
+	 *      POST        /photos             create          create a new photo
+	 *      PUT         /photos/{id}        update          update an existing photo
+	 *      DELETE      /photos/{id}/delete delete          delete an existing photo
+	 *
+	 * @param  string $name    The name of the controller to route to.
+	 * @param  array  $options An list of possible ways to customize the routing.
+	 */
+	public function resources($name, $options = [])
+	{
+		// In order to allow customization of the route the
+		// resources are sent to, we need to have a new name
+		// to store the values in.
+		$new_name = $name;
+
+		// If a new controller is specified, then we replace the
+		// $name value with the name of the new controller.
+		if (isset($options['controller'])) {
+			$new_name = $options['controller'];
+		}
+
+		// If a new module was specified, simply put that path
+		// in front of the controller.
+		if (isset($options['module'])) {
+			$new_name = $options['module'] . '/' . $new_name;
+		}
+
+		// In order to allow customization of allowed id values
+		// we need someplace to store them.
+		$id = isset($this->constraints[$this->default_constraint]) ? $this->constraints[$this->default_constraint] :
+			'(:any)';
+
+		if (isset($options['constraint'])) {
+			$id = $options['constraint'];
+		}
+
+		$this->get($name, $new_name . '/list_all', $options);
+		$this->get($name . '/' . $id, $new_name . '/show/$1', $options);
+		$this->post($name, $new_name . '/create', $options);
+		$this->put($name . '/' . $id, $new_name . '/update/$1', $options);
+		$this->delete($name . '/' . $id, $new_name . '/delete/$1', $options);
+		$this->options($name, $new_name . '/index', $options);
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Lets the system know about different 'areas' within the site, like
+	 * the admin area, that maps to certain controllers.
+	 *
+	 * @param  string $area       The name of the area.
+	 * @param  string $controller The controller name to look for.
+	 * @param         $options
+	 */
+	public function area($area, $controller = null, $options = [])
+	{
+		// No controller? Match the area name.
+		$controller = is_null($controller) ? $area : $controller;
+
+		// Save the area so we can recognize it later.
+		self::$areas[$area] = $controller;
+
+		// Create routes for this area.
+		$this->create($area . '/(:any)/(:any)/(:any)/(:any)/(:any)', '$1/' . $controller . '/$2/$3/$4/$5', $options);
+		$this->create($area . '/(:any)/(:any)/(:any)/(:any)', '$1/' . $controller . '/$2/$3/$4', $options);
+		$this->create($area . '/(:any)/(:any)/(:any)', '$1/' . $controller . '/$2/$3', $options);
+		$this->create($area . '/(:any)/(:any)', '$1/' . $controller . '/$2', $options);
+		$this->create($area . '/(:any)', '$1/' . $controller, $options);
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Returns the name of the area based on the controller name.
+	 *
+	 * @param  string $controller The name of the controller
+	 * @return string             The name of the corresponding area
+	 */
+	public static function getAreaName($controller)
+	{
+		foreach (self::$areas as $area => $cont) {
+			if ($controller == $cont) {
+				return $area;
+			}
+		}
+
+		return null;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Limits the routes to a specified ENVIRONMENT or they won't run.
+	 *
+	 * @param $env
+	 * @param callable $callback
+	 *
+	 * @return bool|null
+	 */
+	public function environment($env, \Closure $callback)
+	{
+		if (ENVIRONMENT == $env)
+		{
+			call_user_func($callback);
+			return true;
+		}
+
+		return null;
+	}
+
+	//--------------------------------------------------------------------
+
+
+
+	/**
+	 * Allows you to easily block access to any number of routes by setting
+	 * that route to an empty path ('').
+	 *
+	 * Example:
+	 *     Route::block('posts', 'photos/(:num)');
+	 *
+	 *     // Same as...
+	 *     $route['posts']          = '';
+	 *     $route['photos/(:num)']  = '';
+	 */
+	public function block()
+	{
+		$paths = func_get_args();
+
+		if (! is_array($paths) || ! count($paths)) {
+			return;
+		}
+
+		foreach ($paths as $path) {
+			$this->create($path, '');
+		}
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Empties all named and un-named routes from the system.
+	 *
+	 * @return void
+	 */
+	public function reset()
+	{
+		$this->routes = array();
+		$this->names  = array();
+		$this->group  = null;
+		self::$areas  = array();
+	}
+
+	//--------------------------------------------------------------------
+
+	//--------------------------------------------------------------------
+	// Private Methods
+	//--------------------------------------------------------------------
+
+	/**
+	 * Does the heavy lifting of creating an actual route. You must specify
+	 * the request method(s) that this route will work for. They can be separated
+	 * by a pipe character "|" if there is more than one.
+	 *
+	 * @param  string $from
+	 * @param  array  $to
+	 * @param array   $options
+	 *
+	 * @return array          The built route.
+	 */
+	private function create($from, $to, $options = array())
+	{
+		$prefix = is_null($this->group) ? '' : $this->group . '/';
+
+		$from = $prefix . $from;
+
+		// Are we saving the name for this one?
+		if (isset($options['as']) && !empty($options['as'])) {
+			self::$names[$options['as']] = $from;
+		}
+
+		// Limiting to subdomains?
+		if (isset($options['subdomain']) && !empty($options['subdomain'])) {
+			// If we don't match the current subdomain, then
+			// we don't need to add the route.
+			if (!$this->checkSubdomains($options['subdomain'])) {
+				return;
+			}
+		}
+
+		// Are we offsetting the parameters?
+		// If so, take care of them here in one
+		// fell swoop.
+		if (isset($options['offset'])) {
+			// Get a constant string to work with.
+			$to = preg_replace('/(\$\d+)/', '$X', $to);
+
+			for ($i = (int)$options['offset'] + 1; $i < (int)$options['offset'] + 7; $i ++) {
+				$to = preg_replace_callback(
+					'/\$X/',
+					function ($m) use ($i) {
+						return '$' . $i;
+					},
+					$to,
+					1
+				);
+			}
+		}
+
+		// Convert any custom constraints to the CI/pattern equivalent
+		foreach ($this->constraints as $name => $pattern) {
+			$from = str_replace('{' . $name . '}', $pattern, $from);
+		}
+
+		$this->routes[$from] = $to;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Compares the subdomain(s) passed in against the current subdomain
+	 * on this page request.
+	 *
+	 * @param $subdomains
+	 * @return bool
+	 */
+	private function checkSubdomains($subdomains)
+	{
+		if (is_null($this->current_subdomain)) {
+			$this->determineCurrentSubdomain();
+		}
+
+		if (!is_array($subdomains)) {
+			$subdomains = array($subdomains);
+		}
+
+		$matched = false;
+
+		array_walk(
+			$subdomains,
+			function ($subdomain) use (&$matched) {
+				if ($subdomain == $this->current_subdomain || $subdomain == '*') {
+					$matched = true;
+				}
+			}
+		);
+
+		return $matched;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Examines the HTTP_HOST to get a best match for the subdomain. It
+	 * won't be perfect, but should work for our needs.
+	 */
+	private function determineCurrentSubdomain()
+	{
+		$parsedUrl = parse_url($_SERVER['HTTP_HOST']);
+
+		$host = explode('.', $parsedUrl['host']);
+
+		// If we only have 2 parts, then we don't have a subdomain.
+		// This won't be totally accurate, since URL's like example.co.uk
+		// would still pass, but it helps to separate the chaff...
+		if (!is_array($host) || count($host) == 2) {
+			// Set it to false so we don't make it back here again.
+			$this->current_subdomain = false;
+			return;
+		}
+
+		// Now, we'll simply take the first element of the array. This should
+		// be fine even in cases like example.co.uk, since they won't be looking
+		// for 'example' when they try to match the subdomain, in most all cases.
+		$this->current_subdomain = array_shift($host);
+	}
+	//--------------------------------------------------------------------
 
 }

myth/Settings/ConfigStore.php

Indentation +138 added lines, -138 removed lines

@@ -49,143 +49,143 @@
  */
 class ConfigStore implements SettingsStoreInterface {
 
-    protected $ci;
-
-    //--------------------------------------------------------------------
-
-    public function __construct( $ci=null )
-    {
-        if (is_object($ci))
-        {
-            $this->ci =& $ci;
-        }
-        else {
-            $this->ci =& get_instance();
-        }
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Inserts/Replaces a single setting item.
-     *
-     * @param $key
-     * @param null $value
-     * @param string $group
-     */
-    public function save($key, $value=null, $group='app')
-    {
-        // Treat the 'app' group as our primary, un-sectioned
-        // config files.
-        if ($group != 'app')
-        {
-            return $this->ci->config->set_item($key, $value);
-        }
-
-        // Otherwise, we'll need to ensure a section exists
-        if (! isset($this->ci->config->config[$group]))
-        {
-            $this->ci->config->config[$group] = [];
-        }
-
-        $this->ci->config->config[$group][$key] = $value;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Retrieves a single item. If the config system doesn't have the
-     * value loaded, yet, it will attempt to load a config file matching
-     * the 'group' name and grab the value from that.
-     *
-     * @param $key
-     * @param string $group
-     * @return mixed
-     */
-    public function get($key, $group='application')
-    {
-        // First, see if CI already has this key loaded.
-        $result = $this->ci->config->item($key);
-
-        // This bit will fail when the actual value is NULL
-        // but should result in false hits infrequently.
-        if ($result !== null)
-        {
-            return $result;
-        }
-
-        // Try to load the 'group' file, then try to load a
-        // config file that matches the group name
-        $this->ci->load->config($group, false, true);
+	protected $ci;
+
+	//--------------------------------------------------------------------
+
+	public function __construct( $ci=null )
+	{
+		if (is_object($ci))
+		{
+			$this->ci =& $ci;
+		}
+		else {
+			$this->ci =& get_instance();
+		}
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Inserts/Replaces a single setting item.
+	 *
+	 * @param $key
+	 * @param null $value
+	 * @param string $group
+	 */
+	public function save($key, $value=null, $group='app')
+	{
+		// Treat the 'app' group as our primary, un-sectioned
+		// config files.
+		if ($group != 'app')
+		{
+			return $this->ci->config->set_item($key, $value);
+		}
+
+		// Otherwise, we'll need to ensure a section exists
+		if (! isset($this->ci->config->config[$group]))
+		{
+			$this->ci->config->config[$group] = [];
+		}
+
+		$this->ci->config->config[$group][$key] = $value;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Retrieves a single item. If the config system doesn't have the
+	 * value loaded, yet, it will attempt to load a config file matching
+	 * the 'group' name and grab the value from that.
+	 *
+	 * @param $key
+	 * @param string $group
+	 * @return mixed
+	 */
+	public function get($key, $group='application')
+	{
+		// First, see if CI already has this key loaded.
+		$result = $this->ci->config->item($key);
+
+		// This bit will fail when the actual value is NULL
+		// but should result in false hits infrequently.
+		if ($result !== null)
+		{
+			return $result;
+		}
+
+		// Try to load the 'group' file, then try to load a
+		// config file that matches the group name
+		$this->ci->load->config($group, false, true);
         
-        $result = $this->ci->config->item($key);
-
-        return $result;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Deletes a single item.
-     *
-     * NOT supported by this store.
-     *
-     * @param $key
-     * @param $group
-     * @return mixed
-     */
-    public function delete($key, $group='app')
-    {
-        return false;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Searches the store for any items with $field = $value.
-     *
-     * Does not work.
-     *
-     * @param $field
-     * @param $value
-     * @return mixed
-     */
-    public function findBy($field, $value)
-    {
-        return false;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Retrieves all items in the store either globally or for a single group.
-     *
-     * @param string $group
-     * @return mixed
-     */
-    public function all($group=null)
-    {
-        if (empty($group))
-        {
-            return $this->ci->config->config;
-        }
-
-        // If we're a group, does the group already exists
-        // as a 'section' in the config array?
-        if (isset($this->ci->config->config[$group]))
-        {
-            return $this->ci->config->config[$group];
-        }
-
-        // Still here? Attempt to load the file into a section
-        // and try one last time.
-        if ($this->ci->load->config($group))
-        {
-            return $this->ci->config->config($group);
-        }
-
-        return null;
-    }
-
-    //--------------------------------------------------------------------
+		$result = $this->ci->config->item($key);
+
+		return $result;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Deletes a single item.
+	 *
+	 * NOT supported by this store.
+	 *
+	 * @param $key
+	 * @param $group
+	 * @return mixed
+	 */
+	public function delete($key, $group='app')
+	{
+		return false;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Searches the store for any items with $field = $value.
+	 *
+	 * Does not work.
+	 *
+	 * @param $field
+	 * @param $value
+	 * @return mixed
+	 */
+	public function findBy($field, $value)
+	{
+		return false;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Retrieves all items in the store either globally or for a single group.
+	 *
+	 * @param string $group
+	 * @return mixed
+	 */
+	public function all($group=null)
+	{
+		if (empty($group))
+		{
+			return $this->ci->config->config;
+		}
+
+		// If we're a group, does the group already exists
+		// as a 'section' in the config array?
+		if (isset($this->ci->config->config[$group]))
+		{
+			return $this->ci->config->config[$group];
+		}
+
+		// Still here? Attempt to load the file into a section
+		// and try one last time.
+		if ($this->ci->load->config($group))
+		{
+			return $this->ci->config->config($group);
+		}
+
+		return null;
+	}
+
+	//--------------------------------------------------------------------
 }

myth/Settings/DatabaseStore.php

Indentation +208 added lines, -208 removed lines

@@ -1,214 +1,214 @@
 <?php namespace Myth\Settings;
 /**
- * Sprint
- *
- * A set of power tools to enhance the CodeIgniter framework and provide consistent workflow.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- * THE SOFTWARE.
- *
- * @package     Sprint
- * @author      Lonnie Ezell
- * @copyright   Copyright 2014-2015, New Myth Media, LLC (http://newmythmedia.com)
- * @license     http://opensource.org/licenses/MIT  (MIT)
- * @link        http://sprintphp.com
- * @since       Version 1.0
- */
+	 * Sprint
+	 *
+	 * A set of power tools to enhance the CodeIgniter framework and provide consistent workflow.
+	 *
+	 * Permission is hereby granted, free of charge, to any person obtaining a copy
+	 * of this software and associated documentation files (the "Software"), to deal
+	 * in the Software without restriction, including without limitation the rights
+	 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+	 * copies of the Software, and to permit persons to whom the Software is
+	 * furnished to do so, subject to the following conditions:
+	 *
+	 * The above copyright notice and this permission notice shall be included in
+	 * all copies or substantial portions of the Software.
+	 *
+	 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+	 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+	 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+	 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+	 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+	 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+	 * THE SOFTWARE.
+	 *
+	 * @package     Sprint
+	 * @author      Lonnie Ezell
+	 * @copyright   Copyright 2014-2015, New Myth Media, LLC (http://newmythmedia.com)
+	 * @license     http://opensource.org/licenses/MIT  (MIT)
+	 * @link        http://sprintphp.com
+	 * @since       Version 1.0
+	 */
 
 class DatabaseStore implements SettingsStoreInterface {
 
-    protected $ci;
-
-    protected $db;
-
-    //--------------------------------------------------------------------
-
-    public function __construct( $ci=null )
-    {
-        if (is_object($ci))
-        {
-            $this->ci =& $ci;
-        }
-        else {
-            $this->ci =& get_instance();
-        }
-
-        // Ensure that the database is loaded.
-        if (empty($this->ci->db))
-        {
-            $this->ci->load->database();
-        }
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Inserts or Replaces an setting value.
-     *
-     * @param $key
-     * @param null $value
-     * @param string $group
-     * @return bool
-     */
-    public function save($key, $value=null, $group='app')
-    {
-        if (empty($this->ci->db) || ! is_object($this->ci->db))
-        {
-            return false;
-        }
-
-        $where = [
-            'name'  => $key,
-            'group' => $group
-        ];
-        $this->ci->db->delete('settings', $where);
-
-        if (is_array($value) || is_object($value))
-        {
-            $value = serialize($value);
-        }
-
-        $data = [
-            'name'  => $key,
-            'value' => $value,
-            'group' => $group
-        ];
-        return $this->ci->db->insert('settings', $data);
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Retrieves a single item.
-     *
-     * @param $key
-     * @param string $group
-     * @return mixed
-     */
-    public function get($key, $group='app')
-    {
-        if (empty($this->ci->db) || ! is_object($this->ci->db))
-        {
-            return false;
-        }
-
-        $where = [
-            'name'  => $key,
-            'group' => $group
-        ];
-
-        $query = $this->ci->db->where($where)
-                              ->get('settings');
-
-        if (! $query->num_rows())
-        {
-            return false;
-        }
-
-        $value = $query->row()->value;
-
-        // Check to see if it needs to be unserialized
-        $data = @unserialize($value);   // We don't need to issue an E_NOTICE here...
-
-        // Check for a value of false or
-        if ($value === 'b:0;' || $data !== false)
-        {
-            $value = $data;
-        }
-
-        return $value;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Deletes a single item.
-     *
-     * @param $key
-     * @param $group
-     * @return mixed
-     */
-    public function delete($key, $group='app')
-    {
-        if (empty($this->ci->db) || ! is_object($this->ci->db))
-        {
-            return false;
-        }
-
-        $where = [
-            'name'  => $key,
-            'group' => $group
-        ];
-
-        return $this->ci->db->delete('settings', $where);
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Searches the store for any items with $field = $value.
-     *
-     * @param $field
-     * @param $value
-     * @return mixed
-     */
-    public function findBy($field, $value)
-    {
-        if (empty($this->ci->db) || ! is_object($this->ci->db))
-        {
-            return false;
-        }
-
-        $query = $this->ci->db->where($field, $value)
-                              ->get('settings');
-
-        if (! $query->num_rows())
-        {
-            return false;
-        }
-
-        return $query->result_array();
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Retrieves all items in the store either globally or for a single group.
-     *
-     * @param string $group
-     * @return mixed
-     */
-    public function all($group=null)
-    {
-        if (empty($this->ci->db) || ! is_object($this->ci->db))
-        {
-            return false;
-        }
-
-        $query = $this->ci->db->get('settings');
-
-        if (! $query->num_rows())
-        {
-            return false;
-        }
-
-        return $query->result_array();
-    }
-
-    //--------------------------------------------------------------------
+	protected $ci;
+
+	protected $db;
+
+	//--------------------------------------------------------------------
+
+	public function __construct( $ci=null )
+	{
+		if (is_object($ci))
+		{
+			$this->ci =& $ci;
+		}
+		else {
+			$this->ci =& get_instance();
+		}
+
+		// Ensure that the database is loaded.
+		if (empty($this->ci->db))
+		{
+			$this->ci->load->database();
+		}
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Inserts or Replaces an setting value.
+	 *
+	 * @param $key
+	 * @param null $value
+	 * @param string $group
+	 * @return bool
+	 */
+	public function save($key, $value=null, $group='app')
+	{
+		if (empty($this->ci->db) || ! is_object($this->ci->db))
+		{
+			return false;
+		}
+
+		$where = [
+			'name'  => $key,
+			'group' => $group
+		];
+		$this->ci->db->delete('settings', $where);
+
+		if (is_array($value) || is_object($value))
+		{
+			$value = serialize($value);
+		}
+
+		$data = [
+			'name'  => $key,
+			'value' => $value,
+			'group' => $group
+		];
+		return $this->ci->db->insert('settings', $data);
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Retrieves a single item.
+	 *
+	 * @param $key
+	 * @param string $group
+	 * @return mixed
+	 */
+	public function get($key, $group='app')
+	{
+		if (empty($this->ci->db) || ! is_object($this->ci->db))
+		{
+			return false;
+		}
+
+		$where = [
+			'name'  => $key,
+			'group' => $group
+		];
+
+		$query = $this->ci->db->where($where)
+							  ->get('settings');
+
+		if (! $query->num_rows())
+		{
+			return false;
+		}
+
+		$value = $query->row()->value;
+
+		// Check to see if it needs to be unserialized
+		$data = @unserialize($value);   // We don't need to issue an E_NOTICE here...
+
+		// Check for a value of false or
+		if ($value === 'b:0;' || $data !== false)
+		{
+			$value = $data;
+		}
+
+		return $value;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Deletes a single item.
+	 *
+	 * @param $key
+	 * @param $group
+	 * @return mixed
+	 */
+	public function delete($key, $group='app')
+	{
+		if (empty($this->ci->db) || ! is_object($this->ci->db))
+		{
+			return false;
+		}
+
+		$where = [
+			'name'  => $key,
+			'group' => $group
+		];
+
+		return $this->ci->db->delete('settings', $where);
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Searches the store for any items with $field = $value.
+	 *
+	 * @param $field
+	 * @param $value
+	 * @return mixed
+	 */
+	public function findBy($field, $value)
+	{
+		if (empty($this->ci->db) || ! is_object($this->ci->db))
+		{
+			return false;
+		}
+
+		$query = $this->ci->db->where($field, $value)
+							  ->get('settings');
+
+		if (! $query->num_rows())
+		{
+			return false;
+		}
+
+		return $query->result_array();
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Retrieves all items in the store either globally or for a single group.
+	 *
+	 * @param string $group
+	 * @return mixed
+	 */
+	public function all($group=null)
+	{
+		if (empty($this->ci->db) || ! is_object($this->ci->db))
+		{
+			return false;
+		}
+
+		$query = $this->ci->db->get('settings');
+
+		if (! $query->num_rows())
+		{
+			return false;
+		}
+
+		return $query->result_array();
+	}
+
+	//--------------------------------------------------------------------
 }

myth/Settings/Settings.php

Indentation +277 added lines, -277 removed lines

@@ -1,34 +1,34 @@ 
 <?php namespace Myth\Settings;
 /**
- * Sprint
- *
- * A set of power tools to enhance the CodeIgniter framework and provide consistent workflow.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- * THE SOFTWARE.
- *
- * @package     Sprint
- * @author      Lonnie Ezell
- * @copyright   Copyright 2014-2015, New Myth Media, LLC (http://newmythmedia.com)
- * @license     http://opensource.org/licenses/MIT  (MIT)
- * @link        http://sprintphp.com
- * @since       Version 1.0
- */
+	 * Sprint
+	 *
+	 * A set of power tools to enhance the CodeIgniter framework and provide consistent workflow.
+	 *
+	 * Permission is hereby granted, free of charge, to any person obtaining a copy
+	 * of this software and associated documentation files (the "Software"), to deal
+	 * in the Software without restriction, including without limitation the rights
+	 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+	 * copies of the Software, and to permit persons to whom the Software is
+	 * furnished to do so, subject to the following conditions:
+	 *
+	 * The above copyright notice and this permission notice shall be included in
+	 * all copies or substantial portions of the Software.
+	 *
+	 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+	 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+	 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+	 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+	 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+	 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+	 * THE SOFTWARE.
+	 *
+	 * @package     Sprint
+	 * @author      Lonnie Ezell
+	 * @copyright   Copyright 2014-2015, New Myth Media, LLC (http://newmythmedia.com)
+	 * @license     http://opensource.org/licenses/MIT  (MIT)
+	 * @link        http://sprintphp.com
+	 * @since       Version 1.0
+	 */
 
 /**
  * Class Settings
@@ -40,253 +40,253 @@ 
  */
 class Settings {
 
-    /**
-     * Holds instantiated data stores.
-     *
-     * @var array
-     */
-    protected static $stores = [];
-
-    protected static $default_store = '';
-
-    protected static $initialized = false;
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Fires up instances of the datastores and gets us ready to roll.
-     */
-    public static function init()
-    {
-        if (self::$initialized === true)
-        {
-            return;
-        }
-
-        // Load up and instantiate our setting stores.
-        $user_stores = config_item('settings.stores');
-
-        if (is_array($user_stores))
-        {
-            foreach ($user_stores as $alias => $class)
-            {
-                self::$stores[ strtolower($alias) ] = new $class();
-            }
-        }
-
-        self::$default_store = config_item('settings.default_store');
-
-        if (empty(self::$stores[ self::$default_store ]))
-        {
-            show_error( lang('settings.bad_default') );
-        }
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Inserts/Replaces a single setting item.
-     *
-     * @param $key
-     * @param null $value
-     * @param string $group
-     * @param string $store
-     */
-    public static function save($key, $value=null, $group='app', $store=null)
-    {
-        self::init();
-
-        if (empty($store) || empty(self::$stores[$store]))
-        {
-            // we've already determined that the default store exists
-            // in the init() method.
-            $store = self::$default_store;
-        }
-
-        return self::$stores[ $store ]->save($key, $value, $group);
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Retrieves a single item. If not $store is specified, will loop
-     * through the stores in order until it finds it. If $store is
-     * specified, will only look within that store for it.
-     *
-     * @param $key
-     * @param string $group
-     * @param string $store
-     * @return mixed
-     */
-    public static function get($key, $group='app', $store=null)
-    {
-        self::init();
-
-        $group = strtolower($group);
-
-        // If the store is specified but doesn't exist, crap out
-        // so that they developer has a chance to fix it.
-        if (! is_null($store) && empty(self::$stores[$store]))
-        {
-            show_error( sprintf( lang('settings.cant_retrieve'), $store ) );
-        }
-
-        // If $store is set, get the value from that store only.
-        if (! empty($store))
-        {
-            return self::$stores[$store]->get($key, $group);
-        }
-
-        // Otherwise loop through each store until we find it
-        foreach (self::$stores as $s)
-        {
-            if ($found = $s->get($key, $group))
-            {
-                return $found;
-            }
-        }
-
-        // Still here... guess we didn't find anything, then...
-        return false;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Deletes a single item.
-     *
-     * @param $key
-     * @param $group
-     * @param $store
-     * @return mixed
-     */
-    public static function delete($key, $group='app', $store=null)
-    {
-        self::init();
-
-        $group = strtolower($group);
-
-        // If the store is specified but doesn't exist, crap out
-        // so that they developer has a chance to fix it.
-        if (! is_null($store) && empty(self::$stores[$store]))
-        {
-            show_error( sprintf( lang('settings.cant_retrieve'), $store ) );
-        }
-
-        // If $store is set, get the value from that store only.
-        if (! empty($store))
-        {
-            return self::$stores[$store]->delete($key, $group);
-        }
-
-        // Otherwise delete from the default store
-        return self::$stores[ self::$default_store ]->delete($key, $group);
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Searches the store for any items with $field = $value.
-     *
-     * @param $field
-     * @param $value
-     * @return mixed
-     */
-    public static function findBy($field, $value)
-    {
-        self::init();
-
-        foreach (self::$stores as $s)
-        {
-            if ($found = $s->findBy($field, $value))
-            {
-                return $found;
-            }
-        }
-
-        return false;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Retrieves all items in the store either globally or for a single group.
-     *
-     * @param string $group
-     * @return mixed
-     */
-    public static function all($group=null, $store=null)
-    {
-        self::init();
-
-        $group = strtolower($group);
-
-        if (! empty($store))
-        {
-            return self::$stores[ $store ]->all($group);
-        }
-
-        // Otherwise combine the results from all stores
-        $results = [];
-
-        foreach (self::$stores as $s)
-        {
-            $found = $s->all($group);
-            if ($found)
-            {
-                $results = array_merge($results, (array)$found);
-            }
-        }
-
-        return $results;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Appends a new datastore the end of the curent stores.
-     *
-     * @param $alias
-     * @param $class
-     * @return bool
-     */
-    public static function addStore($alias, $class)
-    {
-        self::init();
-
-        if (class_exists($class))
-        {
-            self::$stores[ strtolower($alias) ] = new $class();
-            return true;
-        }
-
-        return false;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Removes a datastore from the list of stores currently available.
-     *
-     * @param $alias
-     * @return bool
-     */
-    public static function removeStore($alias)
-    {
-        self::init();
-
-        $alias = strtolower($alias);
-
-        if (empty(self::$stores[$alias]))
-        {
-            return false;
-        }
-
-        unset(self::$stores[$alias]);
-
-        return true;
-    }
-
-    //--------------------------------------------------------------------
+	/**
+	 * Holds instantiated data stores.
+	 *
+	 * @var array
+	 */
+	protected static $stores = [];
+
+	protected static $default_store = '';
+
+	protected static $initialized = false;
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Fires up instances of the datastores and gets us ready to roll.
+	 */
+	public static function init()
+	{
+		if (self::$initialized === true)
+		{
+			return;
+		}
+
+		// Load up and instantiate our setting stores.
+		$user_stores = config_item('settings.stores');
+
+		if (is_array($user_stores))
+		{
+			foreach ($user_stores as $alias => $class)
+			{
+				self::$stores[ strtolower($alias) ] = new $class();
+			}
+		}
+
+		self::$default_store = config_item('settings.default_store');
+
+		if (empty(self::$stores[ self::$default_store ]))
+		{
+			show_error( lang('settings.bad_default') );
+		}
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Inserts/Replaces a single setting item.
+	 *
+	 * @param $key
+	 * @param null $value
+	 * @param string $group
+	 * @param string $store
+	 */
+	public static function save($key, $value=null, $group='app', $store=null)
+	{
+		self::init();
+
+		if (empty($store) || empty(self::$stores[$store]))
+		{
+			// we've already determined that the default store exists
+			// in the init() method.
+			$store = self::$default_store;
+		}
+
+		return self::$stores[ $store ]->save($key, $value, $group);
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Retrieves a single item. If not $store is specified, will loop
+	 * through the stores in order until it finds it. If $store is
+	 * specified, will only look within that store for it.
+	 *
+	 * @param $key
+	 * @param string $group
+	 * @param string $store
+	 * @return mixed
+	 */
+	public static function get($key, $group='app', $store=null)
+	{
+		self::init();
+
+		$group = strtolower($group);
+
+		// If the store is specified but doesn't exist, crap out
+		// so that they developer has a chance to fix it.
+		if (! is_null($store) && empty(self::$stores[$store]))
+		{
+			show_error( sprintf( lang('settings.cant_retrieve'), $store ) );
+		}
+
+		// If $store is set, get the value from that store only.
+		if (! empty($store))
+		{
+			return self::$stores[$store]->get($key, $group);
+		}
+
+		// Otherwise loop through each store until we find it
+		foreach (self::$stores as $s)
+		{
+			if ($found = $s->get($key, $group))
+			{
+				return $found;
+			}
+		}
+
+		// Still here... guess we didn't find anything, then...
+		return false;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Deletes a single item.
+	 *
+	 * @param $key
+	 * @param $group
+	 * @param $store
+	 * @return mixed
+	 */
+	public static function delete($key, $group='app', $store=null)
+	{
+		self::init();
+
+		$group = strtolower($group);
+
+		// If the store is specified but doesn't exist, crap out
+		// so that they developer has a chance to fix it.
+		if (! is_null($store) && empty(self::$stores[$store]))
+		{
+			show_error( sprintf( lang('settings.cant_retrieve'), $store ) );
+		}
+
+		// If $store is set, get the value from that store only.
+		if (! empty($store))
+		{
+			return self::$stores[$store]->delete($key, $group);
+		}
+
+		// Otherwise delete from the default store
+		return self::$stores[ self::$default_store ]->delete($key, $group);
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Searches the store for any items with $field = $value.
+	 *
+	 * @param $field
+	 * @param $value
+	 * @return mixed
+	 */
+	public static function findBy($field, $value)
+	{
+		self::init();
+
+		foreach (self::$stores as $s)
+		{
+			if ($found = $s->findBy($field, $value))
+			{
+				return $found;
+			}
+		}
+
+		return false;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Retrieves all items in the store either globally or for a single group.
+	 *
+	 * @param string $group
+	 * @return mixed
+	 */
+	public static function all($group=null, $store=null)
+	{
+		self::init();
+
+		$group = strtolower($group);
+
+		if (! empty($store))
+		{
+			return self::$stores[ $store ]->all($group);
+		}
+
+		// Otherwise combine the results from all stores
+		$results = [];
+
+		foreach (self::$stores as $s)
+		{
+			$found = $s->all($group);
+			if ($found)
+			{
+				$results = array_merge($results, (array)$found);
+			}
+		}
+
+		return $results;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Appends a new datastore the end of the curent stores.
+	 *
+	 * @param $alias
+	 * @param $class
+	 * @return bool
+	 */
+	public static function addStore($alias, $class)
+	{
+		self::init();
+
+		if (class_exists($class))
+		{
+			self::$stores[ strtolower($alias) ] = new $class();
+			return true;
+		}
+
+		return false;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Removes a datastore from the list of stores currently available.
+	 *
+	 * @param $alias
+	 * @return bool
+	 */
+	public static function removeStore($alias)
+	{
+		self::init();
+
+		$alias = strtolower($alias);
+
+		if (empty(self::$stores[$alias]))
+		{
+			return false;
+		}
+
+		unset(self::$stores[$alias]);
+
+		return true;
+	}
+
+	//--------------------------------------------------------------------
 
 }

myth/Settings/SettingsStoreInterface.php

Indentation +44 added lines, -44 removed lines

@@ -40,58 +40,58 @@
  */
 interface SettingsStoreInterface {
 
-    /**
-     * Inserts/Replaces a single setting item.
-     *
-     * @param $key
-     * @param null $value
-     * @param string $group
-     */
-    public function save($key, $value=null, $group='app');
+	/**
+	 * Inserts/Replaces a single setting item.
+	 *
+	 * @param $key
+	 * @param null $value
+	 * @param string $group
+	 */
+	public function save($key, $value=null, $group='app');
 
-    //--------------------------------------------------------------------
+	//--------------------------------------------------------------------
 
-    /**
-     * Retrieves a single item.
-     *
-     * @param $key
-     * @param string $group
-     * @return mixed
-     */
-    public function get($key, $group='app');
+	/**
+	 * Retrieves a single item.
+	 *
+	 * @param $key
+	 * @param string $group
+	 * @return mixed
+	 */
+	public function get($key, $group='app');
 
-    //--------------------------------------------------------------------
+	//--------------------------------------------------------------------
 
-    /**
-     * Deletes a single item.
-     *
-     * @param $key
-     * @param $group
-     * @return mixed
-     */
-    public function delete($key, $group='app');
+	/**
+	 * Deletes a single item.
+	 *
+	 * @param $key
+	 * @param $group
+	 * @return mixed
+	 */
+	public function delete($key, $group='app');
 
-    //--------------------------------------------------------------------
+	//--------------------------------------------------------------------
 
-    /**
-     * Searches the store for any items with $field = $value.
-     *
-     * @param $field
-     * @param $value
-     * @return mixed
-     */
-    public function findBy($field, $value);
+	/**
+	 * Searches the store for any items with $field = $value.
+	 *
+	 * @param $field
+	 * @param $value
+	 * @return mixed
+	 */
+	public function findBy($field, $value);
 
-    //--------------------------------------------------------------------
+	//--------------------------------------------------------------------
 
-    /**
-     * Retrieves all items in the store either globally or for a single group.
-     *
-     * @param string $group
-     * @return mixed
-     */
-    public function all($group=null);
+	/**
+	 * Retrieves all items in the store either globally or for a single group.
+	 *
+	 * @param string $group
+	 * @return mixed
+	 */
+	public function all($group=null);
 
-    //--------------------------------------------------------------------
+	//--------------------------------------------------------------------
 
 }

myth/Themers/MetaCollection.php

Indentation +213 added lines, -213 removed lines

@@ -35,219 +35,219 @@
 
 class MetaCollection implements MetaInterface {
 
-    /**
-     * Stores the meta values the user has set.
-     *
-     * @var array
-     */
-    protected $meta = [];
-
-    /**
-     * Stores the standard meta-value names
-     * Mostly here for reference, I guess.
-     *
-     * @var array
-     */
-    protected $std_meta = [
-        'application-name',
-        'author',
-        'copyright',
-        'description',
-        'generator',
-        'keywords',
-        'robots',
-        'googlebot'
-    ];
-
-    /**
-     * Stores the HTTP-Equiv meta tags
-     * since they need to be rendered differently.
-     *
-     * @var array
-     */
-    protected $http_equiv_meta = [
-        'cache-control',
-        'content-language',
-        'content-type',
-        'default-style',
-        'expires',
-        'pragma',
-        'refresh',
-        'set-cookie'
-    ];
-
-    /**
-     * Stores the document's character encoding.
-     *
-     * @var string
-     */
-    public $charset = 'utf-8';
-
-    //--------------------------------------------------------------------
-
-    public function __construct($ci)
-    {
-        $ci->config->load('html_meta', true);
-
-        $config = $ci->config->item('html_meta');
-
-        $this->meta = $config['meta'];
-
-        $this->http_equiv_meta = array_merge($this->http_equiv_meta, $config['http-equiv']);
-    }
-
-    //--------------------------------------------------------------------
-
-
-    /**
-     * Sets a single meta item.
-     * $alias can also be an array of key/value pairs to set.
-     *
-     * @param string|array $alias
-     * @param null $value
-     *
-     * @return mixed
-     */
-    public function set($alias, $value=null, $escape=true)
-    {
-        if (is_array($alias))
-        {
-            foreach ($alias as $key => $val)
-            {
-                $this->set($key, $val);
-            }
-
-            return $this;
-        }
-
-        // Charset
-        if (strtolower($alias) == 'charset')
-        {
-            $this->charset = $value;
-
-            return $this;
-        }
-
-        $this->meta[ strtolower($alias) ] = $escape ? esc($value, 'htmlAttr') : $value;
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Returns a single meta item.
-     *
-     * @param $alias
-     *
-     * @return mixed
-     */
-    public function get($alias)
-    {
-        $alias = strtolower($alias);
-
-        return isset($this->meta[ $alias ]) ? $this->meta[$alias] : null;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Renders out all defined meta tags.
-     *
-     * @return mixed
-     */
-    public function renderTags()
-    {
-        if (! count($this->meta))
-        {
-            return null;
-        }
-
-        $output = '';
-
-        // Character Encoding
-        $output .= "\t<meta charset=\"{$this->charset}\" >";
-
-        // Everything else
-        foreach ($this->meta as $name => $content)
-        {
-            if (is_array($content))
-            {
-                $content = implode(',', $content);
-            }
-
-            if (empty($content))
-            {
-                continue;
-            }
-
-            // Http Equivalent meta tags.
-            if (in_array($name, $this->http_equiv_meta))
-            {
-                $output .= "\t<meta http-equiv=\"{$name}\" content=\"{$content}\">\n";
-            }
-            // Standard Meta Tag
-            else {
-                $output .= "\t<meta name=\"{$name}\" content=\"{$content}\">\n";
-            }
-        }
-
-        return $output;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Registers a new HTTP Equivalent meta tag so it can be
-     * rendered out properly.
-     *
-     * @param $name
-     *
-     * @return $this
-     */
-    public function registerHTTPEquivTag($name)
-    {
-        if (is_null($name))
-        {
-            return $this;
-        }
-
-        $this->http_equiv_meta[] = strtolower($name);
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-
-
-    /**
-     * Convenience implementation to set a value
-     * as if it was a property of the class.
-     *
-     * @param $alias
-     * @param null $value
-     */
-    public function __set($alias, $value=null)
-    {
-        $this->set($alias, $value);
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Convenience method to access a value
-     * as if it was a property of the class.
-     *
-     * @param $alias
-     *
-     * @return mixed
-     */
-    public function __get($alias)
-    {
-        return $this->get($alias);
-    }
-
-    //--------------------------------------------------------------------
+	/**
+	 * Stores the meta values the user has set.
+	 *
+	 * @var array
+	 */
+	protected $meta = [];
+
+	/**
+	 * Stores the standard meta-value names
+	 * Mostly here for reference, I guess.
+	 *
+	 * @var array
+	 */
+	protected $std_meta = [
+		'application-name',
+		'author',
+		'copyright',
+		'description',
+		'generator',
+		'keywords',
+		'robots',
+		'googlebot'
+	];
+
+	/**
+	 * Stores the HTTP-Equiv meta tags
+	 * since they need to be rendered differently.
+	 *
+	 * @var array
+	 */
+	protected $http_equiv_meta = [
+		'cache-control',
+		'content-language',
+		'content-type',
+		'default-style',
+		'expires',
+		'pragma',
+		'refresh',
+		'set-cookie'
+	];
+
+	/**
+	 * Stores the document's character encoding.
+	 *
+	 * @var string
+	 */
+	public $charset = 'utf-8';
+
+	//--------------------------------------------------------------------
+
+	public function __construct($ci)
+	{
+		$ci->config->load('html_meta', true);
+
+		$config = $ci->config->item('html_meta');
+
+		$this->meta = $config['meta'];
+
+		$this->http_equiv_meta = array_merge($this->http_equiv_meta, $config['http-equiv']);
+	}
+
+	//--------------------------------------------------------------------
+
+
+	/**
+	 * Sets a single meta item.
+	 * $alias can also be an array of key/value pairs to set.
+	 *
+	 * @param string|array $alias
+	 * @param null $value
+	 *
+	 * @return mixed
+	 */
+	public function set($alias, $value=null, $escape=true)
+	{
+		if (is_array($alias))
+		{
+			foreach ($alias as $key => $val)
+			{
+				$this->set($key, $val);
+			}
+
+			return $this;
+		}
+
+		// Charset
+		if (strtolower($alias) == 'charset')
+		{
+			$this->charset = $value;
+
+			return $this;
+		}
+
+		$this->meta[ strtolower($alias) ] = $escape ? esc($value, 'htmlAttr') : $value;
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Returns a single meta item.
+	 *
+	 * @param $alias
+	 *
+	 * @return mixed
+	 */
+	public function get($alias)
+	{
+		$alias = strtolower($alias);
+
+		return isset($this->meta[ $alias ]) ? $this->meta[$alias] : null;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Renders out all defined meta tags.
+	 *
+	 * @return mixed
+	 */
+	public function renderTags()
+	{
+		if (! count($this->meta))
+		{
+			return null;
+		}
+
+		$output = '';
+
+		// Character Encoding
+		$output .= "\t<meta charset=\"{$this->charset}\" >";
+
+		// Everything else
+		foreach ($this->meta as $name => $content)
+		{
+			if (is_array($content))
+			{
+				$content = implode(',', $content);
+			}
+
+			if (empty($content))
+			{
+				continue;
+			}
+
+			// Http Equivalent meta tags.
+			if (in_array($name, $this->http_equiv_meta))
+			{
+				$output .= "\t<meta http-equiv=\"{$name}\" content=\"{$content}\">\n";
+			}
+			// Standard Meta Tag
+			else {
+				$output .= "\t<meta name=\"{$name}\" content=\"{$content}\">\n";
+			}
+		}
+
+		return $output;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Registers a new HTTP Equivalent meta tag so it can be
+	 * rendered out properly.
+	 *
+	 * @param $name
+	 *
+	 * @return $this
+	 */
+	public function registerHTTPEquivTag($name)
+	{
+		if (is_null($name))
+		{
+			return $this;
+		}
+
+		$this->http_equiv_meta[] = strtolower($name);
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
+
+	/**
+	 * Convenience implementation to set a value
+	 * as if it was a property of the class.
+	 *
+	 * @param $alias
+	 * @param null $value
+	 */
+	public function __set($alias, $value=null)
+	{
+		$this->set($alias, $value);
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Convenience method to access a value
+	 * as if it was a property of the class.
+	 *
+	 * @param $alias
+	 *
+	 * @return mixed
+	 */
+	public function __get($alias)
+	{
+		return $this->get($alias);
+	}
+
+	//--------------------------------------------------------------------
 
 
 

myth/Themers/MetaInterface.php

Indentation +38 added lines, -38 removed lines

@@ -33,50 +33,50 @@
 
 interface MetaInterface {
 
-    /**
-     * Sets a single meta item.
-     *
-     * @param $alias
-     * @param null $value
-     *
-     * @return mixed
-     */
-    public function set($alias, $value=null);
+	/**
+	 * Sets a single meta item.
+	 *
+	 * @param $alias
+	 * @param null $value
+	 *
+	 * @return mixed
+	 */
+	public function set($alias, $value=null);
 
-    //--------------------------------------------------------------------
+	//--------------------------------------------------------------------
 
-    /**
-     * Returns a single meta item.
-     *
-     * @param $alias
-     *
-     * @return mixed
-     */
-    public function get($alias);
+	/**
+	 * Returns a single meta item.
+	 *
+	 * @param $alias
+	 *
+	 * @return mixed
+	 */
+	public function get($alias);
 
-    //--------------------------------------------------------------------
+	//--------------------------------------------------------------------
 
-    /**
-     * Renders out all defined meta tags.
-     *
-     * @param array $show_tags
-     *
-     * @return mixed
-     */
-    public function renderTags();
+	/**
+	 * Renders out all defined meta tags.
+	 *
+	 * @param array $show_tags
+	 *
+	 * @return mixed
+	 */
+	public function renderTags();
 
-    //--------------------------------------------------------------------
+	//--------------------------------------------------------------------
 
-    /**
-     * Registers a new HTTP Equivalent meta tag so it can be
-     * rendered out properly.
-     *
-     * @param $name
-     *
-     * @return $this
-     */
-    public function registerHTTPEquivTag($name);
+	/**
+	 * Registers a new HTTP Equivalent meta tag so it can be
+	 * rendered out properly.
+	 *
+	 * @param $name
+	 *
+	 * @return $this
+	 */
+	public function registerHTTPEquivTag($name);
 
-    //--------------------------------------------------------------------
+	//--------------------------------------------------------------------
 
 }
\ No newline at end of file