ci-bonfire / Sprint

myth/Mail/CIMailService.php

Indentation +222 added lines, -222 removed lines

@@ -40,226 +40,226 @@
  */
 class CIMailService implements MailServiceInterface {
 
-    protected $ci = null;
-
-    protected $format = 'html';
-
-    //--------------------------------------------------------------------
-
-    public function __construct()
-    {
-        $this->ci =& get_instance();
-
-        $this->ci->load->library('email');
-    }
-
-    //--------------------------------------------------------------------
-
-
-    /**
-     * Does the actual delivery of a message.
-     *
-     * @param bool  $clear_after    If TRUE, will reset the class after sending.
-     *
-     * @return mixed
-     */
-    public function send($clear_after=true)
-    {
-        $this->ci->email->mailtype = $this->format;
-
-        $result = $this->ci->email->send(false);
-
-        return $result;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Adds an attachment to the current email that is being built.
-     *
-     * @param string    $filename
-     * @param string    $disposition    like 'inline'. Default is 'attachment'
-     * @param string    $newname        If you'd like to rename the file for delivery
-     * @param string    $mime           Custom defined mime type.
-     */
-    public function attach($filename, $disposition=null, $newname=null, $mime=null)
-    {
-        $this->ci->email->attach($filename, $disposition, $newname, $mime);
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets a header value for the email. Not every service will provide this.
-     *
-     * @param $field
-     * @param $value
-     * @return mixed
-     */
-    public function setHeader($field, $value)
-    {
-        $this->ci->email->set_header($field, $value);
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-
-    //--------------------------------------------------------------------
-    // Options
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets the email address to send the email to.
-     *
-     * @param $email
-     * @return mixed
-     */
-    public function to($email)
-    {
-        $this->ci->email->to($email);
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets who the email is coming from.
-     *
-     * @param $email
-     * @param null $name
-     * @return mixed
-     */
-    public function from($email, $name=null)
-    {
-        $this->ci->email->from($email, $name);
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets a single additional email address to 'cc'.
-     *
-     * @param $email
-     * @return mixed
-     */
-    public function cc($email)
-    {
-        $this->ci->email->cc($email);
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets a single email address to 'bcc' to.
-     *
-     * @param $email
-     * @return mixed
-     */
-    public function bcc($email)
-    {
-        $this->ci->email->bcc($email);
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets the reply to address.
-     *
-     * @param $email
-     * @return mixed
-     */
-    public function reply_to($email, $name=null)
-    {
-        $this->ci->email->reply_to($email, $name);
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets the subject line of the email.
-     *
-     * @param $subject
-     * @return mixed
-     */
-    public function subject($subject)
-    {
-        $this->ci->email->subject($subject);
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets the HTML portion of the email address. Optional.
-     *
-     * @param $message
-     * @return mixed
-     */
-    public function html_message($message)
-    {
-        $this->ci->email->message($message);
-
-        $this->format = 'html';
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets the text portion of the email address. Optional.
-     *
-     * @param $message
-     * @return mixed
-     */
-    public function text_message($message)
-    {
-        $this->ci->email->set_alt_message($message);
-
-        $this->format = 'text';
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets the format to send the email in. Either 'html' or 'text'.
-     *
-     * @param $format
-     * @return mixed
-     */
-    public function format($format)
-    {
-        $this->format = $format;
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-    /**
-     * Resets the state to blank, ready for a new email. Useful when
-     * sending emails in a loop and you need to make sure that the
-     * email is reset.
-     *
-     * @param bool $clear_attachments
-     * @return mixed
-     */
-    public function reset($clear_attachments=true)
-    {
-        $this->ci->email->clear($clear_attachments);
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
+	protected $ci = null;
+
+	protected $format = 'html';
+
+	//--------------------------------------------------------------------
+
+	public function __construct()
+	{
+		$this->ci =& get_instance();
+
+		$this->ci->load->library('email');
+	}
+
+	//--------------------------------------------------------------------
+
+
+	/**
+	 * Does the actual delivery of a message.
+	 *
+	 * @param bool  $clear_after    If TRUE, will reset the class after sending.
+	 *
+	 * @return mixed
+	 */
+	public function send($clear_after=true)
+	{
+		$this->ci->email->mailtype = $this->format;
+
+		$result = $this->ci->email->send(false);
+
+		return $result;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Adds an attachment to the current email that is being built.
+	 *
+	 * @param string    $filename
+	 * @param string    $disposition    like 'inline'. Default is 'attachment'
+	 * @param string    $newname        If you'd like to rename the file for delivery
+	 * @param string    $mime           Custom defined mime type.
+	 */
+	public function attach($filename, $disposition=null, $newname=null, $mime=null)
+	{
+		$this->ci->email->attach($filename, $disposition, $newname, $mime);
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets a header value for the email. Not every service will provide this.
+	 *
+	 * @param $field
+	 * @param $value
+	 * @return mixed
+	 */
+	public function setHeader($field, $value)
+	{
+		$this->ci->email->set_header($field, $value);
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
+	//--------------------------------------------------------------------
+	// Options
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets the email address to send the email to.
+	 *
+	 * @param $email
+	 * @return mixed
+	 */
+	public function to($email)
+	{
+		$this->ci->email->to($email);
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets who the email is coming from.
+	 *
+	 * @param $email
+	 * @param null $name
+	 * @return mixed
+	 */
+	public function from($email, $name=null)
+	{
+		$this->ci->email->from($email, $name);
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets a single additional email address to 'cc'.
+	 *
+	 * @param $email
+	 * @return mixed
+	 */
+	public function cc($email)
+	{
+		$this->ci->email->cc($email);
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets a single email address to 'bcc' to.
+	 *
+	 * @param $email
+	 * @return mixed
+	 */
+	public function bcc($email)
+	{
+		$this->ci->email->bcc($email);
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets the reply to address.
+	 *
+	 * @param $email
+	 * @return mixed
+	 */
+	public function reply_to($email, $name=null)
+	{
+		$this->ci->email->reply_to($email, $name);
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets the subject line of the email.
+	 *
+	 * @param $subject
+	 * @return mixed
+	 */
+	public function subject($subject)
+	{
+		$this->ci->email->subject($subject);
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets the HTML portion of the email address. Optional.
+	 *
+	 * @param $message
+	 * @return mixed
+	 */
+	public function html_message($message)
+	{
+		$this->ci->email->message($message);
+
+		$this->format = 'html';
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets the text portion of the email address. Optional.
+	 *
+	 * @param $message
+	 * @return mixed
+	 */
+	public function text_message($message)
+	{
+		$this->ci->email->set_alt_message($message);
+
+		$this->format = 'text';
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets the format to send the email in. Either 'html' or 'text'.
+	 *
+	 * @param $format
+	 * @return mixed
+	 */
+	public function format($format)
+	{
+		$this->format = $format;
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+	/**
+	 * Resets the state to blank, ready for a new email. Useful when
+	 * sending emails in a loop and you need to make sure that the
+	 * email is reset.
+	 *
+	 * @param bool $clear_attachments
+	 * @return mixed
+	 */
+	public function reset($clear_attachments=true)
+	{
+		$this->ci->email->clear($clear_attachments);
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
 }

myth/Mail/LogMailService.php

Indentation +314 added lines, -314 removed lines

@@ -1,34 +1,34 @@ 
 <?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
+	 */
 
 /**
  * Class LogMailService
@@ -40,289 +40,289 @@ 
  */
 class LogMailService implements MailServiceInterface {
 
-    protected $ci = null;
-
-    protected $format = 'html';
-    protected $headers = [];
-    protected $subject = null;
-
-    protected $html_message = null;
-    protected $text_message = null;
-
-    //--------------------------------------------------------------------
-
-    public function __construct()
-    {
-        $this->ci =& get_instance();
-
-        $this->ci->load->library('email');
-    }
-
-    //--------------------------------------------------------------------
-
-
-    /**
-     * Does the actual delivery of a message. In this case, though, we simply
-     * write the html and text files out to the log folder/emails.
-     *
-     * The filename format is: yyyymmddhhiiss_email.{format}
-     *
-     * @param bool  $clear_after    If TRUE, will reset the class after sending.
-     *
-     * @return mixed
-     */
-    public function send($clear_after=true)
-    {
-
-        // Ensure we have enough data
-        if (empty($this->to) || empty($this->subject) ||
-            (empty($this->html_message) && empty($this->text_message))
-        )
-        {
-            throw new \RuntimeException( lang('mail.invalid_log_data') );
-        }
-
-        $symbols = ['#', '%', '&', '{', '}', '\\', '/', '<', '>', '*', '?', ' ', '$', '!', '\'', '"', ':', '@', '+', '`', '='];
-
-        $email = str_replace($symbols, '.', strtolower($this->to) );
-
-        $filename = date('YmdHis_'). $email;
-
-        // Ensure the emails folder exists in the log folder.
-        $path = config_item('log_path');
-        $path = ! empty( $path ) ? $path : APPPATH .'logs/';
-        $path = rtrim($path, '/ ') .'/email/';
-
-        if (! is_dir($path))
-        {
-            mkdir($path, 0777, true);
-        }
-
-        get_instance()->load->helper('file');
-
-        // Write our HTML file out
-        if (! empty($this->html_message) && ! write_file( $path . $filename . '.html', $this->html_message ) )
-        {
-            throw new \RuntimeException( sprintf( lang('mail.error_html_log'), $path, $filename) );
-        }
-
-        // Write our TEXT file out
-        if (! empty($this->text_message) && ! write_file( $path . $filename . '.txt', $this->text_message ) )
-        {
-            throw new \RuntimeException( sprintf( lang('mail.error_text_log'), $path, $filename) );
-        }
-
-        return true;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Adds an attachment to the current email that is being built.
-     *
-     * @param string    $filename
-     * @param string    $disposition    like 'inline'. Default is 'attachment'
-     * @param string    $newname        If you'd like to rename the file for delivery
-     * @param string    $mime           Custom defined mime type.
-     */
-    public function attach($filename, $disposition=null, $newname=null, $mime=null)
-    {
-        return;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets a header value for the email. Not every service will provide this.
-     *
-     * @param $field
-     * @param $value
-     * @return mixed
-     */
-    public function setHeader($field, $value)
-    {
-        $this->headers[$field] = $value;
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-
-    //--------------------------------------------------------------------
-    // Options
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets the email address to send the email to.
-     *
-     * @param $email
-     * @return mixed
-     */
-    public function to($email)
-    {
-        $this->to = $email;
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets who the email is coming from.
-     *
-     * @param $email
-     * @param null $name
-     * @return mixed
-     */
-    public function from($email, $name=null)
-    {
-        if (! empty($name))
-        {
-            $this->from = [$email, $name];
-        }
-        else
-        {
-            $this->from = $email;
-        }
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets a single additional email address to 'cc'.
-     *
-     * @param $email
-     * @return mixed
-     */
-    public function cc($email)
-    {
-        $this->cc = $email;
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets a single email address to 'bcc' to.
-     *
-     * @param $email
-     * @return mixed
-     */
-    public function bcc($email)
-    {
-        $this->bcc = $email;
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets the reply to address.
-     *
-     * @param $email
-     * @return mixed
-     */
-    public function reply_to($email, $name=null)
-    {
-        if (! empty($name))
-        {
-            $this->reply_to = [$email, $name];
-        }
-        else
-        {
-            $this->reply_to = $email;
-        }
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets the subject line of the email.
-     *
-     * @param $subject
-     * @return mixed
-     */
-    public function subject($subject)
-    {
-        $this->subject = $subject;
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets the HTML portion of the email address. Optional.
-     *
-     * @param $message
-     * @return mixed
-     */
-    public function html_message($message)
-    {
-        $this->html_message = $message;
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets the text portion of the email address. Optional.
-     *
-     * @param $message
-     * @return mixed
-     */
-    public function text_message($message)
-    {
-        $this->text_message = $message;
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets the format to send the email in. Either 'html' or 'text'.
-     *
-     * @param $format
-     * @return mixed
-     */
-    public function format($format)
-    {
-        $this->format = $format;
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-    /**
-     * Resets the state to blank, ready for a new email. Useful when
-     * sending emails in a loop and you need to make sure that the
-     * email is reset.
-     *
-     * @param bool $clear_attachments
-     * @return mixed
-     */
-    public function reset($clear_attachments=true)
-    {
-        $this->to = null;
-        $this->from = null;
-        $this->reply_to = null;
-        $this->cc = null;
-        $this->bcc = null;
-        $this->subject = null;
-        $this->html_message = null;
-        $this->text_message = null;
-        $this->headers = [];
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
+	protected $ci = null;
+
+	protected $format = 'html';
+	protected $headers = [];
+	protected $subject = null;
+
+	protected $html_message = null;
+	protected $text_message = null;
+
+	//--------------------------------------------------------------------
+
+	public function __construct()
+	{
+		$this->ci =& get_instance();
+
+		$this->ci->load->library('email');
+	}
+
+	//--------------------------------------------------------------------
+
+
+	/**
+	 * Does the actual delivery of a message. In this case, though, we simply
+	 * write the html and text files out to the log folder/emails.
+	 *
+	 * The filename format is: yyyymmddhhiiss_email.{format}
+	 *
+	 * @param bool  $clear_after    If TRUE, will reset the class after sending.
+	 *
+	 * @return mixed
+	 */
+	public function send($clear_after=true)
+	{
+
+		// Ensure we have enough data
+		if (empty($this->to) || empty($this->subject) ||
+			(empty($this->html_message) && empty($this->text_message))
+		)
+		{
+			throw new \RuntimeException( lang('mail.invalid_log_data') );
+		}
+
+		$symbols = ['#', '%', '&', '{', '}', '\\', '/', '<', '>', '*', '?', ' ', '$', '!', '\'', '"', ':', '@', '+', '`', '='];
+
+		$email = str_replace($symbols, '.', strtolower($this->to) );
+
+		$filename = date('YmdHis_'). $email;
+
+		// Ensure the emails folder exists in the log folder.
+		$path = config_item('log_path');
+		$path = ! empty( $path ) ? $path : APPPATH .'logs/';
+		$path = rtrim($path, '/ ') .'/email/';
+
+		if (! is_dir($path))
+		{
+			mkdir($path, 0777, true);
+		}
+
+		get_instance()->load->helper('file');
+
+		// Write our HTML file out
+		if (! empty($this->html_message) && ! write_file( $path . $filename . '.html', $this->html_message ) )
+		{
+			throw new \RuntimeException( sprintf( lang('mail.error_html_log'), $path, $filename) );
+		}
+
+		// Write our TEXT file out
+		if (! empty($this->text_message) && ! write_file( $path . $filename . '.txt', $this->text_message ) )
+		{
+			throw new \RuntimeException( sprintf( lang('mail.error_text_log'), $path, $filename) );
+		}
+
+		return true;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Adds an attachment to the current email that is being built.
+	 *
+	 * @param string    $filename
+	 * @param string    $disposition    like 'inline'. Default is 'attachment'
+	 * @param string    $newname        If you'd like to rename the file for delivery
+	 * @param string    $mime           Custom defined mime type.
+	 */
+	public function attach($filename, $disposition=null, $newname=null, $mime=null)
+	{
+		return;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets a header value for the email. Not every service will provide this.
+	 *
+	 * @param $field
+	 * @param $value
+	 * @return mixed
+	 */
+	public function setHeader($field, $value)
+	{
+		$this->headers[$field] = $value;
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
+	//--------------------------------------------------------------------
+	// Options
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets the email address to send the email to.
+	 *
+	 * @param $email
+	 * @return mixed
+	 */
+	public function to($email)
+	{
+		$this->to = $email;
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets who the email is coming from.
+	 *
+	 * @param $email
+	 * @param null $name
+	 * @return mixed
+	 */
+	public function from($email, $name=null)
+	{
+		if (! empty($name))
+		{
+			$this->from = [$email, $name];
+		}
+		else
+		{
+			$this->from = $email;
+		}
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets a single additional email address to 'cc'.
+	 *
+	 * @param $email
+	 * @return mixed
+	 */
+	public function cc($email)
+	{
+		$this->cc = $email;
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets a single email address to 'bcc' to.
+	 *
+	 * @param $email
+	 * @return mixed
+	 */
+	public function bcc($email)
+	{
+		$this->bcc = $email;
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets the reply to address.
+	 *
+	 * @param $email
+	 * @return mixed
+	 */
+	public function reply_to($email, $name=null)
+	{
+		if (! empty($name))
+		{
+			$this->reply_to = [$email, $name];
+		}
+		else
+		{
+			$this->reply_to = $email;
+		}
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets the subject line of the email.
+	 *
+	 * @param $subject
+	 * @return mixed
+	 */
+	public function subject($subject)
+	{
+		$this->subject = $subject;
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets the HTML portion of the email address. Optional.
+	 *
+	 * @param $message
+	 * @return mixed
+	 */
+	public function html_message($message)
+	{
+		$this->html_message = $message;
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets the text portion of the email address. Optional.
+	 *
+	 * @param $message
+	 * @return mixed
+	 */
+	public function text_message($message)
+	{
+		$this->text_message = $message;
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets the format to send the email in. Either 'html' or 'text'.
+	 *
+	 * @param $format
+	 * @return mixed
+	 */
+	public function format($format)
+	{
+		$this->format = $format;
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+	/**
+	 * Resets the state to blank, ready for a new email. Useful when
+	 * sending emails in a loop and you need to make sure that the
+	 * email is reset.
+	 *
+	 * @param bool $clear_attachments
+	 * @return mixed
+	 */
+	public function reset($clear_attachments=true)
+	{
+		$this->to = null;
+		$this->from = null;
+		$this->reply_to = null;
+		$this->cc = null;
+		$this->bcc = null;
+		$this->subject = null;
+		$this->html_message = null;
+		$this->text_message = null;
+		$this->headers = [];
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
 }

myth/Mail/Mail.php

Indentation +165 added lines, -165 removed lines

@@ -1,172 +1,172 @@
 <?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
+	 */
 
 class Mail {
 
-    /**
-     * Sends an email, using an existing Mailer, which can
-     * be found in application/mailers/. The mailer is the one responsible
-     * for determining whether the email will be sent immediately or queued
-     * to be sent later.
-     *
-     * The $mailer_name must include both the mailer name as well as the
-     * task, separated by a single colon:
-     *      'UserMailer:newUser'
-     *
-     * @param $mailer_name
-     * @param array $params
-     * @param array $options
-     * @return mixed
-     */
-    public static function deliver($mailer_name, $params=[], $options=[])
-    {
-        // Protect users from themselves here.
-        str_replace('::', ':', $mailer_name);
-
-        // Try to load our mailer class.
-        list($class, $method) = explode(':', $mailer_name);
-
-        if (! is_file(APPPATH .'mailers/'. $class .'.php'))
-        {
-            throw new \RuntimeException( sprintf( lang('mail.cant_find_mailer'), $class) );
-        }
-
-        require_once APPPATH .'mailers/'. $class .'.php';
-
-        if (! class_exists($class, false))
-        {
-            throw new \RuntimeException( sprintf( lang('errors.cant_instantiate'), $class) );
-        }
-
-        $mailer = new $class( $options );
-
-        if (! method_exists($mailer, $method))
-        {
-            throw new \BadMethodCallException( sprintf( lang('mail.invalid_mailer_method'), $class, $method) );
-        }
-
-        // try to deliver the mail, but don't send back the contents
-        // since we don't want to force the mailers to return anything.
-        if (call_user_func_array([$mailer, $method], $params) )
-        {
-            return true;
-        }
-
-        return false;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Adds an item to the email queue to be sent out next time.
-     *
-     * @param string $mailer_name
-     * @param array $params
-     * @param array $options
-     * @param \Myth\Mail\Queue $queue
-     *
-     * @return mixed
-     */
-    public static function queue($mailer_name, $params=[], $options=[], &$queue=null)
-    {
-        $data = [
-            'mailer'    => $mailer_name,
-            'params'    => serialize($params),
-            'options'   => serialize($options)
-        ];
-
-        if (empty($queue))
-        {
-            $queue = new \Myth\Mail\Queue();
-        }
-
-        return $queue->insert($data);
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Processes the Email queue sending out emails in chunks.
-     * Typically used in a cronjob to send out all queued emails.
-     *
-     * @param int $chunk_size   // How many emails to send per batch.
-     * @return string           // The output of the cronjob...
-     */
-    public static function process($chunk_size=50, &$db=null)
-    {
-        if (empty($db))
-        {
-            $db = new \Myth\Mail\Queue();
-        }
-
-        // Grab our batch of emails to process
-        $queue = $db->find_many_by('sent', 0);
-
-        if (! $queue)
-        {
-            // We didn't have an error, we simply
-            // didn't have anything to do.
-            return true;
-        }
-
-        $output = 'Started processing email Queue at '. date('Y-m-d H:i:s') .".\n\n";
-
-        foreach ($queue as $item)
-        {
-            try {
-                if (! Mail::deliver($item->mailer, unserialize($item->params), unserialize($item->options))) {
-                    $output .= '[FAILED] ';
-                } else {
-                    $data = [
-                        'sent'    => 1,
-                        'sent_on' => date('Y-m-d H:i:s')
-                    ];
-
-                    $db->update($item->id, $data);
-                }
-
-                $output .= "ID: {$item->id}, Mailer: {$item->mailer}. \n";
-            }
-            catch (\Exception $e)
-            {
-                $output .= "[EXCEPTION] ". $e->getMessage() ."\n";
-            }
-        }
-
-        $output .= "Done processing email Queue at ". date('H:i:s') .".\n";
-
-        return $output;
-    }
-
-    //--------------------------------------------------------------------
+	/**
+	 * Sends an email, using an existing Mailer, which can
+	 * be found in application/mailers/. The mailer is the one responsible
+	 * for determining whether the email will be sent immediately or queued
+	 * to be sent later.
+	 *
+	 * The $mailer_name must include both the mailer name as well as the
+	 * task, separated by a single colon:
+	 *      'UserMailer:newUser'
+	 *
+	 * @param $mailer_name
+	 * @param array $params
+	 * @param array $options
+	 * @return mixed
+	 */
+	public static function deliver($mailer_name, $params=[], $options=[])
+	{
+		// Protect users from themselves here.
+		str_replace('::', ':', $mailer_name);
+
+		// Try to load our mailer class.
+		list($class, $method) = explode(':', $mailer_name);
+
+		if (! is_file(APPPATH .'mailers/'. $class .'.php'))
+		{
+			throw new \RuntimeException( sprintf( lang('mail.cant_find_mailer'), $class) );
+		}
+
+		require_once APPPATH .'mailers/'. $class .'.php';
+
+		if (! class_exists($class, false))
+		{
+			throw new \RuntimeException( sprintf( lang('errors.cant_instantiate'), $class) );
+		}
+
+		$mailer = new $class( $options );
+
+		if (! method_exists($mailer, $method))
+		{
+			throw new \BadMethodCallException( sprintf( lang('mail.invalid_mailer_method'), $class, $method) );
+		}
+
+		// try to deliver the mail, but don't send back the contents
+		// since we don't want to force the mailers to return anything.
+		if (call_user_func_array([$mailer, $method], $params) )
+		{
+			return true;
+		}
+
+		return false;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Adds an item to the email queue to be sent out next time.
+	 *
+	 * @param string $mailer_name
+	 * @param array $params
+	 * @param array $options
+	 * @param \Myth\Mail\Queue $queue
+	 *
+	 * @return mixed
+	 */
+	public static function queue($mailer_name, $params=[], $options=[], &$queue=null)
+	{
+		$data = [
+			'mailer'    => $mailer_name,
+			'params'    => serialize($params),
+			'options'   => serialize($options)
+		];
+
+		if (empty($queue))
+		{
+			$queue = new \Myth\Mail\Queue();
+		}
+
+		return $queue->insert($data);
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Processes the Email queue sending out emails in chunks.
+	 * Typically used in a cronjob to send out all queued emails.
+	 *
+	 * @param int $chunk_size   // How many emails to send per batch.
+	 * @return string           // The output of the cronjob...
+	 */
+	public static function process($chunk_size=50, &$db=null)
+	{
+		if (empty($db))
+		{
+			$db = new \Myth\Mail\Queue();
+		}
+
+		// Grab our batch of emails to process
+		$queue = $db->find_many_by('sent', 0);
+
+		if (! $queue)
+		{
+			// We didn't have an error, we simply
+			// didn't have anything to do.
+			return true;
+		}
+
+		$output = 'Started processing email Queue at '. date('Y-m-d H:i:s') .".\n\n";
+
+		foreach ($queue as $item)
+		{
+			try {
+				if (! Mail::deliver($item->mailer, unserialize($item->params), unserialize($item->options))) {
+					$output .= '[FAILED] ';
+				} else {
+					$data = [
+						'sent'    => 1,
+						'sent_on' => date('Y-m-d H:i:s')
+					];
+
+					$db->update($item->id, $data);
+				}
+
+				$output .= "ID: {$item->id}, Mailer: {$item->mailer}. \n";
+			}
+			catch (\Exception $e)
+			{
+				$output .= "[EXCEPTION] ". $e->getMessage() ."\n";
+			}
+		}
+
+		$output .= "Done processing email Queue at ". date('H:i:s') .".\n";
+
+		return $output;
+	}
+
+	//--------------------------------------------------------------------
 
 }

myth/Mail/MailServiceInterface.php

Indentation +140 added lines, -140 removed lines

@@ -42,145 +42,145 @@
  */
 interface MailServiceInterface {
 
-    /**
-     * Does the actual delivery of a message.
-     *
-     * @param bool  $clear_after    If TRUE, will reset the class after sending.
-     *
-     * @return mixed
-     */
-    public function send($clear_after=true);
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Adds an attachment to the current email that is being built.
-     *
-     * @param string    $filename
-     * @param string    $disposition    like 'inline'. Default is 'attachment'
-     * @param string    $newname        If you'd like to rename the file for delivery
-     * @param string    $mime           Custom defined mime type.
-     */
-    public function attach($filename, $disposition=null, $newname=null, $mime=null);
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets a header value for the email. Not every service will provide this.
-     *
-     * @param $field
-     * @param $value
-     * @return mixed
-     */
-    public function setHeader($field, $value);
-
-    //--------------------------------------------------------------------
-
-    //--------------------------------------------------------------------
-    // Options
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets the email address to send the email to.
-     *
-     * @param $email
-     * @return mixed
-     */
-    public function to($email);
+	/**
+	 * Does the actual delivery of a message.
+	 *
+	 * @param bool  $clear_after    If TRUE, will reset the class after sending.
+	 *
+	 * @return mixed
+	 */
+	public function send($clear_after=true);
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Adds an attachment to the current email that is being built.
+	 *
+	 * @param string    $filename
+	 * @param string    $disposition    like 'inline'. Default is 'attachment'
+	 * @param string    $newname        If you'd like to rename the file for delivery
+	 * @param string    $mime           Custom defined mime type.
+	 */
+	public function attach($filename, $disposition=null, $newname=null, $mime=null);
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets a header value for the email. Not every service will provide this.
+	 *
+	 * @param $field
+	 * @param $value
+	 * @return mixed
+	 */
+	public function setHeader($field, $value);
+
+	//--------------------------------------------------------------------
+
+	//--------------------------------------------------------------------
+	// Options
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets the email address to send the email to.
+	 *
+	 * @param $email
+	 * @return mixed
+	 */
+	public function to($email);
     
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets who the email is coming from.
-     *
-     * @param $email
-     * @param null $name
-     * @return mixed
-     */
-    public function from($email, $name=null);
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets a single additional email address to 'cc'.
-     *
-     * @param $email
-     * @return mixed
-     */
-    public function cc($email);
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets a single email address to 'bcc' to.
-     *
-     * @param $email
-     * @return mixed
-     */
-    public function bcc($email);
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets the reply to address.
-     *
-     * @param $email
-     * @param $name
-     * @return mixed
-     */
-    public function reply_to($email, $name=null);
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets the subject line of the email.
-     *
-     * @param $subject
-     * @return mixed
-     */
-    public function subject($subject);
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets the HTML portion of the email address. Optional.
-     *
-     * @param $message
-     * @return mixed
-     */
-    public function html_message($message);
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets the text portion of the email address. Optional.
-     *
-     * @param $message
-     * @return mixed
-     */
-    public function text_message($message);
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets the format to send the email in. Either 'html' or 'text'.
-     *
-     * @param $format
-     * @return mixed
-     */
-    public function format($format);
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Resets the state to blank, ready for a new email. Useful when
-     * sending emails in a loop and you need to make sure that the
-     * email is reset.
-     *
-     * @param bool $clear_attachments
-     * @return mixed
-     */
-    public function reset($clear_attachments=true);
-
-    //--------------------------------------------------------------------
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets who the email is coming from.
+	 *
+	 * @param $email
+	 * @param null $name
+	 * @return mixed
+	 */
+	public function from($email, $name=null);
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets a single additional email address to 'cc'.
+	 *
+	 * @param $email
+	 * @return mixed
+	 */
+	public function cc($email);
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets a single email address to 'bcc' to.
+	 *
+	 * @param $email
+	 * @return mixed
+	 */
+	public function bcc($email);
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets the reply to address.
+	 *
+	 * @param $email
+	 * @param $name
+	 * @return mixed
+	 */
+	public function reply_to($email, $name=null);
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets the subject line of the email.
+	 *
+	 * @param $subject
+	 * @return mixed
+	 */
+	public function subject($subject);
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets the HTML portion of the email address. Optional.
+	 *
+	 * @param $message
+	 * @return mixed
+	 */
+	public function html_message($message);
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets the text portion of the email address. Optional.
+	 *
+	 * @param $message
+	 * @return mixed
+	 */
+	public function text_message($message);
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets the format to send the email in. Either 'html' or 'text'.
+	 *
+	 * @param $format
+	 * @return mixed
+	 */
+	public function format($format);
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Resets the state to blank, ready for a new email. Useful when
+	 * sending emails in a loop and you need to make sure that the
+	 * email is reset.
+	 *
+	 * @param bool $clear_attachments
+	 * @return mixed
+	 */
+	public function reset($clear_attachments=true);
+
+	//--------------------------------------------------------------------
 }

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/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);
 
-    //--------------------------------------------------------------------
+	//--------------------------------------------------------------------
 
 }