mouf/html.utils.weblibrarymanager

The Javascript/CSS library manager is a PHP class in charge of keeping track of the JS and CSS files that have been included so far in a web page. Basically, you tell the Javascript/CSS library manager to import a JS/CSS file and it will make sure it is included, only once, and that all dependencies...

v3.2.0 2019-02-14 16:25 UTC

README

Latest Stable Version Total Downloads Latest Unstable Version License Build Status Coverage Status Scrutinizer Code Quality

WebLibraryManager: a PHP class to manage Javascript/CSS dependencies in your project

Tutorial

If you need a nice introduction to managing JS/CSS files with Mouf, read the JS/CSS introduction of the "getting things done with mouf" project.

Introduction

WebLibraryManager is a Mouf package that allows you to import CSS/Javascript in your project the simple way. Since v4, WebLibraryManager is using container-interop/service-provider and therefore is framework agnostic.

When installed, the WebLibraryManager package creates a Mouf\Html\Utils\WebLibraryManager\WebLibraryManager instance.

The usage is simple: when you want to import a new Javascript/CSS library, you create an instance of WebLibrary, you put the list of CSS/JS files in it, and you add this instance to WebLibraryManager. When you call the toHtml() method of the WebLibraryManager, it will output all HTML tags to import CSS files first, then all JS files.

If your WebLibrary depends on other web libraries (for instance, if you import jQueryUI, that requires jQuery), the WebLibraryManager will manage all the dependencies for you. If you have special needs about the way to import CSS/JS files, you can develop your own WebLibraryRenderer that will render your library (for instance with inline JS, ...)

<script src="http://www.sveido.com/mermaid/dist/mermaid.full.min.js"></script> <style> g.label { color: #333; } </style> graph LR; A[WebLibraryManager]-->B[jQuery]; A-->C[jQuery-UI]; A-->D[Bootstrap]; A-->E[Other library]; A-->F[...];

Installing WebLibraryManager:

WebLibraryManager comes as a composer package (the name of the package is mouf/html.utils.weblibrarymanager) Usually, you do not install this package by yourself. It should be a dependency of a Mouf template that you will use.

Still want to install it manually? Use the packagist package:

composer.json

{
    "require": {
        "mouf/html.utils.weblibrarymanager": "^4"
    }
}

Getting an instance of WebLibraryManager

Most of the time, you will be using WebLibraryManager through a Mouf template. You can simply get an instance of the WebLibraryManager from the template:

class MyController {
	/**
	 * @var $template TemplateInterface
	 */
	protected $template;

	...

	public function myAction() {
		$webLibraryManager = $this->template->getWebLibraryManager();
		...
	}
}

Adding a JS or CSS file programmatically

The most trivial use of the WebLibraryManager is adding a JS or CSS file to your web page. To do this, you simply write:

// Import a JS file from your project
// The file is relative to your ROOT_URL
$webLibraryManager->addJsFile('src/javascript/myJsFile.js');

// Import a JS file from a CDN
$webLibraryManager->addJsFile('https://code.jquery.com/jquery-2.1.1.min.js');
// Import a CSS file from your project
// The file is relative to your ROOT_URL
$webLibraryManager->addCssFile('src/css/myStyle.css');
When you include a file, if the file does NOT start with a '/', it is relative to your root URL. If the file start with a '/', it is absolute.

You can add any kind of script at the end of the <head> tag using:

$webLibraryManager->addAdditionalScript('<script>alert("Hello world!")</script>');

You can also declare a complete WebLibrary object and add it.

$webLibrary = new WebLibrary(
	["javascript/file1.js", "javascript/file2.js"],
	["css/style1.css", "css/style2.css"]);

$webLibraryManager->addLibrary($webLibrary);

This codes create a new WebLibrary and adds it to the WebLibraryManager. The WebLibrary takes an array of Javascript files as first argument, and an array of CSS files as second argument.

Alternatively, if you want to add some CSS styles or Javascript scripts (or anything else) to your <head> tag, you can simply use the InlineWebLibrary class that let's you add what you want in the JS, CSS or additional part of your template.

Outputing the result

Simply use the toHtml() method to output the content of the WebLibraryManager:

$webLibraryManager->toHtml();

This call is usually performed by your template.

The WebLibraryManager will group its output in 3 categories:

  • CSS declarations go first
  • Then JS file declarations
  • And finally anything else (usually JS scripts directly put in the web page)

Adding a new WebLibrary by configuration

You can register a new WebLibrary in your container using a service provider.

Assuming you use Funky for creating your service providers, your code will look like this:

use TheCodingMachine\Funky\ServiceProvider;

class MyWebLibraryServiceProvider extends ServiceProvider {
    /**
     * @Factory(name="myWebLibrary", tags={@Tag(name="webLibraries")})
     */
    public static function createWebLibrary(ContainerInterface $container): WebLibrary
    {
        return new WebLibrary(['foo/bar.js', 'http://exemple.com/foo.js'],
            ['foo/bar.css', 'http://exemple.com/foo.css'], $container->get('root_url'));
    }
};
Note: Do not start the JS or CSS file path with a /. That way, the path is relative to the ROOT_URL (the root of your web application). You can also enter a full path (http://...) if you want to use hosted libraries, CDN, etc...

Writing your own WebLibraries

If you have specific needs, the WebLibrary class might not be enough. For instance, you might want to output something else than <script> tags.

For these use-cases, you can write a class that implement the WebLibraryInterface interface. Since the WebLibraryManager uses Mouf's rendering system, you will need to provide a template for your class with 3 different contexts: "js", "css" and "additional".

Here is a simple sample:

The GoogleAnalyticsWebLibrary is a simple class that will output Javascript required by Google Analytics. This class contains almost nothing except the 2 properties required (accountKey and domainName).

Rendering is performed by the 3 templates here:

Because the Google Analytics tracking code is in the "additional" section, it will be displayed after all CSS and JS files are loaded.