MinifyHeadScript.php

<?php

/**
 * 
 * Helper for setting and retrieving script elements for HTML head section
 * with the added twist of minifying the javascript files. 
 * 
 * ** PREREQUISITES **
 * This file expects that you have installed minify in ../ZendFramworkProject/Public/min 
 * and that it is working. If your location has changed, modify 
 * $this->$_minifyLocation to your current location.
 * 
 * ** INSTALLATION **
 * Simply drop this file into your ../ZendFramworkProject/application/views/helpers
 * directory.
 * 
 * ** USAGE **
 * In your Layout or View scripts, you can simply call minifyHeadScript
 * in the same way that you used to call headScript. Here is an example:
 * 
  echo $this->minifyHeadScript()
  ->prependFile('http://ajax.googleapis.com/ajax/libs/someObject/2.2/object.js') // 12th	   
	->prependFile('/js/jquery.delaytrigger.js') // 11th
	->prependFile('/js/sorttable.js')           // 10th
	->prependFile('/js/jquery.alerts.js')       // 9th
	->prependFile('/js/jqModal.js')             // 8th
	->prependFile('/js/jquery.maskedinput.js')  // 7th
	->prependFile('/js/jquery.checkbox.js')     // 6th
	->prependFile('/js/jquery.tablesorter.min.js') // 5th
	->prependFile('/js/jquery.autocomplete.js') // 4th
	->prependFile('/js/jquery.color.js')        // 3rd
	->prependFile('/js/jquery-1.3.2.min.js')    // 2nd
	->prependFile('/js/main.js')                // 1st
	->appendScript('
		$(document).ready(function() {
			$(\'#ajaxWait\').ajaxStart(function() {
		      $(this).show();
		    }).ajaxStop(function() {
		      $(this).hide();
			      });
			
			try { init(); } catch(e) {}
		});                                       // Last
	');
 * Because minify can't do anything with a javascript from some other server, nor
 * does it do anything with inline scripts, and order is important, it will minify
 * up to the point that it meets something that can't be minified, and then output
 * the minified version, then the item(s) that couldn't be minified, and then attempt
 * to minify items again, repeating the process till it is completed. Here is an
 * example of output from the example above.
 * 
<script type="text/javascript" src="/min/?f=/js/main.js,/js/jquery-1.3.2.min.js,/js/jquery.color.js,
                    /js/jquery.autocomplete.js,/js/jquery.tablesorter.min.js,/js/jquery.checkbox.js,
                    /js/jquery.maskedinput.js,/js/jqModal.js,/js/jquery.alerts.js,/js/sorttable.js,
                    /js/jquery.delaytrigger.js"></script>
<script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/someObject/2.2/object.js"></script>
<script type="text/javascript">
    //<![CDATA[

		$(document).ready(function() {
			$('#ajaxWait').ajaxStart(function() {
		      $(this).show();
		    }).ajaxStop(function() {
		      $(this).hide();
			      });
			
			try { init(); } catch(e) {}
		});
	    //]]>

</script>

 * 
 * 
 *
 * @see        http://code.google.com/p/minify/
 * @package    Zend_View
 * @subpackage Helper
 * @copyright  Copyright (c) 2010-2011 Signature Tech Studios (http://www.stechstudio.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 * @author     Rob "Bubba" Hines
 *
 */
class Zend_View_Helper_MinifyHeadScript extends Zend_View_Helper_HeadScript {
	
	/**
	 * 
	 * The folder to be appended to the base url to find minify on your server.
	 * The default assumes you installed minify in your documentroot\min directory
	 * if you modified the directory name at all, you need to let the helper know 
	 * here.
	 * @var string
	 */
	protected $_minifyLocation = '/min/';
	
	/**
	 * Registry key for placeholder
	 * @var string
	 */
	protected $_regKey = 'RC_View_Helper_MinifyHeadScript';
	
