Move to service, new namespace, default config

Author: MGatner

src/Config/Alerts.php.example renamed to Alerts.php.example

@@ -12,18 +12,18 @@
 
 use CodeIgniter\Config\BaseConfig;
 
-class Alerts extends BaseConfig
+class Alerts extends \Tatter\Alerts\Config
 {
 	// prefix for SESSION variables and HTML classes, to prevent collision
-	public $prefix = "alerts-";
+	public $prefix = "alerts-";	
 
 /*
 	Template to use for HTML output
-	Make sure there is a corresponding view file for the path/namespace provided
+	There must be a corresponding view file for the path/namespace provided
 	Native support for:
-		Basic - a minimalist layout internal to this library
-		Bootstrap (default) - [https://getbootstrap.com/docs/4.0/components/alerts/#dismissing]
-		Foundation - [https://foundation.zurb.com/sites/docs/callout.html#making-closable]
+		basic - a minimalist layout internal to this library
+		bootstrap (default) - [https://getbootstrap.com/docs/4.0/components/alerts/#dismissing]
+		foundation - [https://foundation.zurb.com/sites/docs/callout.html#making-closable]
 */
-	public $template = "Tatter\bootstrap";
+	public $template = "Tatter\Alerts\Views\bootstrap";
 }

composer.json

