remiheens/smartloader

Library to manage JS and CSS in template

dev-master 2013-10-30 08:07 UTC

Requires

• php: >=5.3.0

Requires (Dev)

• phpunit/phpunit: ~3.7
• sami/sami: v1.2

Suggests

• symfony/dependency-injection: v2.3.6

GPL-3.0+

• Rémi Heens

• css
• JS
• template manager

README

SmartLoader is a library that allows you to easily manage your js and css on your site.

When you have lot of js & css to include dynamically, it’s difficult and complex. With SmartLoader, you have some functions to enqueue code or links in controllers and you just have to output the queue in your footer.

If you know wordpress development, this library works like the wp_enqueue function. In your controller, you can enqueue some js and css link, and output this in footer.

Installation

Create composer.json file Add

{
    "require": {
        "remiheens/smartloader": "2.0.*@dev"
    }
}

Documentation

The object "SmartLoader" has two objects: "js" and "css", these two attributes are the managers for CSS and Javascript.

public function setTemplate($tpl);

set the template folder

public function getTemplate();

get the template folder

public function forceHTTP();

force http because by default output link starts woith "//domain.tld/..."

JS

public function setTemplate($tpl);

set the template name, each js will be loaded into this directory template

public function forceHTTP();

force http because by default output link starts woith "//domain.tld/..."

public function add($args);

Add js file url or an array of url

public function loadLib($lib);

add a js library juste the name located in template_folder/js/lib/ (see configuration).

public function jquery($data, $header = false);

Add jquery code in header or footer

public function js($data, $header = false);

Add javascript code in header or footer

public function load($js_file);

load a js like a view, SmartLoaderJS try to get this file into the configurated js folder (name without .js)

public function loadLinks();

Output the list of script balise for all js link added

public function loadJavascript($header = false);

Output javascript code

CSS

public function setTemplate($tpl);

set the template name, each js will be loaded into this directory template

public function forceHTTP();

force http because by default output link starts woith "//domain.tld/..."

public function add($args);

Add css file url

public function output();

Output the link balise ref to css compiled file.

Each CSS added + autoload folder are concatenated to a css file into compiled folder. It wil be regenerated if on file are modify