	/**
	 * Return headScript object
	 *
	 * Returns headScript helper object; optionally, allows specifying a script
	 * or script file to include.
	 *
	 * @param  string $mode 			Script or file
	 * @param  string $spec 			Script/url
	 * @param  string $placement	Append, prepend, or set
	 * @param  array  $attrs 			Array of script attributes
	 * @param  string $type 			Script type and/or array of script attributes
	 * @return Zend_View_Helper_HeadScript
	 */
	public function minifyHeadScript($mode = Zend_View_Helper_HeadScript::FILE, $spec = null, $placement = 'APPEND', array $attrs = array(), $type = 'text/javascript') {
		return parent::headScript($mode, $spec, $placement, $attrs, $type);
	}
	
	/**
	 * 
	 * Gets a string representation of the headscripts suitable for inserting
	 * in the html head section. All included javascript files will be minified
	 * and any script sections will remain as is. 
	 * 
	 * It is important to note that the minified javascript files will be minified
	 * in reverse order of being added to this object, and ALL files will be rendered
	 * prior to inline scripts being rendered.
	 *
	 * @see Zend_View_Helper_HeadScript->toString()
	 * @param  string|int $indent
	 * @return string
	 */
	public function toString($indent = null) {
		// An array of Script Items to be rendered
		$items = array();
		
		// An array of Javascript Items
		$scripts = array();
		
		// The base URL
		$baseUrl = $this->getBaseUrl();
		
		// Any indentation we should use.
		$indent = (null !== $indent) ? $this->getWhitespace($indent) : $this->getIndent();
		
		//remove the slash at the beginning if there is one  
		if (substr($baseUrl, 0, 1) == '/') {
			$baseUrl = substr($baseUrl, 1);
		}
		
		// Determining the appropriate way to handle inline scripts
		if ($this->view) {
			$useCdata = $this->view->doctype()->isXhtml() ? true : false;
		} else {
			$useCdata = $this->useCdata ? true : false;
		}
		
		$escapeStart = ($useCdata) ? '//<![CDATA[' : '//<!--';
		$escapeEnd = ($useCdata) ? '//]]>' : '//-->';
		
		$this->getContainer()->ksort();
		foreach ( $this as $item ) {
			
			if (isset($item->attributes ['src']) && !empty($item->attributes ['src']) && strpos($item->attributes ['src'], 'http://') === false) {
				$scripts [] = str_replace($baseUrl, '', $item->attributes ['src']);
			} else {
				if (count($scripts) > 0) {
					$minScript = new stdClass();
					$minScript->type = 'text/javascript';
					// We will create our minify URL here. 
					if (is_null($baseUrl) || $baseUrl == '') {
						$minScript->attributes ['src'] = $this->getMinUrl() . '?f=' . implode(',', $scripts);
					} else {
						$minScript->attributes ['src'] = $this->getMinUrl() . '?b=' . $baseUrl . '&f=' . implode(',', $scripts);
					}
					$scripts = array(); // Empty our scripts array
					$items [] = $this->itemToString($minScript, '', '', ''); // add the minified item
				}
				$items [] = $this->itemToString($item, $indent, $escapeStart, $escapeEnd); // add this item
			}
		}
		
		// Make sure we pick up the final minified item if it exists.
		if (count($scripts) > 0) {
			$minScript = new stdClass();
			$minScript->type = 'text/javascript';
			// We will create our minify URL here. 
			if (is_null($baseUrl) || $baseUrl == '') {
				$minScript->attributes ['src'] = $this->getMinUrl() . '?f=' . implode(',', $scripts);
			} else {
				$minScript->attributes ['src'] = $this->getMinUrl() . '?b=' . $baseUrl . '&f=' . implode(',', $scripts);
			}
			$scripts = array(); // Empty our scripts array
			$items [] = $this->itemToString($minScript, '', '', '');
		}
		
		return $indent . implode($this->_escape($this->getSeparator()) . $indent, $items);
	}
	
	/**
	 * Retrieve the minify url
	 *
	 * @return string
	 */
	public function getMinUrl() {
		return $this->getBaseUrl() . $this->_minifyLocation;
	}
	
	/**
	 * Retrieve the currently set base URL
	 *
	 * @return string
	 */
	public function getBaseUrl() {
		return Zend_Controller_Front::getInstance()->getBaseUrl();
	}

}