@@ -26,7 +26,7 @@
 	},
 	"autoload": {
 		"psr-4": {
-			"Tatter\\": "src"
+			"Tatter\\Alerts\\": "src"
 		}
 	},
 	"scripts": {

src/Alerts.php

@@ -0,0 +1,120 @@
+<?php namespace Tatter\Alerts;
+
+/***
+* Name: Alerts
+* Author: Matthew Gatner
+* Contact: mgatner@tattersoftware.com
+* Created: 2019-02-13
+*
+* Description:  Lightweight user notification library for CodeIgniter 4
+*
+* Requirements:
+* 	>= PHP 7.1
+* 	>= CodeIgniter 4.0
+*	CodeIgniter's Session Library (loaded automatically)
+*
+* Configuration:
+* 	Use Config/Alerts.php to override default behavior
+*
+* @package CodeIgniter4-Alerts
+* @author Matthew Gatner
+* @link https://github.com/tattersoftware/codeigniter4-alerts
+*
+***/
+
+use CodeIgniter\Config\BaseConfig;
+use CodeIgniter\Config\Services;
+use Tatter\Alerts\Exceptions\AlertsException;
+
+/*** CLASS ***/
+class Alerts {
+
+	/**
+	 * Our configuration instance.
+	 *
+	 * @var \Tatter\Alerts\Config\Alerts
+	 */
+	protected $config;
+
+	/**
+	 * The view engine to render the alerts with.
+	 *
+	 * @var RendererInterface
+	 */
+	protected $view;
+
+	/**
+	 * The active user session, for loading and storing alerts.
+	 *
+	 * @var \CodeIgniter\Session\Session
+	 */
+	protected $session;	
+
+	// initiate library, check for existing session
+	public function __construct(BaseConfig $config, RendererInterface $view = null)
+	{
+		// save configuration
+		$this->config = $config;
+
+		// initiate the Session library
+		$this->session = Services::session();
+		
+		// verify renderer
+		if ($view instanceof RendererInterface)
+			$this->view = $view;
+		else
+			$this->view = Services::renderer();
+		
+		// validations
+		if (empty($this->config->template))
+			throw AlertsException::forInvalidTemplate('');
+
+		$locator = Services::locator();
+		if (! $locator->locateFile($this->config->template))
+			throw AlertsException::forMissingTemplateView($this->config->template);
+	}
+	
+	// add a new alert to the queue
+	public function add($class, $text)
+	{
+		$alert = [
+			'class' => $class,
+			'text' => $text
+		];
+		
+		// start the queue if it doesn't exist
+		if (! $this->session->has($this->config->prefix . 'queue'))
+			$this->session->set($this->config->prefix . 'queue', [$alert]);
+		
+		// push onto the queue if it was already there
+		else
+			$this->session->push($this->config->prefix . 'queue', [$alert]);
+		
+		return;
+	}
+
+	// clears the queue and returns template formatted alerts
+	public function display()
+	{	
+		// get any alerts
+		$alerts = $this->session->get($this->config->prefix . 'queue') ?? [ ];
+	
+		// clear alerts
+		$this->session->remove($this->config->prefix . 'queue');
+		
+		if (empty($alerts))
+			return;
+		
+		// render the specified view template
+		return $this->view->setVar('prefix', $this->config->prefix)
+			->setVar('alerts', $alerts)
+			->render($this->config->template);
+	}
+	
+	// returns default CSS as inline style sheet
+	// should be injected into <head>
+	public function css()
+	{
+		return $this->view->setVar('prefix', $this->config->prefix)->render("Tatter\Alerts\Views\css");
+	}	
+}

src/Config/Alerts.php

@@ -0,0 +1,12 @@
+<?php namespace Tatter\Alerts\Config;
+
+use CodeIgniter\Config\BaseConfig;
+
+class Alerts extends BaseConfig
+{
+	// prefix for SESSION variables and HTML classes, to prevent collision
+	public $prefix = "alerts-";	
+
+	// Template to use for HTML output
+	public $template = "Tatter\Alerts\Views\bootstrap";
+}

src/Config/Services.php

@@ -0,0 +1,25 @@
+<?php namespace Tatter\Alerts\Config;
+
+use CodeIgniter\Config\BaseService;
+use CodeIgniter\View\RendererInterface;
+
+class Services extends BaseService
+{
+    public static function alerts(BaseConfig $config = null, RendererInterface $view = null, bool $getShared = true)
+    {
+		if ($getShared):
+			return static::getSharedInstance('alerts', $config, $view);
+		endif;
+
+		// prioritizes user config in app/Config if found
+		if (empty($config)):
+			if (class_exists('\Config\Alerts')):
+				$config = new \Config\Alerts();
+			else:
+				$config = new \Tatter\Alerts\Config\Alerts();
+			endif;
+		endif;
+
+		return new \Tatter\Alerts\Alerts($config, $view);
+	}
+}

src/Exceptions/AlertsException.php

@@ -0,0 +1,16 @@
+<?php namespace Tatter\Alerts\Exceptions;
+
+use CodeIgniter\Exceptions\ExceptionInterface;
+use CodeIgniter\Exceptions\FrameworkException;
+
+class AlertsException extends FrameworkException implements ExceptionInterface
+{
+	public static function forInvalidTemplate(string $template = null)
+	{
+		return new static("'{$template}' is not a valid Alerts template.");
+	}
+	public static function forMissingTemplateView(string $template = null)
+	{
+		return new static("Could not find template view file: '{$template}'.");
+	}
+}

src/Helpers/alerts_helper.php

@@ -2,38 +2,18 @@
 
 /***
 *
-* This file contains optional helper functions to make calling the library easier.
+* This file contains the optional wrapper helper functions to make calling the library easier.
 * Recommended usage:
 *	1. Load the helper with `helper("alerts")`
 *	2. Use `alert($class, $text) to add a new user alert
-*	3. Call `alertsCss()` in <head> for a basic CSS layout, or provide your own
-*	4. Call `alertsDisplay()` wherever you want alerts (usually after main nav/banner)
 *
 ***/
 
 if (! function_exists('alert'))
 {
 	// add a new alert to the queue
 	function alert(string $class, string $text) {
-		$alerts = new Tatter\Libraries\Alerts();
+		$alerts = service('alerts');
 		$alerts->add($class, $text);
 	}
 }
-
-if (! function_exists('alertsCss'))
-{
-	// returns pre-configured CSS as inline style sheet
-	function alertsCss() {
-		$alerts = new Tatter\Libraries\Alerts();
-		return $alerts->css();	
-	}
-}
-
-if (! function_exists('alerts'))
-{
-	// returns all queue alerts and clears the queue
-	function alerts() {
-		$alerts = new Tatter\Libraries\Alerts();
-		return $alerts->display();	
-	}
-}