refactor client scripts.

4 files changed, 67 insertions, 139 deletions

diff --git a/framework/Web/UI/WebControls/TClientScriptLoader.php b/framework/Web/UI/WebControls/TClientScriptLoader.php
index 1c5b9d29..f59a9ba4 100644
--- a/framework/Web/UI/WebControls/TClientScriptLoader.php
+++ b/framework/Web/UI/WebControls/TClientScriptLoader.php
@@ -11,7 +11,7 @@
  */

 

 /**

- * The TClientScriptLoader publish a collection of javascript files as assets. 

+ * The TClientScriptLoader publish a collection of javascript files as assets.

  * The {@link PackagePath setPackagePath} property can be an existing asset directory

  * or a namespace path to the directory containing javascript files. E.g.

  * <code>

@@ -20,7 +20,7 @@
  * </code>

  *

  * When the files in the {@link PackagePath setPackagePath} are published as assets, a script loader

- * php file corresponding to TClientScriptLoader::SCRIPT_LOADER is also copied to that asset directory.

+ * php file corresponding to TClientScriptManager::SCRIPT_LOADER is also copied to that asset directory.

  *

  * The script loader, combines multiple javascript files and serve up as gzip if possible.

  * Allowable scripts and script dependencies can be specified in a "packages.php" file

@@ -54,12 +54,12 @@
  * removes comments and whitespaces from the published javascript files. If

  * the DebugMode property is not set, the debug mode is determined from the application mode.

  *

- * The {@link setEnableGzip EnableGzip} property (default is true) enables the 

- * published javascripts to be served as zipped if the browser and php server allows it. 

-  

+ * The {@link setEnableGzip EnableGzip} property (default is true) enables the

+ * published javascripts to be served as zipped if the browser and php server allows it.

+

  * If the DebugMode is false either explicitly or when the application mode is non-debug,

  * then cache headers are also sent to inform the browser and proxies to cache the file.

- * Moreover, the post-processed (comments removed and zipped) are saved in the assets 

+ * Moreover, the post-processed (comments removed and zipped) are saved in the assets

  * directory for the next requests. That is, in non-debug mode the scripts are cached

  * in the assets directory until they are deleted.

  *

@@ -70,8 +70,6 @@
  */

 class TClientScriptLoader extends TWebControl

 {

-	const SCRIPT_LOADER = 'Web/Javascripts/clientscripts.php';

-

 	/**

 	 * @return string tag name of the script element

 	 */

@@ -79,7 +77,7 @@ class TClientScriptLoader extends TWebControl
 	{

 		return 'script';

 	}

-	

+

 	/**

 	 * Adds attribute name-value pairs to renderer.

 	 * This overrides the parent implementation with additional button specific attributes.

@@ -97,58 +95,13 @@ class TClientScriptLoader extends TWebControl
 	 */

 	protected function getClientScriptUrl()

 	{

-		$baseUrl = $this->publishScriptLoader();

-		$scripts = split('/\s*[, ]+\s*/', $this->getPackageScripts());

-		$url = $baseUrl . '?js=' . implode(',', $scripts);

-		if($this->getDebugMode()!==false && $this->getApplication()->getMode()===TApplicationMode::Debug)

-			$url.='&amp;mode=debug';

-		if($this->getEnableGzip()===false)

-			$url.='&amp;gzip=false';

-		return $url;

-	}

-

-	/**

-	 * Copies the client script loader php file to the asset directory if appropriate.

-	 * @return string clientscript.php url

-	 * @throws TConfigurationException if error in publishing the package path.

-	 */

-	protected function publishScriptLoader()

-	{

-		list($path, $url) = $this->getPublishedPackagePath();

-		if(is_dir($path))

-		{

-			$scriptLoader = Prado::getFrameworkPath().'/'.self::SCRIPT_LOADER;

-			$scriptLoaderFile = basename($scriptLoader);

-			$dest = $path.'/'.$scriptLoaderFile;

-			if(!is_file($dest))

-				copy($scriptLoader,$dest);

-			return $url.'/'.$scriptLoaderFile;

-		}

-		else

-			throw new TConfigurationException('clientscript_invalid_package_path',

-				$this->getPackagePath(), $this->getUniqueID());

+		$scripts = split('\s*[, ]+\s*', $this->getPackageScripts());

+		$cs = $this->getPage()->getClientScript();

+		return $cs->registerJavascriptPackages($this->getPackagePath(),

+				$scripts, $this->getDebugMode(), $this->getEnableGzip());

 	}

 

 	/**

-	 * Publishes the package path assets, tries path as namespace first.

-	 * @return array tuple ($path, $url).

-	 */

-	protected function getPublishedPackagePath()

-	{

-		$assets = $this->getApplication()->getAssetManager();

-		//assumes dot path first

-		$dir = Prado::getPathOfNameSpace($this->getPackagePath());

-		if(!is_null($dir))

-		{

-			$url = $assets->publishFilePath($dir); //show throw an excemption if invalid

-			return array($dir, $url);

-		}

-		$url = $this->getPackagePath();

-		$packageDir = str_replace($assets->getBaseUrl(), '', $url);

-		return array($assets->getBasePath().$packageDir,$url);

-	}

-	

-	/**

 	 * @param string custom javascript library directory.

 	 */

 	public function setPackagePath($value)

@@ -165,7 +118,7 @@ class TClientScriptLoader extends TWebControl
 	}

 

 	/**

-	 * @param string load specific packages from the javascript library in the PackagePath, 

+	 * @param string load specific packages from the javascript library in the PackagePath,

 	 * comma delimited package names. A maximum of 25 packages is allowed.

 	 */

 	public function setPackageScripts($value)

