Modulstruktur

Das alaf-Framework ist modular aufgebaut. Somit können Fremdmodule oder Eigenentwicklungen leicht hinzugefügt werden, um zusätzliche Funktionen in ihrem Projekt zu realisieren.

Die zu einem Modul gehörenden Dateien sollten in folgender Weise strukturiert sein, damit das Framework korrekt mit dem Modul arbeitet.

Nachstehend aufgeführt die empfohlene Ordnerstruktur innerhalb des Moduls. Diese Angaben sind teilweise optional, d.h. sie werden nicht für jedes Modul vollständig benötigt:

Modulordner

Der Modulordner sollte einen eindeutigen Namen haben. Dieser Name wird vom Framework in der Modulverwaltung verwendet, um die notwendigen Einstellungen zu ermöglichen.

Der Modulordner sollte enthalten:

index.php

Der Modulordner kann enthalten:

impressum.php

Ordner: admin

Der admin - Ordner enthält grundsätzlich die "Sprungverteiler"-Datei admin.php. Diese Datei wird benötigt, um die Funktionen im Administrationsbereich (Backend) zu routen.

In der Datei configuration.xml wird die Modulkonfiguration im XML-Format hinterlegt. Diese Datei wird vom alaf-Framework gelesen, um den Aufbau des Administrationsbereich (Backend) zu gestalten.

Ordner: core

Im core - Ordner werden die Dateien abgelegt, die von den Grundfunktionen des alaf-Frameworks aufgerufen werden sollen. Dieses sind z.B.:

Ordner: includes

Hier liegen die benötigten Include-Dateien für das Modul. Einde detailierte Auflistung folgt ggf.

Ordner: lang

Enthält die Sprachendateien für die modulbezogenen Bezeichnungen.

Ordner: templates

Hier sollten die Vorlagedateien (HTML-Templates) abgelegt werden

Last updated