ci-bonfire / Sprint

myth/Mail/BaseMailer.php

Indentation +283 added lines, -283 removed lines

@@ -40,290 +40,290 @@
  */
 class BaseMailer {
 
-    /**
-     * How the email is delivered.
-     * Either 'send' or 'queue'.
-     * @var string
-     */
-    protected $action = 'send';
-
-    protected $from     = null;
-    protected $to       = null;
-    protected $reply_to = null;
-    protected $cc       = null;
-    protected $bcc      = null;
-
-    protected $message  = null;
-
-    protected $theme    = 'email';
-    protected $layout   = 'index';
-    protected $view     = null;
-
-    /**
-     * The MailService to use. If NULL
-     * will use the system default.
-     * @var null
-     */
-    protected $service_name  = null;
-
-    protected $service = null;
-
-    /**
-     * Used for theming the email messages.
-     * @var null
-     */
-    protected $themer = null;
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Constructor
-     *
-     * Simply allows us to override the default settings for this mailer.
-     *
-     * @param null $options
-     */
-    public function __construct($options=null)
-    {
-        if (! empty($options))
-        {
-            $this->setOptions($options);
-        }
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets the basic options available to the mailer, like 'from', 'to',
-     * 'cc', 'bcc', etc.
-     *
-     * @param $options
-     */
-    public function setOptions($options)
-    {
-        if (is_array($options))
-        {
-            foreach ($options as $key => $value)
-            {
-                if ($key == 'service')
-                {
-                    $this->service =& $value;
-                    continue;
-                }
-
-                if (property_exists($this, $key))
-                {
-                    $this->$key = $value;
-                }
-            }
-        }
-    }
-
-    //--------------------------------------------------------------------
-
-
-
-    /**
-     * Sends an email immediately using the system-defined MailService.
-     *
-     * @param string $to // Who the email is being sent to.
-     * @param string $subject // The subject line for the email
-     * @param strign $data // the key/value pairs to send to the views.
-     * @param string $view // You can override the view used for the email here.
-     *                          // You can change themes by prepending theme name
-     *                          // like: 'newtheme:newview'
-     *
-     * @return bool
-     */
-    public function send($to, $subject, $data=[], $view=null)
-    {
-        // Are we pretending to send?
-        if (config_item('mail.pretend') === true)
-        {
-            return true;
-        }
-
-        $this->startMailService();
-
-        $this->service->to($to);
-        $this->service->subject($subject);
-
-        if (is_array($this->from)) {
-            $this->service->from($this->from[0], $this->from[1]);
-        }
-        else
-        {
-            $this->service->from($this->from);
-        }
-
-        if (! empty($this->cc))         $this->service->cc($this->cc);
-        if (! empty($this->bcc))        $this->service->bcc($this->bcc);
-
-        if (is_array($this->reply_to)) {
-            $this->service->reply_to($this->reply_to[0], $this->reply_to[1]);
-        }
-        else
-        {
-            $this->service->reply_to($this->reply_to);
-        }
-
-
-        // Determine the view to use. We have to hack this a bit with
-        // the debug_backtrace, though, to make it all function in the background.
-        list(, $method) = debug_backtrace(false);
-
-        $view = 'emails/'. strtolower( (new \ReflectionClass($this))->getShortName() ) .'/'. $method['function'];
-
-        // Get our message's text and html versions based on which files exist...
-        $basepath = APPPATH .'views/'. $view;
-
-        // Is a text version available?
-        if (file_exists($basepath .'.text.php'))
-        {
-            $text = $this->load->view($view .'.text.php', $data, true);
-            $this->service->text_message($text);
-        }
-
-        // If an html version is around, we need to theme it out
-        if (file_exists($basepath .'.html.php'))
-        {
-            $this->startThemer();
-
-            $this->themer->setTheme($this->theme);
-
-            // Determine the correct layout to use
-            $layout = ! empty($this->layout) ? $this->layout : NULL;
-            $this->themer->setLayout($layout);
-
-            $this->themer->set($data);
-
-            // Render the view into a var we can pass to the layout.
-            $content = $this->themer->display($view .'.html.php');
-
-            $this->themer->set('content', $content);
-
-            $this->service->html_message( $this->themer->display($this->theme .':'. $layout) );
-        }
-
-        if (! $this->service->send() )
-        {
-            // todo do something here
-            return false;
-        }
-
-        return true;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Allows you to customize the headers sent with the email. You can
-     * do them one at a time by passing $field and $value, or pass an array
-     * of $field => $value pairs as the first parameter.
-     *
-     * @param string|array  $field
-     * @param string        $value
-     */
-    public function header($field, $value=null)
-    {
-        $this->startMailService();
-
-        $this->service->setHeader($field, $value);
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * 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->startMailService();
-
-        $this->service->attach($filename, $disposition, $newname, $mime);
-    }
-
-    //--------------------------------------------------------------------
-
-    //--------------------------------------------------------------------
-    // Private Methods
-    //--------------------------------------------------------------------
-
-    /**
-     * Starts up the service name specified in $service_name.
-     *
-     * @param $service_name
-     */
-    protected function startMailService()
-    {
-        // Only once!
-        if (! empty($this->service) && is_object($this->service))
-        {
-            return;
-        }
-
-        $service_name = ! empty($this->service_name) ? $this->service_name : config_item('mail.default_service');
-
-        if (! class_exists($service_name))
-        {
-            throw new \RuntimeException( sprintf( lang('mail.invalid_service'), $service_name) );
-        }
-
-        $this->service = new $service_name();
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Fires up the default themer so we can use it to theme our HTML messages.
-     */
-    protected function startThemer()
-    {
-        /*
+	/**
+	 * How the email is delivered.
+	 * Either 'send' or 'queue'.
+	 * @var string
+	 */
+	protected $action = 'send';
+
+	protected $from     = null;
+	protected $to       = null;
+	protected $reply_to = null;
+	protected $cc       = null;
+	protected $bcc      = null;
+
+	protected $message  = null;
+
+	protected $theme    = 'email';
+	protected $layout   = 'index';
+	protected $view     = null;
+
+	/**
+	 * The MailService to use. If NULL
+	 * will use the system default.
+	 * @var null
+	 */
+	protected $service_name  = null;
+
+	protected $service = null;
+
+	/**
+	 * Used for theming the email messages.
+	 * @var null
+	 */
+	protected $themer = null;
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Constructor
+	 *
+	 * Simply allows us to override the default settings for this mailer.
+	 *
+	 * @param null $options
+	 */
+	public function __construct($options=null)
+	{
+		if (! empty($options))
+		{
+			$this->setOptions($options);
+		}
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets the basic options available to the mailer, like 'from', 'to',
+	 * 'cc', 'bcc', etc.
+	 *
+	 * @param $options
+	 */
+	public function setOptions($options)
+	{
+		if (is_array($options))
+		{
+			foreach ($options as $key => $value)
+			{
+				if ($key == 'service')
+				{
+					$this->service =& $value;
+					continue;
+				}
+
+				if (property_exists($this, $key))
+				{
+					$this->$key = $value;
+				}
+			}
+		}
+	}
+
+	//--------------------------------------------------------------------
+
+
+
+	/**
+	 * Sends an email immediately using the system-defined MailService.
+	 *
+	 * @param string $to // Who the email is being sent to.
+	 * @param string $subject // The subject line for the email
+	 * @param strign $data // the key/value pairs to send to the views.
+	 * @param string $view // You can override the view used for the email here.
+	 *                          // You can change themes by prepending theme name
+	 *                          // like: 'newtheme:newview'
+	 *
+	 * @return bool
+	 */
+	public function send($to, $subject, $data=[], $view=null)
+	{
+		// Are we pretending to send?
+		if (config_item('mail.pretend') === true)
+		{
+			return true;
+		}
+
+		$this->startMailService();
+
+		$this->service->to($to);
+		$this->service->subject($subject);
+
+		if (is_array($this->from)) {
+			$this->service->from($this->from[0], $this->from[1]);
+		}
+		else
+		{
+			$this->service->from($this->from);
+		}
+
+		if (! empty($this->cc))         $this->service->cc($this->cc);
+		if (! empty($this->bcc))        $this->service->bcc($this->bcc);
+
+		if (is_array($this->reply_to)) {
+			$this->service->reply_to($this->reply_to[0], $this->reply_to[1]);
+		}
+		else
+		{
+			$this->service->reply_to($this->reply_to);
+		}
+
+
+		// Determine the view to use. We have to hack this a bit with
+		// the debug_backtrace, though, to make it all function in the background.
+		list(, $method) = debug_backtrace(false);
+
+		$view = 'emails/'. strtolower( (new \ReflectionClass($this))->getShortName() ) .'/'. $method['function'];
+
+		// Get our message's text and html versions based on which files exist...
+		$basepath = APPPATH .'views/'. $view;
+
+		// Is a text version available?
+		if (file_exists($basepath .'.text.php'))
+		{
+			$text = $this->load->view($view .'.text.php', $data, true);
+			$this->service->text_message($text);
+		}
+
+		// If an html version is around, we need to theme it out
+		if (file_exists($basepath .'.html.php'))
+		{
+			$this->startThemer();
+
+			$this->themer->setTheme($this->theme);
+
+			// Determine the correct layout to use
+			$layout = ! empty($this->layout) ? $this->layout : NULL;
+			$this->themer->setLayout($layout);
+
+			$this->themer->set($data);
+
+			// Render the view into a var we can pass to the layout.
+			$content = $this->themer->display($view .'.html.php');
+
+			$this->themer->set('content', $content);
+
+			$this->service->html_message( $this->themer->display($this->theme .':'. $layout) );
+		}
+
+		if (! $this->service->send() )
+		{
+			// todo do something here
+			return false;
+		}
+
+		return true;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Allows you to customize the headers sent with the email. You can
+	 * do them one at a time by passing $field and $value, or pass an array
+	 * of $field => $value pairs as the first parameter.
+	 *
+	 * @param string|array  $field
+	 * @param string        $value
+	 */
+	public function header($field, $value=null)
+	{
+		$this->startMailService();
+
+		$this->service->setHeader($field, $value);
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * 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->startMailService();
+
+		$this->service->attach($filename, $disposition, $newname, $mime);
+	}
+
+	//--------------------------------------------------------------------
+
+	//--------------------------------------------------------------------
+	// Private Methods
+	//--------------------------------------------------------------------
+
+	/**
+	 * Starts up the service name specified in $service_name.
+	 *
+	 * @param $service_name
+	 */
+	protected function startMailService()
+	{
+		// Only once!
+		if (! empty($this->service) && is_object($this->service))
+		{
+			return;
+		}
+
+		$service_name = ! empty($this->service_name) ? $this->service_name : config_item('mail.default_service');
+
+		if (! class_exists($service_name))
+		{
+			throw new \RuntimeException( sprintf( lang('mail.invalid_service'), $service_name) );
+		}
+
+		$this->service = new $service_name();
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Fires up the default themer so we can use it to theme our HTML messages.
+	 */
+	protected function startThemer()
+	{
+		/*
          * Setup our Template Engine
          */
-        $themer = config_item('active_themer');
-
-        if (empty($themer)) {
-            throw new \RuntimeException( lang('no_themer') );
-        }
-
-        if (empty($this->themer))
-        {
-            $this->themer = new $themer( get_instance() );
-        }
-
-        // Register our paths with the themer
-        $paths = config_item('theme.paths');
-
-        foreach ($paths as $key => $path) {
-            $this->themer->addThemePath($key, $path);
-        }
-
-        // Set our default theme.
-        $this->themer->setDefaultTheme( 'email' );
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * __get magic
-     *
-     * Allows models to access CI's loaded classes using the same
-     * syntax as controllers.
-     *
-     * @param	string	$key
-     */
-    public function __get($key)
-    {
-        return get_instance()->$key;
-    }
-
-    //--------------------------------------------------------------------
+		$themer = config_item('active_themer');
+
+		if (empty($themer)) {
+			throw new \RuntimeException( lang('no_themer') );
+		}
+
+		if (empty($this->themer))
+		{
+			$this->themer = new $themer( get_instance() );
+		}
+
+		// Register our paths with the themer
+		$paths = config_item('theme.paths');
+
+		foreach ($paths as $key => $path) {
+			$this->themer->addThemePath($key, $path);
+		}
+
+		// Set our default theme.
+		$this->themer->setDefaultTheme( 'email' );
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * __get magic
+	 *
+	 * Allows models to access CI's loaded classes using the same
+	 * syntax as controllers.
+	 *
+	 * @param	string	$key
+	 */
+	public function __get($key)
+	{
+		return get_instance()->$key;
+	}
+
+	//--------------------------------------------------------------------
 
 }

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