@@ -198,7 +151,7 @@ class TClientScriptLoader extends TWebControl
 	}

 

 	/**

-	 * @return boolean javascript comments stripped in non-debug mode. 

+	 * @return boolean javascript comments stripped in non-debug mode.

 	 * Debug mode will depend on the application mode if null.

 	 */

 	public function getDebugMode()

diff --git a/framework/Web/UI/WebControls/TColorPicker.php b/framework/Web/UI/WebControls/TColorPicker.php
index 64345dcd..efdcbeb4 100644
--- a/framework/Web/UI/WebControls/TColorPicker.php
+++ b/framework/Web/UI/WebControls/TColorPicker.php
@@ -22,6 +22,8 @@
  */

 class TColorPicker extends TTextBox

 {

+	const SCRIPT_PATH = 'prado/colorpicker';

+

 	/**

 	 * @return boolean whether the color picker should pop up when the button is clicked.

 	 */

@@ -128,6 +130,16 @@ class TColorPicker extends TTextBox
 	}

 

 	/**

+	 * @param string asset file in the self::SCRIPT_PATH directory.

+	 * @return string asset file url.

+	 */

+	protected function getAssetUrl($file='')

+	{

+		$base = $this->getPage()->getClientScript()->getPradoScriptAssetUrl();

+		return $base.'/'.self::SCRIPT_PATH.'/'.$file;

+	}

+

+	/**

 	 * Publish the color picker Css asset files.

 	 */

 	public function onPreRender($param)

