Dateiaufbau
Beim Dateiaufbau von Plugins haben Sie relativ freie Hand. Es muss lediglich beachtet werden, dass die Installationsdatei im Ordner "/plugins/pluginname/installer/" liegt, sowie "pluginname.xml" heißen muss (genau wie das Pluginverzeichnis selbst).
Beim Plugin "my_plugin" erwartet der Shop also die Installationsdatei my_plugin.xml im Verzeichnis "/plugins/my_plugin/installer/my_plugin.xml".
Im Ordner "/image/" ( "/plugins/pluginname/images/" ) sucht der Shop die Bilddatei, welche innerhalb der Installations-Datei (in "<icon>xt-commerce_logo.jpg</icon>" ) angegeben wurde. Dieses Bild wird im Backend des Shops in der Liste der deinstallierten Plugins angezeigt.
Im Ordner "/pages/" ( "/plugins/my_plugin/pages/" ) sucht der Shop nach den php-Dateien von Seiten ("Pages")
Im Ordner "/boxes/" ( "/plugins/my_plugin/boxes/" ) sucht der Shop nach den php-Dateien von Boxen ("Boxen")
Theoretisch müssen die Namen der weiteren Ordner keinen bestimmten Vorgaben folgen, jedoch empfehlen wir folgende Namen:
Der Aufbau für ein Plugin ist wie folgt und sollte auch eingehalten werden.
Verzeichnis | Inhalt |
---|---|
/classes/ | Hier sollten die Klassen des Plugins abgelegt werden |
/hooks/ | Hier sollten die includes der Hookpunkte ( Hookpunkte auslagern in Dateien ) abgelegt werden, sofern diese Technik verwendet wird. |
/images/ | Bilder und Icons |
/css/ | Hier sollten die Stylesheet abgelegt werden. |
/javascript/ | Hier sollten die Javascript-Dateien abgelegt werden. |
/callback/ | class.callback.php (für Payment Plugin mit IPN) |
/installer/ | Installations-xml-Datei |
/templates/ | Hier sollten die Templatedateien abgelegt werden. |
/templates/boxes | Hier sollten die Templatedateien von Boxen abgelegt werden. |
Für ein funktionierendes Plugin reicht jedoch schon das installer/ Verzeichnis mit der xml-Datei.