1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
|
<?xml version="1.0" encoding="UTF-8"?>
<!-- EN-Revision: 24249 -->
<!-- Reviewed: no -->
<sect1 id="zend.dojo.build-layers">
<title>Support für den Build Layer von Zend_Dojo</title>
<sect2 id="zend.dojo.build-layers.introduction">
<title>Einführung</title>
<para>
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
<acronym>CSS</acronym> Minimalisierungen durchführen.
</para>
<para>
Um einen Build Layer zu erstellen würde man traditioneller Weise eine JavaScript Datei
erstellen die <command>dojo.require</command> 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:
</para>
<programlisting language="javascript"><![CDATA[
dojo.provide("custom.main");
dojo.require("dijit.layout.TabContainer");
dojo.require("dijit.layout.ContentPane");
dojo.require("dijit.form.Form");
dojo.require("dijit.form.Button");
dojo.require("dijit.form.TextBox");
]]></programlisting>
<para>
Auf dieses Skript wird generell als "layer" Skript referiert.
</para>
<para>
Im eigenen Anwendungs Layer, würde man dann Dojo instruieren dieses Modul zu laden:
</para>
<programlisting language="html"><![CDATA[
<html>
<head>
<script type="text/javascript" src="/js/dojo/dojo.js"></script>
<script type="text/javascript">
dojo.registerModulePath("custom", "../custom/");
dojo.require("custom.main");
</script>
]]></programlisting>
<para>
Wenn man <classname>Zend_Dojo</classname> verwendet um das zu tun, würde man das
folgende durchführen:
</para>
<programlisting language="php"><![CDATA[
$view->dojo()->registerModulePath('custom', '../custom/')
->requireModule('custom.main');
]]></programlisting>
<para>
Aber da <classname>Zend_Dojo</classname> die verschiedenen
<command>dojo.require</command> Anweisungen zusammenfügt, wie kann man das eigene Layer
Skript erstellen? Man könnte jede Seite öffnen, die erstellten
<command>dojo.require</command> Anweisungen anschauen und Sie herausschneiden und in
eine Layer Skript Datei manuell einfügen.
</para>
<para>
Trotzdem existiert eine bessere Lösung: Da <classname>Zend_Dojo</classname> diese
Informationen bereits zusammenfügt, kann man diese Information einfach herausziehen und
die eigene Layer Datei erstellen. Das ist der Sinn von
<classname>Zend_Dojo_BuildLayer</classname>.
</para>
</sect2>
<sect2 id="zend.dojo.build-layers.usage">
<title>Erstellen eigener Modul Layer mit Zend_Dojo_BuildLayer</title>
<para>
Am einfachsten kann man einfach <classname>Zend_Dojo_BuildLayer</classname>
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.
</para>
<para>
Nehmen wir als Beispiel an dass man den Modul Layer "<filename>custom.main</filename>"
erstellen will. Angenommen man folgt der vorgeschlagenen Projekt Verzeichnisstruktur,
und man will JavaScript Dateien unter <filename>public/js/</filename> speichern, dann
könnte man das folgende tun:
</para>
<programlisting language="php"><![CDATA[
$build = new Zend_Dojo_BuildLayer(array(
'view' => $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);
]]></programlisting>
<para>
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
<methodname>dojo()</methodname> Helfer vollständig bestückt wurde. Ein einfacher
Weg um das zu tun ist die Verwendung des Front Controller Plugins, mit einem
<methodname>dispatchLoopShutdown()</methodname> Hook:
</para>
<programlisting language="php"><![CDATA[
class App_Plugin_DojoLayer extends Zend_Controller_Plugin_Abstract
{
public $layerScript = APPLICATION_PATH . '/../public/js/custom/main.js';
protected $_build;
public function dispatchLoopShutdown()
{
if (!file_exists($this->layerScript)) {
$this->generateDojoLayer();
}
}
public function getBuild()
{
$viewRenderer = Zend_Controller_Action_HelperBroker::getStaticHelper(
'ViewRenderer'
);
$viewRenderer->initView();
if (null === $this->_build) {
$this->_build = new Zend_Dojo_BuildLayer(array(
'view' => $viewRenderer->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);
}
}
]]></programlisting>
<note>
<title>Den Layer nicht in jeder Seite erstellen</title>
<para>
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.
</para>
</note>
<sect3 id="zend.dojo.build-layers.usage.options">
<title>Optionen für BuildLayer</title>
<para>
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.
</para>
<sect4 id="zend.dojo.build-layers.usage.options.view">
<title>Setzen des View Objekts</title>
<para>
Wärend das View Objekt während der Instanzierung übergeben werden kann, kann es
einer Instanz auch über die <methodname>setView()</methodname> Methode
übergeben werden:
</para>
<programlisting language="php"><![CDATA[
$build->setView($view);
]]></programlisting>
</sect4>
<sect4 id="zend.dojo.build-layers.usage.options.layername">
<title>Setzen des Namen eines Layers</title>
<para>
Wärend der Name des Layers während Instanzierung übergeben werden kann, kann er
der Instanz auch über die <methodname>setLayerName()</methodname> Methode
übergeben werden:
</para>
<programlisting language="php"><![CDATA[
$build->setLayerName("custom.main");
]]></programlisting>
</sect4>
<sect4 id="zend.dojo.build-layers.usage.options.onload">
<title>Einfügen von onLoad Events im erstellten Layer</title>
<para>
<command>dojo.addOnLoad</command> ist eine nützliche Utility für die
Spezifikation von Actions welche getriggert werden sollen wenn der
<acronym>DOM</acronym> fertig geladen wurde. Der <methodname>dojo()</methodname>
View Helfer kann diese Statements über seine Methoden
<methodname>addOnLoad()</methodname> und
<methodname>onLoadCapture()</methodname> erstellen. In einigen Fällen macht es
Sinn diese in die eigene Layer Datei zu geben statt diese über das eigene View
Skript darzustellen.
</para>
<para>
Standardmäßig werden Sie nicht dargestellt; um das zu aktivieren muß der
Konfigurationsschlüssel <property>consumeOnLoad</property> bei der
Instanzierung angegeben werden:
</para>
<programlisting language="php"><![CDATA[
$build = new Zend_Dojo_BuildLayer(array(
'view' => $view,
'layerName' => 'custom.main',
'consumeOnLoad' => true,
));
]]></programlisting>
<para>
Alternativ kann die <methodname>setConsumeOnLoad()</methodname> Methode nach
der Instanzierung verwendet werden:
</para>
<programlisting language="php"><![CDATA[
$build->setConsumeOnLoad(true);
]]></programlisting>
</sect4>
<sect4 id="zend.dojo.build-layers.usage.options.javascript">
<title>Geholtes Javascript in den erstellten Layer einfügen</title>
<para>
Der <methodname>dojo()</methodname> View Helfer enthält Methoden für das
Fangen von jeglichem JavaScript um diesen im <script> einzufügen, welches
die verschiedenen <command>dojo.require</command> und
<command>dojo.addOnLoad</command> Anweisungen enthält. Das kann bei der
Erstellung von standardmäßigen Datenspeichern oder Objekten mit globaler
Sichtbarkeit nützlich sein welche in der gesamten Anwendung verwendet werden.
</para>
<para>
Standardmäßig werden Sie nicht dargestellt; um das zu aktivieren muß der
Konfigurationsschlüssel <property>consumeJavascript</property> bei der
Instanzierung angegeben werden:
</para>
<programlisting language="php"><![CDATA[
$build = new Zend_Dojo_BuildLayer(array(
'view' => $view,
'layerName' => 'custom.main',
'consumeJavascript' => true,
));
]]></programlisting>
<para>
Alternativ kann die <methodname>setConsumeJavascript()</methodname> Methode
nach der Instanzierung verwendet werden:
</para>
<programlisting language="php"><![CDATA[
$build->setConsumeJavascript(true);
]]></programlisting>
</sect4>
</sect3>
</sect2>
<sect2 id="zend.dojo.build-layers.profiles">
<title>Erstellung von Build Profilen mit Zend_Dojo_BuildLayer</title>
<para>
Einer der Hauptvorteile eines Dojo build Layers ist die Möglichkeit der Erstellung eines
eigenen Builds. <classname>Zend_Dojo_BuildLayer</classname> bietet Funktionalitäten für
die Erstellung von Build Profilen.
</para>
<para>
Der einfachste Usecase is die Verwendung der
<methodname>generateBuildProfile()</methodname> Methode und dem Senden der Ausgabe in
eine Datei:
</para>
<programlisting language="php"><![CDATA[
$build = new Zend_Dojo_BuildLayer(array(
'view' => $view,
'layerName' => 'custom.main',
));
$profile = $build->generateBuildProfile();
$filename = APPLICATION_PATH . '/../misc/scripts/custom.profile.js';
file_put_contents($filename, $profile);
]]></programlisting>
<para>
Wie bei der Erstellung von Layern kann es gewünscht sein das über einen
<methodname>dispatchLoopShutdown()</methodname> Plugin Hook zu automatisieren; man
könnte sogar einfach den einen, der für die Erstellung der Layer angezeigt wird,
so ändern das er wie folgt gelesen wird:
</para>
<programlisting language="php"><![CDATA[
class App_Plugin_DojoLayer extends Zend_Controller_Plugin_Abstract
{
public $layerScript = APPLICATION_PATH
. '/../public/js/custom/main.js';
public $buildProfile = APPLICATION_PATH
. '/../misc/scripts/custom.profile.js';
protected $_build;
public function dispatchLoopShutdown()
{
if (!file_exists($this->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);
}
}
]]></programlisting>
<para>
Wie bei den Modul Layern beschrieben sollte man die Datei nur einmal erstellen.
</para>
<sect3 id="zend.dojo.build-layers.profiles.options">
<title>Optionen für ein Build Profil</title>
<para>
Die obige Funktionalität wird in den meisten Situationen ausreichend sein. Der
einzige Weg um die Erstellung der Build Profile anzupassen besteht darin
zusätzliche Optionen für Build Profile verwenden.
</para>
<para>
Als Beispiel will man zum Beispiel spezifizieren welche Art von Optimierung
durchgeführt werden soll, ob die <acronym>CSS</acronym> Dateien im Layer optimiert
werden sollen, oder nicht, ob Test in den Build kopiert werden sollen, oder nicht,
usw. Für eine Aufstellung vorhandener Optionen, sollte man die
<ulink url="http://docs.dojocampus.org/build/index">Dojo Build Dokumentation</ulink>
und die <ulink
url="http://dojotoolkit.org/reference-guide/dojo/index.html#package-system">begleitende
Dokumentation</ulink> lesen.
</para>
<para>
Das Setzen dieser Optionen ist trivial: durch Verwendung der
<methodname>addProfileOption()</methodname>,
<methodname>addProfileOptions()</methodname>, oder
<methodname>setProfileOptions()</methodname> 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.
</para>
<para>
Standardmäßig werden die folgenden Optionen gesetzt:
</para>
<programlisting language="javascript"><![CDATA[
{
action: "release",
optimize: "shrinksafe",
layerOptimize: "shrinksafe",
copyTests: false,
loader: "default",
cssOptimize: "comments"
}
]]></programlisting>
<para>
Man kann jegliche Schlüssel und Werte Paare übergeben; das Dojo Build Skript
ignoriert jene die es nicht versteht.
</para>
<para>
Als Beispiel für das Setzen von Optionen:
</para>
<programlisting language="php"><![CDATA[
// Eine einzelne Option:
$build->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',
));
]]></programlisting>
</sect3>
</sect2>
</sect1>
|