@@ -143,47 +155,24 @@ class TColorPicker extends TTextBox
 	protected function publishColorPickerStyle()

 	{

 		$cs = $this->getPage()->getClientScript();

-		$style = 'System.Web.Javascripts.prado.colorpicker.'.$this->getColorPickerStyle();

-		if(($cssFile=Prado::getPathOfNamespace($style,'.css'))!==null)

-		{

-			$url = $this->publishFilePath($cssFile);

-			if(!$cs->isStyleSheetFileRegistered($style))

-				$cs->registerStyleSheetFile($style, $url);

-			return $url;

-		}

-		else

-			throw new TConfigurationException('colorpicker_style_invalid',$style);

+		$url = $this->getAssetUrl($this->getColorPickerStyle().'.css');

+		if(!$cs->isStyleSheetFileRegistered($url))

+			$cs->registerStyleSheetFile($url, $url);

+		return $url;

 	}

 

 	/**

 	 * Publish the color picker image assets.

-	 * @return array list of  image URLs

 	 */

 	protected function publishColorPickerImageAssets()

 	{

 		$cs = $this->getPage()->getClientScript();

 		$key = "prado:".get_class($this);

-

-		$images = array('button' => '.gif', 'target_black' => '.gif',

-						'target_white' => '.gif', 'background' => '.png',

-						'slider' => '.gif', 'hue' => '.gif');

-

-		$list = array();

-

-		foreach($images as $filename => $ext)

-		{

-			$image = 'System.Web.Javascripts.prado.colorpicker.'.$filename;

-			if(($file =  Prado::getPathOfNamespace($image, $ext))!==null)

-				$list[$filename.$ext] = $this->publishFilePath($file);

-			else

-				throw new TConfigurationException('colorpicker_image_invalid',$image);

-		}

-		$imgs['button.gif'] = $list['button.gif'];

-		$imgs['background.png'] = $list['background.png'];

+		$imgs['button.gif'] = $this->getAssetUrl('button.gif');

+		$imgs['background.png'] = $this->getAssetUrl('background.png');

 		$options = TJavaScript::encode($imgs);

 		$code = "Prado.WebUI.TColorPicker.UIImages = {$options};";

 		$cs->registerEndScript($key, $code);

-		return $list;

 	}

 

 	/**

@@ -214,14 +203,14 @@ class TColorPicker extends TTextBox
 	{

 		parent::render($writer);

 

-		$images = $this->publishColorPickerImageAssets();

 		$color = $this->getText();

 

+		$this->publishColorPickerImageAssets();

 		$writer->addAttribute('class', 'TColorPicker_button');

 		$writer->renderBeginTag('span');

 

 		$writer->addAttribute('id', $this->getClientID().'_button');

-		$writer->addAttribute('src', $images['button.gif']);

+		$writer->addAttribute('src', $this->getAssetUrl('button.gif'));

 		if($color !== '')

 			$writer->addAttribute('style', "background-color:{$color};");

 		$writer->addAttribute('width', '20');

diff --git a/framework/Web/UI/WebControls/TDatePicker.php b/framework/Web/UI/WebControls/TDatePicker.php
index 3e85ffb9..dd922431 100644
--- a/framework/Web/UI/WebControls/TDatePicker.php
+++ b/framework/Web/UI/WebControls/TDatePicker.php
@@ -67,6 +67,11 @@ Prado::using('System.Web.UI.WebControls.TTextBox');
 class TDatePicker extends TTextBox

 {

 	/**

+	 * Script path relative to the TClientScriptManager::SCRIPT_PATH

+	 */

+	const SCRIPT_PATH = 'prado/datepicker';

+

+	/**

 	 * @var TDatePickerClientScript validator client-script options.

 	 */

 	private $_clientScript;

@@ -735,7 +740,7 @@ class TDatePicker extends TTextBox
 	 protected function renderImageButtonDatePicker($writer)

 	{

 		$url = $this->getButtonImageUrl();

-		$url = empty($url) ? $this->publishDefaultButtonImage() : $url;

+		$url = empty($url) ? $this->getAssetUrl('calendar.png') : $url;

 		$writer->addAttribute('id', $this->getDatePickerButtonID());

 		$writer->addAttribute('src', $url);

 		$writer->addAttribute('alt', ' ');

@@ -747,16 +752,13 @@ class TDatePicker extends TTextBox
 	}

 

 	/**

-	 * Publish the default button image asset file.

-	 * @return string image file url.

+	 * @param string date picker asset file in the self::SCRIPT_PATH directory.

+	 * @return string date picker asset url.

 	 */

-	protected function publishDefaultButtonImage()

+	protected function getAssetUrl($file='')

 	{

-		$image = 'System.Web.Javascripts.prado.datepicker.calendar';

-		if(($file =  Prado::getPathOfNamespace($image, '.png'))!==null)

-			return $this->publishFilePath($file);

-		else

-			throw new TConfigurationException('datepicker_defaultbuttonimage_invalid',$image);

+		$base = $this->getPage()->getClientScript()->getPradoScriptAssetUrl();

+		return $base.'/'.self::SCRIPT_PATH.'/'.$file;

 	}

 

 	/**

@@ -765,29 +767,11 @@ class TDatePicker extends TTextBox
 	 */

 	protected function publishCalendarStyle()

 	{

+		$url = $this->getAssetUrl($this->getCalendarStyle().'.css');

 		$cs = $this->getPage()->getClientScript();

-		$style = 'System.Web.Javascripts.prado.datepicker.'.$this->getCalendarStyle();

-		if(($cssFile=Prado::getPathOfNamespace($style,'.css'))!==null)

-		{

-			$url = $this->publishFilePath($cssFile);

-			if(!$cs->isStyleSheetFileRegistered($style))

-				$cs->registerStyleSheetFile($style, $url);

-			return $url;

-		}

-		else

-			throw new TConfigurationException('datepicker_calendarstyle_invalid',$style);

-	}

