[rfc] Assets factory, manage JavaScript/StyleSheet collections and their dependency

administrator/templates/isis/component.php

@@ -18,32 +18,8 @@
 // Output as HTML5
 $doc->setHtml5(true);
 
-// Add JavaScript Frameworks
-JHtml::_('bootstrap.framework');
-
-$doc->addScriptVersion($this->baseurl . '/templates/' . $this->template . '/js/template.js');
-
-// Add Stylesheets
-$doc->addStyleSheetVersion($this->baseurl . '/templates/' . $this->template . '/css/template.css');
-
-// Load optional RTL Bootstrap CSS
-JHtml::_('bootstrap.loadCss', false, $this->direction);
-
-// Load specific language related CSS
-$file = 'language/' . $lang->getTag() . '/' . $lang->getTag() . '.css';
-
-if (is_file($file))
-{
-	$doc->addStyleSheet($file);
-}
-
-// Load custom.css
-$file = 'templates/' . $this->template . '/css/custom.css';
-
-if (is_file($file))
-{
-	$doc->addStyleSheetVersion($file);
-}
+// Load the template asset
+JHtml::_('asset.load', $doc->direction == 'rtl' ? 'template.isis.rtl' : 'template.isis.ltr');
 
 // Link color
 if ($this->params->get('linkColor'))

administrator/templates/isis/index.php

@@ -25,29 +25,8 @@
 $frontEndUri->setScheme(((int) $app->get('force_ssl', 0) === 2) ? 'https' : 'http');
 $mainPageUri = $frontEndUri->toString();
 
-// Add JavaScript Frameworks
-JHtml::_('bootstrap.framework');
-
-$doc->addScriptVersion($this->baseurl . '/templates/' . $this->template . '/js/template.js');
-
-// Add Stylesheets
-$doc->addStyleSheetVersion($this->baseurl . '/templates/' . $this->template . '/css/template' . ($this->direction == 'rtl' ? '-rtl' : '') . '.css');
-
-// Load specific language related CSS
-$languageCss = 'language/' . $lang->getTag() . '/' . $lang->getTag() . '.css';
-
-if (file_exists($languageCss) && filesize($languageCss) > 0)
-{
-	$doc->addStyleSheetVersion($languageCss);
-}
-
-// Load custom.css
-$customCss = 'templates/' . $this->template . '/css/custom.css';
-
-if (file_exists($customCss) && filesize($customCss) > 0)
-{
-	$doc->addStyleSheetVersion($customCss);
-}
+// Load the template asset
+JHtml::_('asset.load', $doc->direction == 'rtl' ? 'template.isis.rtl' : 'template.isis.ltr');
 
 // Detecting Active Variables
 $option   = $input->get('option', '');

administrator/templates/isis/joomla.asset.json

@@ -0,0 +1,43 @@
+{
+	"title"  : "Joomla! isis template",
+	"name"   : "template.isis",
+	"author" : "Joomla! CMS",
+	"version": "1.0",
+
+	"assets": [
+		{
+			"name": "template.isis",
+			"versionAttach": true,
+			"dependency": [
+				"bootstrap.js"
+			],
+			"js": [
+				"template.js"
+			]
+		},
+		{
+			"name": "template.isis.ltr",
+			"versionAttach": true,
+			"dependency": [
+				"template.isis"
+			],
+			"css": [
+				"template.css",
+				"language/[LANGUAGE_TAG]/[LANGUAGE_TAG].css",
+				"custom.css"
+			]
+		},
+		{
+			"name": "template.isis.rtl",
+			"versionAttach": true,
+			"dependency": [
+				"template.isis"
+			],
+			"css": [
+				"template-rtl.css",
+				"language/[LANGUAGE_TAG]/[LANGUAGE_TAG].css",
+				"custom.css"
+			]
+		}
+	]
+}

administrator/templates/isis/login.php

@@ -24,31 +24,8 @@
 $background_color = $this->params->get('loginBackgroundColor') ? $this->params->get('loginBackgroundColor') : '';
 $color_is_light = ($background_color && colorIsLight($background_color));
 
