https://github.com/thecodingmachine/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 are included as well.
https://github.com/thecodingmachine/html.utils.weblibrarymanager
Last synced: about 1 year ago
JSON representation
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 are included as well.
- Host: GitHub
- URL: https://github.com/thecodingmachine/html.utils.weblibrarymanager
- Owner: thecodingmachine
- License: mit
- Created: 2012-08-27T19:58:34.000Z (almost 14 years ago)
- Default Branch: 4.0
- Last Pushed: 2022-12-01T16:31:33.000Z (over 3 years ago)
- Last Synced: 2025-04-11T18:59:48.443Z (about 1 year ago)
- Language: PHP
- Size: 213 KB
- Stars: 0
- Watchers: 8
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://packagist.org/packages/mouf/html.utils.weblibrarymanager)
[](https://packagist.org/packages/mouf/html.utils.weblibrarymanager)
[](https://packagist.org/packages/mouf/html.utils.weblibrarymanager)
[](https://packagist.org/packages/mouf/html.utils.weblibrarymanager)
[](https://travis-ci.org/thecodingmachine/html.utils.weblibrarymanager)
[](https://coveralls.io/github/thecodingmachine/html.utils.weblibrarymanager?branch=4.0)
[](https://scrutinizer-ci.com/g/thecodingmachine/html.utils.weblibrarymanager/?branch=4.0)
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](http://mouf-php.com/packages/mouf/getting-things-done-basic-edition/doc/adding_js_and_css_files.md).
Introduction
------------
WebLibraryManager is a [Mouf package](http://mouf-php.com) that allows you to import CSS/Javascript in your project the simple way.
Since v4, WebLibraryManager is using [container-interop/service-provider](https://github.com/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, ...)
g.label {
color: #333;
}
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**
```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:
```php
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:
```php
// 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');
```
```php
// 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:
```php
$webLibraryManager->addAdditionalScript('alert("Hello world!")');
```
You can also declare a complete `WebLibrary` object and add it.
```php
$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`:
```php
$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](https://github.com/thecodingmachine/funky), your code will look like this:
```php
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`](https://github.com/thecodingmachine/modules.google-analytics/blob/4.0/src/Mouf/Modules/GoogleAnalytics/GoogleAnalyticsWebLibrary.php#L16)
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:
- [JS template](https://github.com/thecodingmachine/modules.google-analytics/blob/4.0/src/templates/Mouf/Modules/GoogleAnalytics/GoogleAnalyticsWebLibrary__js.php) is empty
- [CSS template](https://github.com/thecodingmachine/modules.google-analytics/blob/4.0/src/templates/Mouf/Modules/GoogleAnalytics/GoogleAnalyticsWebLibrary__css.php) is empty
- [Additional template](https://github.com/thecodingmachine/modules.google-analytics/blob/4.0/src/templates/Mouf/Modules/GoogleAnalytics/GoogleAnalyticsWebLibrary__additional.php) contains the Google Analytics code.
Because the Google Analytics tracking code is in the "additional" section, it will be displayed after all CSS and JS files are loaded.