Move to service, default config, HTML Helper

Author: MGatner

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

@@ -13,21 +13,21 @@
 
 use CodeIgniter\Config\BaseConfig;
 
-class Assets extends BaseConfig
+class Assets extends \Tatter\Assets\Config
 {
-	// override location of asset files in the filesystem
-	public $fsbase  = FCPATH."assets/";
+	// location of asset files in the filesystem
+	public $fileBase  = FCPATH . "assets/";
 
-	// override location of asset files URL
-	public $webbase = "https://example.com/assets/";
+	// location of asset files via URL
+	public $webBase =  base_url('assets/');
 
 	// additional assets to load per route - no leading/trailing slashes
 	public $routes = [
 		"" => [
 			"bootstrap/dist/css/bootstrap.min.css",
 			"bootstrap/dist/js/bootstrap.bundle.min.js",
 		],
-		"home" => [
+		"upload" => [
 			"dropzone/dropzone.min.css",
 			"dropzone/dropzone.min.js",
 		],

src/Assets.php

@@ -11,7 +11,7 @@
 * Requirements:
 * 	>= PHP 7.2
 * 	>= CodeIgniter 4.0
-*	CodeIgniter's Filesystem and URL helpers (loaded automatically)
+*	CodeIgniter's Filesystem, HTML, and URL helpers (loaded automatically)
 *
 * Configuration:
 * 	Use Config/Assets.php for location overrides and custom route assets
@@ -24,29 +24,30 @@
 *
 ***/
 
+use CodeIgniter\Config\BaseConfig;
 use CodeIgniter\Config\Services;
+use Tatter\Assets\Exceptions\AssetsException;
 
 /*** CLASS ***/
 class Assets
 {
-	protected $fsbase;
-	protected $webbase;
-	protected $routes;
+	/**
+	 * Our configuration instance.
+	 *
+	 * @var \Tatter\Assets\Config\Assets
+	 */
+	protected $config;
 
 	// initiate library, check for existing session
 	public function __construct($config = null)
 	{
 		// load required helpers
 		helper("filesystem");
+		helper("html");
 		helper("url");
 
-		// load optional configuration
-		$config = $config ?? config('Assets', false);
-		
-		// set parameters by config override or use default
-		$this->fsbase = $config->fsbase ?? FCPATH."assets/";
-		$this->webbase = $config->webbase ?? base_url()."assets/";
-		$this->routes = $config->routes ?? [ ];
+		// save configuration
+		$this->config = $config;
 	}
 
 	// returns route-relevant and preconfigured assets of a given extension
@@ -56,7 +57,7 @@ public function display(string $extension)
 		if (! in_array($extension, ['css', 'js']))
 			return false;
 
-		// output all matched files as tags
+		// buffer all matched files as tags
 		$buffer = "<!-- Local ".strtoupper($extension)." files -->".PHP_EOL;
 		foreach ($this->routed($extension) as $file)
 			$buffer .= $this->tag($file).PHP_EOL;
@@ -66,43 +67,44 @@ public function display(string $extension)
 	// outputs a formatted tag for a single file
 	public function displayFile(string $file)
 	{
-		if (! file_exists($this->fsbase . $file))
+		if (! file_exists($this->config->fileBase . $file))
 			return false;
 		return $this->tag($file).PHP_EOL;		
 	}
 
-	// given (an existing) file, formats it as a vlid tag
+	// given (an existing) file, formats it as a valid tag
 	protected function tag(string $file)
 	{
-		$path = $this->fsbase . $file;
+		$path = $this->config->fileBase . $file;
 
 		// get file extension
 		$extension = strtolower(pathinfo($path, PATHINFO_EXTENSION));
 
 		// use last modified time for version control
 		$version = filemtime($path);
 
+		// build the URL
+		$url = $this->config->webBase . $file . "?v=" . $version;
+		
 		// create extension-specific tag
 		switch ($extension):
 			case "css":
-				$tag = "<link rel='stylesheet' href='{$this->webbase}{$file}?v={$version}' type='text/css' />";
+				return link_tag($url);
 			break;
 
 			case "js":
-				$tag = "<script type='text/javascript' src='{$this->webbase}{$file}?v={$version}'></script>";
+				return script_tag($url);
 			break;
 
 			case "img":
 				$alt = ucfirst(pathinfo($path, PATHINFO_FILENAME));
-				$tag = "<img src='{$this->webbase}{$file}?v={$version}' alt='{$alt}' />";
+				return img($url, false, ['alt' => $alt]);
 			break;
 
 			default:
-				throw new \Exception("Unsupported file extension: {$extension}");
+				throw AssetsException::forUnsupportExtension($extension);
 
 		endswitch;
-		
-		return $tag;
 	}
 
 	// checks route-relevant folders and pre-configured array for relevant files with given extension
@@ -115,44 +117,46 @@ protected function routed($extension)
 
 		// get the controller (controllerName less its namespace)
 		// accounts for default route and subdirectories
-		$controller = str_replace([$routes->getDefaultNamespace(), '\\'], "", $router->controllerName());
+		$controller = str_replace([$routes->getDefaultNamespace(), '\\'], '', $router->controllerName());
 
 		// start the route from the controller
 		$segments = explode(PATH_SEPARATOR, $controller);
 
 		// add the method
 		$segments[] = $router->methodName();
 
-		// add file-safe versions of parameters
+		// add file-safe versions of any parameters
 		foreach ($router->params() as $param)
 			$segments[] = url_title($param);
 
 		// always start at base
-		array_unshift($segments, "");
+		array_unshift($segments, '');
 
 		// lowercase everything
-		$segments = array_map("strtolower", $segments);
+		$segments = array_map('strtolower', $segments);
 
 		// incrementally check each segment for files (matching this extension)
-		$route = "";
+		$route = '';
 		$files = [ ];
 		foreach ($segments as $segment):
-			$route = empty($route)? $segment : $route."/".$segment; //prevents double slashes
+			$route = empty($route)? $segment : $route . '/' . $segment; //prevents double slashes
 
-			// check for custom assets from config
+			// check for custom assets from config first
 			if (! empty($this->routes[$route]) ):
 				foreach ($this->routes[$route] as $item):
+					// make sure the extensions match
 					if (is_string($item) && strtolower(pathinfo($item, PATHINFO_EXTENSION))==strtolower($extension)):
 						$files[] = $item;
 					endif;
 				endforeach;
 			endif;
 
 			// check filesystem for matching assets
-			if ($items = directory_map($this->fsbase . $route, 1)):
+			if ($items = directory_map($this->config->fileBase . $route, 1)):
 				foreach ($items as $item):
+					// make sure the extensions match
 					if (strtolower(pathinfo($item, PATHINFO_EXTENSION))==strtolower($extension)):
-						$files[] = empty($route)? $item : $route."/".$item;
+						$files[] = empty($route)? $item : $route . '/' . $item;
 					endif;
 				endforeach;
 			endif;
@@ -161,5 +165,4 @@ protected function routed($extension)
 
 		return array_unique($files);
 	}
-	
 }

src/Config/Assets.php

@@ -0,0 +1,15 @@
+<?php namespace Tatter\Assets\Config;
+
+use CodeIgniter\Config\BaseConfig;
+
+class Assets extends BaseConfig
+{
+	// location of asset files in the filesystem
+	public $fileBase  = FCPATH . "assets/";
+	
+	// location of asset files via URL
+	public $webBase =  base_url('assets/');
+	
+	// additional assets to load per route - no leading/trailing slashes
+	public $routes = [ ];
+}

src/Config/Services.php

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

src/Exceptions/AssetsException.php

@@ -0,0 +1,12 @@
+<?php namespace Tatter\Assets\Exceptions;
+
+use CodeIgniter\Exceptions\ExceptionInterface;
+use CodeIgniter\Exceptions\FrameworkException;
+
+class AssetsException extends FrameworkException implements ExceptionInterface
+{
+	public static function forUnsupportExtension(string $extension = null)
+	{
+		return new static("Unsupported file extension: '{$extension}'");
+	}
+}