README

Yii 1.4.x or above

Description (This is fork from EClientScript with fixes problem in CssMin):

EClientScript (an extension for Yii's CClientScript)

This is an optimizing client script manager for Yii framework, that can minify and combine CSS/JS files.

It will automatically detects changes in file content (based on modification time) and generates a unique file name accordingly.

This will reduce the HTTP calls for resources files by merging several resources filesinto a single (or more) files.

The source code is hosted under bitbucket:

https://bitbucket.org/yiicod/clientscript.git

Css Files:

CSS files are merged based on there media attribute, background images with a relative path in file can also be displayed correctly.

Script files:

Script files are merged based on their position, If you use the 'CClientScript::POS_HEAD' you will end up with a single file for all the script files you've used on that page.

If you use 'CClientScript::POS_HEAD' and 'CClientScript::POS_END' for example then you'll end up with two files for each page on that request, becuase those resources are located in different positions.

File optmization

CssMin used to optimize merged css file. You can set property 'optmizeCssFiles' of the component to enable this feature. JSMinPlus used to optimize merged script file. You can set property 'optmizeScriptFiles' of the component to enable this feature.

Usage:

Using this extension is as simple as adding the following code to the application configuration under the components array:

  'clientScript' => array(
    'class' => 'application.vendors.yii-EClientScript.EClientScript',
    'combineScriptFiles' => !YII_DEBUG, // By default this is set to true, set this to true if you'd like to combine the script files
    'combineCssFiles' => !YII_DEBUG, // By default this is set to true, set this to true if you'd like to combine the css files
    'optimizeScriptFiles' => !YII_DEBUG,	// @since: 1.1
    'optimizeCssFiles' => !YII_DEBUG, // @since: 1.1
    'optimizeInlineScript' => false, // @since: 1.6, This may case response slower
    'optimizeInlineCss' => false, // @since: 1.6, This may case response slower
  ),

Then you can use the regular 'registerScriptFile' & 'registerCssFile' methods as normal and the files will be combined or optimized automatically.

Using to conditional loading js/css file for IE browser, you just need to specify the media property.

$cs = Yii::app()->clientScript;

// result to: <!--[if lt IE 9]><script src="/js/html5.js"></script><![endif]-->
$cs->registerScriptFile('/js/html5.js', CClientScript::POS_HEAD, array('media' => 'lt IE 9'));

// result to: <!--[if lte IE 6]><link rel="stylesheet" type="text/css" href="bootstrap/css/ie.css" /><![endif]-->
$cs->registerCssFile('/css/ie.css', 'lte IE 6');

Known Issues:

When some resource files can not be merged and they are strictly dependent on loading order, then may have some problems.

yiicod / clientscript

Maintainers

Details