Support für den Build Layer von Zend_Dojo
Einführung
Dojo Build Layer bieten einen reinen Pfad von der Entwicklung zur Produktion wenn Dojo
für den eigenen UI Layer verwendet wird. In der Entwicklung kann man auf-Wunsch laden,
und schnelles Anwendungs Prototyping erhalten; ein Build Layer nimmt alle Abhängigkeiten
von Dojo und kompiliert diese in eine einzelne Datei, wobei optional Leerzeichen und
Kommentare herausgenommen werden, führt Code Heuristiken durch um weitere
Minimalisierungen von Variablennamen zu erlauben. Zusätzlich kann es auch
CSS Minimalisierungen durchführen.
Um einen Build Layer zu erstellen würde man traditioneller Weise eine JavaScript Datei
erstellen die dojo.require Anweisungen für jede Abhängigkeit hat, und
optional einigen zusätzlichen Code den man ausführen will wen das Skript geladen wird.
Als Beispiel:
Auf dieses Skript wird generell als "layer" Skript referiert.
Im eigenen Anwendungs Layer, würde man dann Dojo instruieren dieses Modul zu laden:
]]>
Wenn man Zend_Dojo verwendet um das zu tun, würde man das
folgende durchführen:
dojo()->registerModulePath('custom', '../custom/')
->requireModule('custom.main');
]]>
Aber da Zend_Dojo die verschiedenen dojo.require
Anweisungen zusammenfügt, wie kann man das eigene Layer Skript erstellen? Man könnte
jede Seite öffnen, die erstellten dojo.require Anweisungen anschauen und
Sie herausschneiden und in eine Layer Skript Datei manuell einfügen.
Trotzdem existiert eine bessere Lösung: Da Zend_Dojo diese
Informationen bereits zusammenfügt, kann man diese Information einfach herausziehen und
die eigene Layer Datei erstellen. Das ist der Sinn von
Zend_Dojo_BuildLayer.
Erstellen eigener Modul Layer mit Zend_Dojo_BuildLayer
Am einfachsten kann man einfach Zend_Dojo_BuildLayer
instanziieren, es dem View Objekt zusammen mit dem Namen des eigenen Modul Layers
füttern, und es den Inhalt der Layer Datei erstellen lassen; es liegt an einem selbst
diese anschließend auf die Festplatte zu schreiben.
Nehmen wir als Beispiel an das man den Modul Layer "custom.main" erstellen will.
Angenommen man folgt der vorgeschlagenen Projekt Verzeichnisstruktur, und man
will JavaScript Dateien unter public/js/ speichern, dann
könnte man das folgende tun:
$view,
'layerName' => 'custom.main',
));
$layerContents = $build->generateLayerScript();
$filename = APPLICATION_PATH . '/../public/js/custom/main.js';
if (!dir_exists(dirname($filename))) {
mkdir(dirname($filename));
}
file_put_contents($filename, $layerContents);
]]>
Wann sollte man das obige durchführen? Damit es korrekt arbeitet, muß man es nach
der Darstellung aller View Skripte und des Layouts tun um sicherzustellen das der
dojo() Helfer vollständig bestückt wurde. Ein einfacher
Weg um das zu tun ist die Verwendung des Front Controller Plugins, mit einem
dispatchLoopShutdown() Hook:
layerScript)) {
$this->generateDojoLayer();
}
}
public function getBuild()
{
if (null === $this->_build) {
$this->_build = new Zend_Dojo_BuildLayer(array(
'view' => $view,
'layerName' => 'custom.main',
));
}
return $this->_build;
}
public function generateDojoLayer()
{
$build = $this->getBuild();
$layerContents = $build->generateLayerScript();
if (!dir_exists(dirname($this->layerScript))) {
mkdir(dirname($this->layerScript));
}
file_put_contents($this->layerScript, $layerContents);
}
}
]]>
Den Layer nicht in jeder Seite erstellen
Es ist verführerisch das Layer Skript auf jeder einzelnen Seite zu erstellen.
Aber das ist Ressourcen intensiv da hierbei für jede Seite auf die Festplatte
geschrieben werden muß. Zusätzlich erhält man keine Vorteile von Client seitigem
Cachen, da mtime von der Datei sich jedesmal ändert. Die Datei sollte nur
einmal geschrieben werden.
Optionen für BuildLayer
Die obige Funktionalität wird in den meisten Situationen ausreichen. Für jene die
weitere Anpassungen benötigen, können eine Vielzahl von Optionen verwendet werden.
Setzen des View Objekts
Wärend das View Objekt wärend der Instanzierung übergeben werden kann, kann es
einer Instanz auch über die setView() Methode
übergeben werden:
setView($view);
]]>
Setzen des Namen eines Layers
Wärend der Name des Layers wärend Instanzierung übergeben werden kann, kann er
der Instanz auch über die setLayerName() Methode
übergeben werden:
setLayerName("custom.main");
]]>
Einfügen von onLoad Events im erstellten Layer
dojo.addOnLoad is a useful utility for
specifying actions that should trigger when the DOM has
finished loading. The dojo() view helper can
create these statements via its
addOnLoad() and
onLoadCapture*() methods. In some
cases, it makes sense to push these into your layer file
instead of rendering them via your view scripts.
By default, these are not rendered; to enable them, pass the
consumeOnLoad configuration key during
instantiation:
$view,
'layerName' => 'custom.main',
'consumeOnLoad' => true,
));
]]>
Alternately, you can use the
setConsumeOnLoad() method after
instantiation:
setConsumeOnLoad(true);
]]>
Including captured JavaScript in the generated layer
The dojo() view helper includes methods for
capturing arbitrary JavaScript to include in the
<script> tag containing the various
dojo.require and dojo.addOnLoad
statements. This can be useful when creating default data
stores or globally scoped objects used throughout your
application.
By default, these are not rendered; to enable them, pass the
consumeJavascript configuration key during
instantiation:
$view,
'layerName' => 'custom.main',
'consumeJavascript' => true,
));
]]>
Alternately, you can use the
setConsumeJavascript() method after
instantiation:
setConsumeJavascript(true);
]]>
Generating Build Profiles with Zend_Dojo_BuildLayer
One of the chief benefits of a Dojo module layer is that it
facilitates the creation of a custom build.
Zend_Dojo_BuildLayer has functionality for
generate build profiles.
The simplest use case is to utilize the
generateBuildProfile() method and send the
output to a file:
$view,
'layerName' => 'custom.main',
));
$profile = $build->generateBuildProfile();
$filename = APPLICATION_PATH . '/../misc/scripts/custom.profile.js';
file_put_contents($filename, $profile);
]]>
Just like generating layers, you may want to automate this via a
dispatchLoopShutdown() plugin hook; you
could even simply modify the one shown for generating layers to read
as follows:
layerScript)) {
$this->generateDojoLayer();
}
if (!file_exists($this->buildProfile)) {
$this->generateBuildProfile();
}
}
public function generateDojoLayer() { /* ... */ }
public function generateBuildProfile()
{
$profile = $this->getBuild()->generateBuildProfile();
file_put_contents($this->buildProfile, $profile);
}
}
]]>
As noted, with module layers, you should only create the file once.
Build Profile options
The above functionality will suffice for most situations. The
only way to customize build profile generation is to provide
additional build profile options to utilize.
As an example, you may want to specify what type of
optimizations should be performed, whether or not to optimize
CSS files in the layer, whether or not to copy tests into the
build, etc. For a listing of available options, you should read
the Dojo
Build documentation and accompanying
documentation.
Das Setzen dieser Optionen ist trivial: Verwendung der
addProfileOption(),
addProfileOptions(), oder
setProfileOptions() Methoden. Die erste Methode fügt einen
einzelnes Schlüssel und Werte Options Paar hinzu, die zweite fügt mehrere hinzu,
und die dritte überschreibt alle Optionen in der Liste von Schlüssel und Werte
Paaren angegeben sind.
Standardmäßig werden die folgenden Optionen gesetzt:
Man kann jegliche Schlüssel und Werte Paare übergeben; das Dojo Build Skript
ignoriert jene die es nict versteht.
Als Beispiel für das Setzen von Optionen:
addProfileOption('version', 'zend-1.3.1');
// Mehrere Optionen:
$build->addProfileOptions(array(
'loader' => 'xdomain',
'optimize' => 'packer',
));
// Oder Optionen überschreiben:
$build->setProfileOptions(array(
'version' => 'custom-1.3.1',
'loader' => 'shrinksafe',
'optimize' => 'shrinksafe',
));
]]>