Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Zend Framework module for Assetic

branch: master
README.md

Introduction

AsseticBundle is module for ZF2 allowing asset managment depended of route-name, controller-alias-name (di). Core of module is assetic library.

P.S. Sorry for my english. If You wish to help me with this project or correct my english description - You are welcome :)

Requirements

Installation

Simplest way:

  1. cd my/project/folder
  2. git clone git@github.com:widmogrod/zf2-assetic-module.git module/AsseticBundle --recursive
  3. open my/project/folder/configs/application.config.php and add 'AsseticBundle' to your 'modules' parameter.

How to use AsseticBundle

Open and add to your module.config.php following section:

<?php
// module.config.php
return array(
    'di' => array(
        'instance' => array(

            // (...)

            // configuration namespace
            'assetic-configuration' => array(
                'parameters' => array(
                    'config' => array(

                        /*
                         * Enable cache
                         */
                        'cacheEnabled' => true,

                        /*
                         * Cache dir
                         */
                        'cachePath' => __DIR__ . '/../../../data/cache',

                        /*
                         * Debug on (used via \Assetic\Factory\AssetFactory::setDebug)
                         *
                         * @optional
                         */
                        'debug' => false,

                        /*
                         * Defaine base URL which will prepend your resources adress.
                         *
                         * @example
                         * <link href="http://resources.example.com/witter_bootstrap_css.css?1320257242" media="screen" rel="stylesheet" type="text/css">
                         *
                         * @optional
                         * @default null
                         */
                        'baseUrl' => 'http://resources.example.com/',

                        /*
                         * When controller name will be found in this section then fallowing assets will be loaded:
                         * INFO: assets with names prepended by '@' are alias for specific configuration resource.
                         */
                        'controllers' => array(
                            // when 'error' controller will be loaded then
                            'error' => array(
                                '@base_css',
                                '@error_css',
                            ),
                        ),

                        /*
                         * When route will be mached then following assets will be loaded:
                         * INFO: assets with names prepended by '@' are alias for specific configuration resource.
                         */
                        'routes' => array(
                            /*
                             * when router 'default' will be used then this set of asset will be loaded
                             */
                            'default' => array(
                                '@base_css',
                                '@base_js',
                            ),

                            /*
                             * when router 'home' will be used then this set of asset will be loaded
                             */
                            'home' => array(
                                '@base_css',
                                '@home_css',
                                '@base_js',
                            ),

                            /*
                             * when router 'quizapp' will be used then this set of asset will be loaded
                             */
                            'quizapp' => array(
                                '@quiz_admin_js',
                            ),
                        ),

                        /*
                         * In this configuration section, you can define which js, css, resources module have.
                         */
                        'modules' => array(

                            /*
                             * Application moodule - assets configuration
                             */
                            'application' => array(

                                # module root path for yout css and js files
                                'root_path' => __DIR__ . '/../assets',

                                # collection od assets
                                'collections' => array(

                                    'base_css' => array(
                                        'assets' => array(
                                            # relative to 'root_path'
                                            'css/my/reset.css',
                                            'css/*.css'
                                        ),
                                        'filters' => array(),
                                        'options' => array(),
                                    ),

                                    'base_js' => array(
                                        'assets' => array(
                                            'http://code.jquery.com/jquery-1.5.2.min.js', // global
                                            'js/setup.js' // relative to 'root_path'
                                        )
                                    ),
                                ),
                            ),

                            /*
                             * Quiz module - example configuration
                             */
                            'quiz' => array(

                                'root_path' => __DIR__ . '/../../modules/Quiz/assets',

                                'collections' => array(

                                    /*
                                     * If You want move not only CSS, files but also images relative to CSS resource
                                     * You must set option flag 'move_raw' to true.
                                     */
                                    'quiz_app_images' => array(
                                        'assets' => array(
                                            'images/*.png',
                                            'images/*.gif',
                                        ),
                                        'options' => array(
                                            'move_raw' => true,
                                        )
                                    ),

                                    'quiz_admin_js' => array(
                                        'assets' => array(
                                            'js/jquery.min.js',
                                            'http://html5shim.googlecode.com/svn/trunk/html5.js',
                                            '@twitter_bootstrap_scrollspy_js',
                                            '@twitter_bootstrap_modal_js',
                                            '@twitter_bootstrap_dropdown_js',
                                            'js/admin.js',
                                        ),

                                        /*
                                         * If Your assets collection is using a @reference its required to defain
                                         * a output filename for this collection.
                                         *
                                         * Without it, \AsseticBundle\ViewHelperSetup can't determinate
                                         * what kind of content is't is: ie. *.js or *.css; and how to setup view helpers.
                                         */
                                        'options' => array(
                                            'output' => 'quiz_admin.js'
                                        )
                                    )
                                ),
                            ),
                        ),
                    ),
                ),
            )

        //(...)
        )))
?>

Which configuration will be used

AsseticBundle resolve which configuration will be used to setup and load assets using this algoritm:

  1. use assets from 'controller' configuration
  2. if 'controller' not exists, use assets from 'route' configuration
  3. if 'route' not exists, don't load assets

Projects using AsseticBundle

Project plan

  • Todo

    • more examples & better description
    • filter support
    • rewrite initViewHelpers - add event handler
  • Done

    • setup assets by view helpers
    • add cache for assets
    • add ?timestamp url query parameter (now path is appended by ?1233213123)

Additional staff

Layout .phtml example

<?php echo $this->plugin('doctype')->setDoctype(\Zend\View\Helper\Doctype::HTML5); ?>
<html lang="en">
<head>
    <meta charset="utf-8">
    <?php
        echo $this->plugin('HeadTitle');
        echo $this->plugin('HeadMeta');
        echo $this->plugin('HeadLink');
        echo $this->plugin('HeadStyle');
        echo $this->plugin('HeadScript');
    ?>
</head>
<body>
<div id="container">
    <div id="header">

    </div>
    <div id="wrapper">
        <div id="main">
            <?php echo $this->content ?>
        </div>
    </div>
    <div id="footer">

    </div>
</div>
<?php
    echo $this->plugin('InlineScript');
?>
</body>
</html>
Something went wrong with that request. Please try again.