Modul erstellen
n2n ist modulartig aufgebaut. In diesem Kapitel zeigen wir dir, wie du eigene n2n Module erstellen kannst. Um ein Modul zu erstellen, musst du nur die benötigten Verzeichnisse anlegen.
Benötigte Verzeichnisse
Um ein Modul zu erstellen, musst du im app Verzeichnis ein neues Unterverzeichnis erstellen. Der Name des Ordners ist der Namespace des Moduls. Damit es von n2n erkannt wird, musst du im Verzeichnis var/etc einen Unterordner mit dem Namen des Namespaces erstellen. Mit dem Erstellen dieses Unterordners ist das Modul installiert. Ausserdem empfehlen wir, unter public/assets/ ebenfalls einen Unterordner mit dem Namespace zu erstellen. Hier können alle Bilder, JS- und CSS-Dateien abgelegt werden, welche dein Modul benötigt.
Zusammenfassend werden für die Erstellung eines Moduls folgende Ordner benötigt:
app/[Modul-Namespace]var/etc/[Modul-Namespace]public/assets/[Modul-Namespace](freiwillig, aber empfohlen)
app/ch/n2n/example. In diesem Falle wäre der Namespace für dieses Modul ch\n2n\example. Beachte, dass du in diesem Falle im etc-Verzeichnis den Ordner var/etc/ch-n2n-example erstellen musst. Die Backslashes des Namespaces werden durch Bindestriche ersetzt.Empfohlene Modulstruktur
n2n arbeitet mit Namespaces. Darum ist der Entwickler, innerhalb seines Modul-Verzeichnisses, in der Wahl der Struktur frei. Grundsätzlich empfehlen wir folgende Unterordner:
/bofür Business Objects/controllerfür alle Controller/modelfür alle Models/viewfür alle Views
Es ist problemlos möglich, zusätzliche Ordner anzulegen. Bei grossen Modulen empfehlen wir, innerhalb der oben genannten Verzeichnisse, Unterverzeichnisse zu erstellen, welche die Übersichtlichkeit verbessern.