simplercode/asset-aliases

AssetAliases is ZF2 module for aliasing paths of JS and CSS assets

dev-master 2013-10-02 15:29 UTC

Requires

• php: >=5.3
• zendframework/zendframework: 2.*

MIT

• emcode

• assets
• zf2
• view

README

Version 0.0.1

Introduction

AssetAliases is a ZF2 module that lets you configure aliases for your CSS and JS files and then use them in your view templates instead of hard coding paths. You can use configured aliases with headLink, headScript and inlineScript view helpers as usual.

It can be useful in situation where you have few different ZF2 modules that depend on the same asset files.

Now you can have all paths configured in one place. You can also take advantange from overriding configuration using global and local configuration files.

Installation

If you are using composer you can install it by adding line to your composer.json

"simplercode/asset-aliases": "dev-master@dev"

Usage

1. Enable AssetAliases module in your application.config.php

2. In any module config or autoloaded config you can configure aliases to assets paths, for ex:

   array(
       'asset_aliases' => array(
           'scripts' => array(
               'jquery' => '/assets/storage/vendor/jquery/jquery-2.0.3.min.js',
               'modernizr' => '/assets/storage/vendor/modernizr/modernizr.js',
               'select2' => '/assets/storage/vendor/select2/select2.js',
               'bootstrap' => '/assets/storage/vendor/bootstrap/js/bootstrap.min.js',
               'bootstrap-editable' => '/assets/storage/vendor/bootstrap-editable/js/bootstrap-editable.js'
           ),
           'styles' => array(
               'bootstrap' => '/assets/storage/vendor/bootstrap/css/bootstrap.min.css',
               'bootstrap-editable' => '/assets/storage/vendor/bootstrap-editable/css/bootstrap-editable.css'
           )
       ),
   );

3. Next you can use configured aliases somewhere in your template or partial:

   <?php echo $this->headLink()
                   ->appendStylesheet('bootstrap')
                   ->appendStylesheet('bootstrap-editable') ?>
   
   <?php echo $this->headScript()
                   ->prependFile('modernizr') ?>
   
   <?php echo $this->inlineScript()
                   ->appendFile('jquery')
                   ->appendFile('bootstrap')
                   ->appendFile('bootstrap-editable')
                   ->appendFile('select2') ?>

Forced refreshing of browser cache

You can also configure version string that will be appended to the end of asset path. You can change this string after updating content of your asset files. That way you can force browser to download new assets instead of using previously cached styles or scripts.

array(
    'asset_aliases' => array(
        'version' => '0.0.1'
    ),
)

After configuring version key, generated paths will look like this:

 /some/path/css/style.css?0.0.1
 /some/path/js/script.js?0.0.1

You can also set different version string for CSS styles and for JS scripts using following configuration keys:

array(
    'asset_aliases' => array(
        'styles_version' => '0.2',
        'scripts_version' => '0.5'
    ),
)