Javascript- und CSS-Registrierung in Formaten

Einleitung

Im eCMS gibt es die Möglichkeit Javascript und CSS Libraries in Formaten einzubinden, die On-Demand bei der Seitengenerierung im Frontend eingebunden werden. Damit können nur die Bibliotheken eingebunden werden, die auch wirklich benötigt werden. Dies bringt weitere Performanceverbesserungen für das Website Frontend.

Methoden

Einzelne Dateien registrieren

Für die Registrierung von Javascript Libraries stellt das eCMS die Methode

$eCMS->srcx->js_use("<filepath>");

und für CSS Libraries die Methode

$eCMS->srcx->css_use("<filepath>");

zur Verfügung.

Der "<filepath>" ist der relative Pfad zur JS- oder CSS-Datei im lib_res-Verzeichnis der eCMS-Site.

Die folgende JS Library Registrierung

$eCMS->srcx->js_use("js/jquery/plugin/jquery.alerts.js");

würde vom eCMS in die folgende script-Einbindung gewandelt werden

<script src="<site_dir_www>/files/lib_res/js/jquery/plugin/jquery.alerts.js" type="text/javascript"></script>

Das lib_res-Verzeichnis "/files/lib_res" lässt sich derzeit nicht konfigurieren, sondern ist für die Einbindung fix hinterlegt. Für spätere Versionen wäre hier konfigurierbare Verzeichnisse oder URL's (Verteilung auf mehrere Domains) denkbar.

In den "filepath" von JS- und CSS-Libraries sollte auf Versionsnummern (z.B. "js/jquery/1.7.0/...") verzichtet werden.

Mehrere Dateien registrieren

Um direkt eine Liste von Javascript oder CSS Libraries zu registrieren stellt das eCMS die Methoden

$eCMS->srcx->js_useList (
	    array(
	        "<js-filepath-1>",
	        "<js-filepath-2>",
	    )
	);

und

$eCMS->srcx->css_useList (
	    array(
	        "<css-filepath1>",
	        "<css-filepath1>",
	    )
	);

zur Verfügung.

On-Demand Registrierung abschalten

Um die die On-Demand-Registrierung für eine eCMS-Site vollständig abzuschalten, können in den "site_xsettings" die beiden folgenden Flags gesetzt werden.

$eCMS->config['site_xsettings']['srcx']['js_use_disable'] = 1;

und

$eCMS->config['site_xsettings']['srcx']['css_use_disable'] = 1;

Elementschreibweise

Zur Einbindung via Elementschreibweise gibt es zwei Formate:

${eCMS-SRCX-JS-USE:<file>}$ bzw. ${eCMS-SRCX-JS-USE:(files=<file1>#<file2>#<file3>)}$
 
	${eCMS-SRCX-CSS-USE:<file>}$ bzw. ${eCMS-SRCX-CSS-USE:(files=<file1>#<file2>#<file3>)}$