-// Add JavaScript Frameworks
-JHtml::_('bootstrap.framework');
-JHtml::_('bootstrap.tooltip');
-
-// Add Stylesheets
-$doc->addStyleSheetVersion($this->baseurl . '/templates/' . $this->template . '/css/template' . ($this->direction == 'rtl' ? '-rtl' : '') . '.css');
-
-// Load optional RTL Bootstrap CSS
-JHtml::_('bootstrap.loadCss', false, $this->direction);
-
-// Load specific language related CSS
-$file = 'language/' . $lang->getTag() . '/' . $lang->getTag() . '.css';
-
-if (is_file($file))
-{
-	$doc->addStyleSheet($file);
-}
-
-// Load custom.css
-$file = 'templates/' . $this->template . '/css/custom.css';
-
-if (is_file($file))
-{
-	$doc->addStyleSheetVersion($file);
-}
+// Load the template asset
+JHtml::_('asset.load', $doc->direction == 'rtl' ? 'template.isis.rtl' : 'template.isis.ltr');
 
 // Detecting Active Variables
 $option   = $app->input->getCmd('option', '');

administrator/templates/isis/templateDetails.xml

@@ -13,6 +13,7 @@
 		<filename>cpanel.php</filename>
 		<filename>favicon.ico</filename>
 		<filename>index.php</filename>
+		<filename>joomla.asset.json</filename>
 		<filename>login.php</filename>
 		<filename>templateDetails.xml</filename>
 		<filename>template_preview.png</filename>

layouts/joomla/form/field/checkboxes.php

@@ -43,8 +43,7 @@
  */
 
 // Including fallback code for HTML5 non supported browsers.
-JHtml::_('jquery.framework');
-JHtml::_('script', 'system/html5fallback.js', false, true);
+JHtml::_('asset.load', 'html5fallback');
 
 /**
  * The format of the input tag to be filled in using sprintf.

layouts/joomla/form/field/file.php

@@ -46,8 +46,7 @@
  */
 
 // Including fallback code for HTML5 non supported browsers.
-JHtml::_('jquery.framework');
-JHtml::_('script', 'system/html5fallback.js', false, true);
+JHtml::_('asset.load', 'html5fallback');
 ?>
 <input type="file"
 	name="<?php echo $name; ?>"

layouts/joomla/form/field/radio.php

@@ -41,8 +41,7 @@
  */
 
 // Including fallback code for HTML5 non supported browsers.
