Ein Drop besteht im Grunde aus einer Sammlung von Dateien, die zusammengefasst eine Funktionalität erfüllen. Lese weiter um zu erfahren, welche Dateien ein Drop ausmachen, wie sie aufgebaut sind und wofür Sie verwendet werden können.
Struktur
Drops werden in ihrem eigenen Ordner unter
[Shop Root]/plugins/kk_dropper/drops
abgelegt. Der Ordername hat hierbei eine
entscheidene Rolle, denn er gibt die
ID des Drops
an. Das
Plain
Drop sollte auch immer unter dem Ordner
[Shop Root]/plugins/kk_dropper/drops/KK_Plain
auffindbar sein.
Namenskonvention von Drop IDs
Entwickelst du dein eigenes Drop, nutze bitte einen Präfix vor der ID deines Drops, z.B.
JTL_SampleDrop
oder
MY_SuperTabs. Entwickelst du das Drop speziell für einen Kunden, könntest du auch die Initialien des Kunden als Präfix verwenden, z.B.
CL_Banner. Präfixe sind wichtig, damit der Namen deines Drops nicht mit anderen Drops aus unserem Store kollidieren kann. Weiterhin gilt als Namenskonvention:
- Benutze die Upper Camelcase Notation für die ID deines Drops
- Keine Sonderzeichen, Umlaute oder Leerzeichen,
_ist jedoch erlaubt - Schreibe das Präfix in Großbuchstaben
ID vs Name deines Drops
Die ID deines Drops muss nicht dem Namen entsprechen, unter welchem das Drop im Backend auffindbar ist. Den menschenlesbaren Namen des Drops kannst du in später der
config.json
angeben.
Ordnerstruktur
In dem Ordner deines Drops müssen sich folgende Dateien befinden. Klicke auf den Dateinamen um eine weitere Dokumentation zu erhalten:
| Dateiname | Funktion |
|---|---|
| config.json | Bestimmt welche Optionen dein Drop im Backend zur Verfügung stellt und wie seine Datenstruktur aussieht. Wenn du schonmal ein JTL-Shop Plugin geschrieben hast kannst du die config.json mit der info.xml eines Plugins verlgeichen. |
| template.tpl | Das Smarty-Template deines Drops. Es ist für die Darstellung des Drops im Frontend verantwortlich. |
| drop.php | Erlaubt das Ausführen von PHP-Code pro Drop. (optional) |
| upgrade.js | Handling von Versions-Upgrades deines Drops. (optional) |
| *.css Dateien | CSS Stylesheets die eingebunden werden, falls das Drop auf der Seite dargestellt wird. (optional) |
| *.js Dateien | Javascript Dateien die eingebunden werden, falls das Drop auf der Seite dargestellt wird. (optional) |
Drop Builder
Der Drop Builder macht es dir leicht, ein passendes Grundgerüst für dein eigenes Drop vorzukonfigurieren.