# 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:

    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");

Auf dieses Skript wird generell als "layer" Skript referiert.

Im eigenen Anwendungs Layer, würde man dann Dojo instruieren dieses Modul zu laden:

    <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>

Wenn man Zend_Dojo verwendet um das zu tun, würde man das folgende durchführen:

    $view->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 dass 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:

    $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);

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:

    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);
        }
    }

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ährend der Instanzierung übergeben werden kann, kann es einer Instanz auch über die setView() Methode übergeben werden:

    $build->setView($view);

#### Setzen des Namen eines Layers

Wärend der Name des Layers während Instanzierung übergeben werden kann, kann er der Instanz auch über die setLayerName() Methode übergeben werden:

    $build->setLayerName("custom.main");

#### Einfügen von onLoad Events im erstellten Layer

`dojo.addOnLoad` ist eine nützliche Utility für die Spezifikation von Actions welche getriggert werden sollen wenn der DOM fertig geladen wurde. Der dojo() View Helfer kann diese Statements über seine Methoden addOnLoad() und onLoadCapture() erstellen. In einigen Fällen macht es Sinn diese in die eigene Layer Datei zu geben statt diese über das eigene View Skript darzustellen.

Standardmäßig werden Sie nicht dargestellt; um das zu aktivieren muß der Konfigurationsschlüssel consumeOnLoad bei der Instanzierung angegeben werden:

    $build = new Zend_Dojo_BuildLayer(array(
        'view'          => $view,
        'layerName'     => 'custom.main',
        'consumeOnLoad' => true,
    ));

Alternativ kann die setConsumeOnLoad() Methode nach der Instanzierung verwendet werden:

    $build->setConsumeOnLoad(true);

#### Geholtes Javascript in den erstellten Layer einfügen

Der dojo() View Helfer enthält Methoden für das Fangen von jeglichem JavaScript um diesen im <script> einzufügen, welches die verschiedenen `dojo.require` und `dojo.addOnLoad` 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.

Standardmäßig werden Sie nicht dargestellt; um das zu aktivieren muß der Konfigurationsschlüssel consumeJavascript bei der Instanzierung angegeben werden:

    $build = new Zend_Dojo_BuildLayer(array(
        'view'              => $view,
        'layerName'         => 'custom.main',
        'consumeJavascript' => true,
    ));

Alternativ kann die setConsumeJavascript() Methode nach der Instanzierung verwendet werden:

    $build->setConsumeJavascript(true);

## Erstellung von Build Profilen mit Zend_Dojo_BuildLayer

Einer der Hauptvorteile eines Dojo build Layers ist die Möglichkeit der Erstellung eines eigenen Builds. Zend_Dojo_BuildLayer bietet Funktionalitäten für die Erstellung von Build Profilen.

Der einfachste Usecase is die Verwendung der generateBuildProfile() Methode und dem Senden der Ausgabe in eine Datei:

    $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);

Wie bei der Erstellung von Layern kann es gewünscht sein das über einen dispatchLoopShutdown() 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:

    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);
        }

    }

Wie bei den Modul Layern beschrieben sollte man die Datei nur einmal erstellen.

### Optionen für ein Build Profil

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.

Als Beispiel will man zum Beispiel spezifizieren welche Art von Optimierung durchgeführt werden soll, ob die CSS 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 Dojo Build Dokumentation und die begleitende Dokumentation lesen.

Das Setzen dieser Optionen ist trivial: durch 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:

    {
        action:        "release",
        optimize:      "shrinksafe",
        layerOptimize: "shrinksafe",
        copyTests:     false,
        loader:        "default",
        cssOptimize:   "comments"
    }

Man kann jegliche Schlüssel und Werte Paare übergeben; das Dojo Build Skript ignoriert jene die es nicht versteht.

Als Beispiel für das Setzen von Optionen:

    // 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',
    ));