use renderer to return output instead of displaying

MGatner · MGatner · commit 9c0c00a79c89 · 2019-03-19T11:06:00.000-04:00
diff --git a/README.md b/README.md
@@ -9,8 +9,8 @@ Lightweight user alerts for CodeIgniter 4
 1. Run: `> composer require tatter/alerts`
 2. Load the helper: `helper("tatter\alerts");`
 2. Set an alert: `alert('success', "You did it!")`
-3. Add in head tag (optional): `alertsCss();`
-4. Add after banner/menu: `alerts();`
+3. Add in head tag (optional): `<?= alertsCss(); ?>`
+4. Add after banner/menu: `<?= alerts(); ?>`
 
 ## Features
 
@@ -38,7 +38,7 @@ If installed correctly CodeIgniter 4 will detect and autoload the library, helpe
 `helper("tatter\alerts");`
 
 Then use the helper function `alert($class, $text)` to set an alert for the user's next
-view. Use helper functions `alertCss()` and `alerts()` to output the styling and HTML
+view. Use helper functions `alertCss()` and `alerts()` to retrieve the styling and HTML
 for the alerts.
 
 ## Styles
diff --git a/src/Config/Alerts.php.example b/src/Config/Alerts.php.example
@@ -18,12 +18,12 @@ class Alerts extends BaseConfig
 	public $prefix = "alerts-";
 
 /*
-	View to use for HTML output
+	Template to use for HTML output
 	Make sure there is 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]
 */
-	public $view = "Tatter\bootstrap";
+	public $template = "Tatter\bootstrap";
 }
diff --git a/src/Helpers/alerts_helper.php b/src/Helpers/alerts_helper.php
@@ -22,18 +22,18 @@ function alert(string $class, string $text) {
 
 if (! function_exists('alertsCss'))
 {
-	// outputs pre-configured CSS as inline style sheet
+	// returns pre-configured CSS as inline style sheet
 	function alertsCss() {
 		$alerts = new Tatter\Libraries\Alerts();
-		$alerts->css();	
+		return $alerts->css();	
 	}
 }
 
 if (! function_exists('alerts'))
 {
-	// outputs all queue alerts and clears the queue
+	// returns all queue alerts and clears the queue
 	function alerts() {
 		$alerts = new Tatter\Libraries\Alerts();
-		$alerts->display();	
+		return $alerts->display();	
 	}
 }
diff --git a/src/Libraries/Alerts.php b/src/Libraries/Alerts.php
@@ -22,22 +22,36 @@
 *
 ***/
 
+use CodeIgniter\Config\Services;
+
 /*** CLASS ***/
 class Alerts {
 
 	// prefix to add to SESSION variables and HTML elements, to prevent collision
 	// can be override with Config
-	private $prefix;
+	protected $prefix;
+	
+	// view engine to render the output with
+	protected $view;
+	
+	// view template to format the output
+	protected $template;
 
 	// initiate library, check for existing session
-	public function __construct() {
+	public function __construct($config = null, RendererInterface $view = null) {
 	
 		// load optional configuration
-		$config = config('Alerts', false);
+		$config = $config ?? config('Alerts', false);
+		
+		// verify renderer
+		if ($view instanceof RendererInterface)
+			$this->view = $view;
+		else
+			$this->view = Services::renderer();
 		
 		// class-wide settings
 		$this->prefix = $config->prefix ?? "alerts-";
-		$this->view = $config->view ?? "Tatter\bootstrap";
+		$this->template = $config->template ?? "Tatter\bootstrap";
 	}
 	
 	// add a new alert to the queue
@@ -59,7 +73,7 @@ public function add($class, $text) {
 		return;
 	}
 
-	// clears the queue and displays all alerts
+	// clears the queue and returns template formatted alerts
 	public function display() {
 		$session = session();
 	
@@ -72,19 +86,16 @@ public function display() {
 		if (empty($alerts))
 			return;
 		
-		// load the specified view
-		$data = [
-			'prefix' => $this->prefix,
-			'alerts' => $alerts,
-		];
-		echo view($this->view, $data);
-
-		return;
+		// render the specified view template
+		return $this->view->setVar('prefix', $this->prefix)
+		                  ->setVar('alerts', $alerts)
+		                  ->render($this->template);
 	}
 	
-	// outputs default CSS as inline style sheet
-	// should be called in <head>
+	// returns default CSS as inline style sheet
+	// should be injected into <head>
 	public function css() {
-		echo view("Tatter\css", ['prefix' => $this->prefix]);
+		return $this->view->setVar('prefix', $this->prefix)
+		                  ->render("Tatter\css");
 	}	
 }

Original file line number	Diff line number	Diff line change
`@@ -22,18 +22,18 @@ function alert(string $class, string $text) {`
`22`	`22`
`23`	`23`	`if (! function_exists('alertsCss'))`
`24`	`24`	`{`
`25`		`- // outputs pre-configured CSS as inline style sheet`
	`25`	`+ // returns pre-configured CSS as inline style sheet`
`26`	`26`	`function alertsCss() {`
`27`	`27`	`$alerts = new Tatter\Libraries\Alerts();`
`28`		`- $alerts->css();`
	`28`	`+ return $alerts->css();`
`29`	`29`	`}`
`30`	`30`	`}`
`31`	`31`
`32`	`32`	`if (! function_exists('alerts'))`
`33`	`33`	`{`
`34`		`- // outputs all queue alerts and clears the queue`
	`34`	`+ // returns all queue alerts and clears the queue`
`35`	`35`	`function alerts() {`
`36`	`36`	`$alerts = new Tatter\Libraries\Alerts();`
`37`		`- $alerts->display();`
	`37`	`+ return $alerts->display();`
`38`	`38`	`}`
`39`	`39`	`}`