kkamkou/tp-minify

Zend Framework 2 module which uses the Steve (mrclay) Clay's Minify library for styles and scripts obfuscation

1.2 2013-07-20 12:19 UTC

Requires

• php: >=5.3.3
• mrclay/minify: 2.*
• zendframework/zendframework: >=2.2

BSD-2-Clause

• Kanstantsin Kamkou

• asset
• zf2
• minify
• obfuscation

README

This module uses the Steve (mrclay) Clay's Minify library for styles and scripts obfuscation.

Installation

Composer

• Install the Composer
• Add "kkamkou/tp-minify": "dev-master" to a composer.json file, to the require section
• Execute composer update
• Add 'modules' => array('TpMinify', ...) to the application.config.php file of your project. Important thing is to place the "TpMinify" before any other modules.
• Open (just an example) the Frontend/config/module.config.php and add this config stub:

'TpMinify' => array(
    'serveOptions' => array(
        'minApp' => array(
            'groups' => array(
                'css' => array(
                    '//../module/Frontend/public/css/buttons.css',
                    '//../module/Frontend/public/css/forms.css'
                ),
                'js' => array(
                    '//js/common.js'
                )
            )
        )
    )
)

• Put styles into the Head section:

$this->headLink()->prependStylesheet($this->basePath('/min?g=css'))
$this->headScript()->prependFile($this->basePath('/min?g=js'))
// or
$this->headLink()->prependStylesheet($this->basePath('/min?f=example.css'))

Options

Source code with the description of variables. For example:

// $min_cacheFileLocking
'TpMinify' => array('cacheFileLocking' => ...);
// $min_serveOptions['bubbleCssImports']
'TpMinify' => array('serveOptions' => array('bubbleCssImports' => ...));
// etc.

How-To

What to do with the /module/YourModule/public/images/ folder?

a. Create a symlink to this module (/public/images/modules/YourModule) and enable the Manual Rewriting.

'TpMinify' => array(
    'serveOptions' => array(
        'rewriteCssUris' => false,
        'minifierOptions' => array(
            'text/css' => array('prependRelativePath' => '/images/modules/YourModule/')
        )
    )
)

b. Add the symlinks option if needed, which is described in the configuration file and here.

'minifierOptions' => array(
    'text/css' => array(
        'symlinks' => array(
            '//fonts' => Module::DIR . '/public/fonts'
        )
    )
)

Is it possible to minify inline scripts?

Enable the HeadScript view helper:

'TpMinify' => array(
    'helpers' => array(
        'headScript' => array(
            'enabled' => true,
            'options' => array() // serveOptions here if needed
        )
    )
)
// and use it in your templates
<?$this->headScript()->captureStart()?>
$(function() {
    console.log('hello');
});
<?$this->headScript()->captureEnd()?>

I have two or more modules, how to deal with that?

1. Put a common stuff into the global.php
2. And put a module-dependent stuff into the module.config.php of each module
3. Use prefixes for groups: backend-css and frontend-css etc.

License

The MIT License (MIT)

Copyright (c) 2013-2014 Kanstantsin Kamkou

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.