Contao Modul erstellen – Ordnerstruktur

Die Ordnerstruktur eines neues Moduls sieht in der Regel folgendermaßen aus:

Allgemeine Ordnerstruktrur eines Contao ModulsIch habe unter system/modules ein Ordner customers erstellt. Natürlich muß man den Order mit bedacht benennen, den Modulnamen können logischerweise nur einmal vergeben werden. Für dieses Beispiel reicht das jedoch aus. Es ist meist eine gute Idee mit Präfixen zu arbeiten z. B. zb_customers.

Im Modulordner customers finden sich folgende Unterordner:

  • config
    Dieser Ordner enthält die allgemeine Konfiguationsdatei config.php, in der z. B. Registrierung von
    Backend- und Frontend-Modulen vorgenommen wird. Desweiteren kann dort eigenes oder zusätzliches Javascript eingebunden oder Hooks definiert werden. Sollte man in seinem Modul Datenbanktabellen benötigen, kann dort eine database.sql erstellt werden, in der die SQL-Beschreibung der Tabelle(n) vorgenommen werden.
  • dca
    DCA steht für Data Container Array und sind quasi die Definitionen oder die programmtechnische Beschreibungen zu den Datenbanktabellen. Beispielsweise kann dort die Standard-Sortierung, verfügbare Operationen (Bearbeiten, Kopieren, etc.) konfiguiert werden und vieles mehr.
  • html
    Wird nur benötigt, wenn z. B. Grafiken, CSS-Datei, etc. eingebunden werden sollen.
  • languages
    Wie der Name schon sagt, finden sich dort die Übersetzungen zu dem Modul. Innerhalb des Ordners gibt es weitere Unterordner die nach den Sprachkürzel benennt sind. Ich denke man kann sich dabei ander ISO 639-1 orientieren (de, en, fr, nl, it, … um nur einige zu nennen). Prinzipiell reicht es dort eine einzige Datei zu erstellen, in der alle Übersetzungen enthalten sind. Schaut man sich bestehende Module in Contao an, werden jedoch logisch sinnvolle Einheiten gebildet (z. B. modules.php für allgemeine Übersetzungen, tl_xxx für eine Datenbanktabelle).
  • templates
    Dieser Ordner erklärt sich auch fast alleine. Dort sind alle benötigten Templates für das Modul enthalten, die für die Ausgabe benötigt werden.

2 Gedanken zu “Contao Modul erstellen – Ordnerstruktur

  1. Pingback: Contao Module erstellen – Backend | Tobias Seckinger

  2. Hey Tobias

    Ich komme da nicht weiter.
    A: Ich möchte die List View abändern. Wie und vorallem wo kann ich die mal die List View überhaupt ändern? Da liest man überall von List View, aber wo konfigurieren steht weit und breit nichts.
    B: Möchte ich die List View mit den Arikeln anpassen und ein weiteres Symbol hinzufügen, also einen Marker, wenn bei den entsprechenden Artikeln eine Checkbox markiert ist. Wie kann ich das realisieren? Das kann doch nicht so schwierig sein.

    Besten Dank. Gruss

Kommentar verfassen