-JHtml::_('jquery.framework');
-JHtml::_('script', 'system/html5fallback.js', false, true);
+JHtml::_('asset.load', 'html5fallback');
 
 /**
  * The format of the input tag to be filled in using sprintf.

layouts/joomla/html/formbehavior/ajaxchosen.php

@@ -29,9 +29,7 @@
 JText::script('JGLOBAL_KEEP_TYPING');
 JText::script('JGLOBAL_LOOKING_FOR');
 
-// Include jQuery
-JHtml::_('jquery.framework');
-JHtml::_('script', 'jui/ajax-chosen.min.js', false, true, false, false, $debug);
+JHtml::_('asset.load', 'chosen.ajax');
 
 JFactory::getDocument()->addScriptDeclaration(
 	"

layouts/joomla/html/formbehavior/chosen.php

@@ -20,10 +20,7 @@
 
 extract($displayData);
 
-// Include jQuery
-JHtml::_('jquery.framework');
-JHtml::_('script', 'jui/chosen.jquery.min.js', false, true, false, false, $debug);
-JHtml::_('stylesheet', 'jui/chosen.css', false, true);
+JHtml::_('asset.load', 'chosen');
 
 // Options array to json options string
 $options_str = json_encode($options, ($debug && defined('JSON_PRETTY_PRINT') ? JSON_PRETTY_PRINT : false));

layouts/joomla/html/sortablelist.php

@@ -23,11 +23,7 @@
 
 extract($displayData);
 
-// Depends on jQuery UI
-JHtml::_('jquery.ui', array('core', 'sortable'));
-
-JHtml::_('script', 'jui/sortablelist.js', false, true);
-JHtml::_('stylesheet', 'jui/sortablelist.css', false, true, false);
+JHtml::_('asset.load', 'sortablelist');
 
 // Attach sortable to document
 JFactory::getDocument()->addScriptDeclaration(

libraries/cms/html/asset.php

@@ -0,0 +1,140 @@
+<?php
+/**
+ * @package     Joomla.Libraries
+ * @subpackage  HTML
+ *
+ * @copyright   Copyright (C) 2005 - 2016 Open Source Matters, Inc. All rights reserved.
+ * @license     GNU General Public License version 2 or later; see LICENSE
+ */
+
+defined('JPATH_PLATFORM') or die;
+
+/**
+ * HTML Asset helper.
+ *
+ * @since  5.0
+ */
+class JHtmlAsset
+{
+	/**
+	 * Make the asset active
+	 *
+	 * @param   string|JAssetItem  $asset  Asset instance or name
+	 *
+	 * @return JAssetItem
+	 */
+	public static function load($asset)
+	{
+		$name    = $asset;
+		$factory = JAssetFactory::getInstance();
+
+		if ($asset instanceof JAssetItem)
+		{
+			$name = $asset->getName();
+			$factory->addAsset($asset);
+		}
+
+		$factory->setAssetState($name, JAssetItem::ASSET_STATE_ACTIVE);
+
+		return $factory->getAsset($name);
+	}
+
+	/**
+	 * Make the asset inactive
+	 *
+	 * @param   string|JAssetItem  $asset  Asset instance or name
+	 *
+	 * @return JAssetItem
+	 */
+	public static function unload($asset)
+	{
+		$name    = ($asset instanceof JAssetItem) ? $asset->getName() : $asset;
+		$factory = JAssetFactory::getInstance();
+
+		$factory->setAssetState($name, JAssetItem::ASSET_STATE_INACTIVE);
+
+		return $factory->getAsset($name);
+	}
+
+	/**
+	 * Add asset to the collection of known assets
+	 *
+	 * @param   JAssetItem  $asset  Asset instance
+	 *
+	 * @return void
+	 */
+	public static function add(JAssetItem $asset)
+	{
+		JAssetFactory::getInstance()->addAsset($asset);
+	}
+
+	/**
+	 * Adds a script to the page
+	 *
+	 * @param   string  $content  Script
+	 * @param   array   $deps     The script dependancy
+	 * @param   string  $type     Scripting mime (defaults to 'text/javascript')
+	 *
+	 * @return void
+	 */
+	public static function scriptDeclaration($content, array $deps = array(), $type = 'text/javascript')
+	{
+		static $loaded = array();
+		$key = md5($content);
+
+		// Avoid duplication
+		if (!empty($loaded[$key]))
+		{
+			return;
+		}
+
+		// Load dependancy
+		if (!empty($deps))
+		{
+			foreach($deps as $dep) {
+				static::load($dep);
+			}
+		}
+
+		// Attach the script to the Document
+		$doc = JFactory::getDocument();
+		$doc->addScriptDeclaration($content, $type);
+
+		$loaded[$key] = true;
+	}
+
+	/**
+	 * Adds a stylesheet declaration to the page
+	 *
+	 * @param   string  $content  Style declarations
+	 * @param   array   $deps     The style dependancy
+	 * @param   string  $type     Type of stylesheet (defaults to 'text/css')
+	 *
+	 * @return void
+	 */
+	public static function styleDeclaration($content, array $deps = array(), $type = 'text/css')
+	{
+		static $loaded = array();
+		$key = md5($content);
+
+		// Avoid duplication
+		if (!empty($loaded[$key]))
+		{
+			return;
+		}
+
+		// Load dependancy
+		if (!empty($deps))
+		{
+			foreach($deps as $dep) {
+				static::load($dep);
+			}
+		}
+
+		// Attach the script to the Document
+		$doc = JFactory::getDocument();
+		$doc->addStyleDeclaration($content, $type);
+
+		$loaded[$key] = true;
+	}
+}