TpMinify - third-party module for the Zend Framework 2
This module uses the Steve (mrclay) Clay's Minify library for styles and scripts obfuscation., (*1)
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:, (*2)
// $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., (*3)
'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., (*4)
'minifierOptions' => array(
'text/css' => array(
'symlinks' => array(
'//fonts' => Module::DIR . '/public/fonts'
)
)
)
Is it possible to minify inline scripts?
Enable the HeadScript view helper:, (*5)
'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?
- Put a common stuff into the
global.php
- And put a module-dependent stuff into the
module.config.php of each module
- Use prefixes for groups:
backend-css and frontend-css etc.
License
The MIT License (MIT), (*6)
Copyright (c) 2013-2014 Kanstantsin Kamkou, (*7)
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:, (*8)
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software., (*9)
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., (*10)
Wallogit.com