-

-	/**

-	 * Publish the spacer.gif for IE iframe source.

-	 * @return string the URL for the spacer.gif.

-	 */

-	protected function publishIFrameSpacer()

-	{

-		$cs = $this->getPage()->getClientScript();

-		$spacer = 'System.Web.Javascripts.prado.datepicker.spacer';

-		if(($file = Prado::getPathOfNamespace($spacer,'.gif')) != null)

-			return $this->publishFilePath($file);

+		if(!$cs->isStyleSheetFileRegistered($url))

+			$cs->registerStyleSheetFile($url, $url);

+		return $url;

 	}

 

 	/**

@@ -814,7 +798,7 @@ class TDatePicker extends TTextBox
 

 			if(!$cs->isEndScriptRegistered('TDatePicker.spacer'))

 			{

-				$spacer = $this->publishIFrameSpacer();

+				$spacer = $this->getAssetUrl('spacer.gif');

 				$code = "Prado.WebUI.TDatePicker.spacer = '$spacer';";

 				$cs->registerEndScript('TDatePicker.spacer', $code);

 			}

diff --git a/framework/Web/UI/WebControls/TRatingList.php b/framework/Web/UI/WebControls/TRatingList.php
index 36febe7b..e50e3fad 100644
--- a/framework/Web/UI/WebControls/TRatingList.php
+++ b/framework/Web/UI/WebControls/TRatingList.php
@@ -27,6 +27,8 @@ Prado::using('System.Web.UI.WebControls.TRadioButtonList');
  */

 class TRatingList extends TRadioButtonList

 {

+	const SCRIPT_PATH='prado/ratings';

+

 	private $_ratingImages = array();

 

 	public function __construct()

@@ -105,6 +107,16 @@ class TRatingList extends TRadioButtonList
 		return $this->getViewState('HalfRating', array(0.3, 0.7));

 	}

 

+	/**

+	 * @param string asset file in the self::SCRIPT_PATH directory.

+	 * @return string asset file url.

+	 */

+	protected function getAssetUrl($file='')

+	{

+		$base = $this->getPage()->getClientScript()->getPradoScriptAssetUrl();

+		return $base.'/'.self::SCRIPT_PATH.'/'.$file;

+	}

+

 	public function getRatingClientOptions()

 	{

 		$options['cssClass'] = 'TRatingList_'.$this->getRatingStyle();

@@ -118,28 +130,18 @@ class TRatingList extends TRadioButtonList
 	protected function publishRatingListStyle($style)

 	{

 		$cs = $this->getPage()->getClientScript();

-		$stylesheet = 'System.Web.Javascripts.ratings.'.$style;

-		if(($cssFile=Prado::getPathOfNamespace($stylesheet,'.css'))===null)

-			throw new TConfigurationException('ratinglist_stylesheet_not_found',$style);

-		$url = $this->publishFilePath($cssFile);

-		if(!$cs->isStyleSheetFileRegistered($style))

-			$cs->registerStyleSheetFile($style, $url);

+		$url = $this->getAssetUrl($style.'.css');

+		if(!$cs->isStyleSheetFileRegistered($url))

+			$cs->registerStyleSheetFile($url, $url);

 		return $url;

 	}

 

 	protected function publishRatingListImages($style, $fileExt='.gif')

 	{

-		$images['blank'] = "System.Web.Javascripts.ratings.{$style}_blank";

-		$images['hover'] = "System.Web.Javascripts.ratings.{$style}_hover";

-		$images['selected'] = "System.Web.Javascripts.ratings.{$style}_selected";

-		$images['half'] = "System.Web.Javascripts.ratings.{$style}_half";

+		$images = array('blank', 'hover', 'selected', 'half');

 		$files = array();

-		foreach($images as $type => $image)

-		{

-			if(($file=Prado::getPathOfNamespace($image, $fileExt))===null)

-				throw TConfigurationException('ratinglist_image_not_found',$image);

-			$files[$type] = $this->publishFilePath($file);

-		}

+		foreach($images as $type)

+			$files[$type] = $this->getAssetUrl("{$style}_{$type}{$fileExt}");

 		return $files;

 	}