Version vom 21. Juni 2014, 21:06 Uhr

Unvollständiger Artikel: dieser Artikel ist noch nicht sauber bearbeitet. Bitte erweitere ihn und entferne erst anschliessend diesen Hinweis.

Grundlagen

Hinweis: In Composer redet man von Paketen, nicht von Erweiterungen - weil ein Composer Paket nicht an ein CMS / System gebunden ist. Aber ein Composer Paket kann auch eine Contao Erweiterung sein.

Die composer.json

Die composer.json ist die zentrale Konfigurationsdatei für Composer. In dieser werden Name, Beschreibung, Typ, Lizenz, Author, und viel mehr hinterlegt. Eine vollständige Schema-Beschreibung kann man auf der Composer Website finden. An dieser Stelle werden erst ein mal nur auf die wichtigsten Einträge erörtert.

Hinweis: Mit Repository ist das git/svn/hg Repository gemeint.

Die composer.json muss auf der obersten ebene im Repository hinterlegt werden. Die die Dateiendung bereits verrät, handelt es sich dabei um eine JSON Datei.

Fangen wir mal mit den Basics an:

{
    "name": "me/my-extension",
    "description": "A very usefull extension.",
    "keywords": ["contao", "extension", "usability"],
    "type": "contao-module",
    "homepage": "http://my-homepage.me/my-extension",
    "license": "LGPL-3.0+"
}

Mit name wird der Name des Pakets festgelegt. Hierbei ist zu beachten, dass sich der Name aus 2 Teilen zusammen setzt: <vendor>/<name>. <vendor> ist der Name des Entwicklers, es empfiehlt sich den Personen/Organisations-Namen den man auf github verwendet zu benutzen. <name> ist der Name des Pakets, es empfiehlt sich den Namen des Repositories auf github zu verwenden.

Hinweis: Der Paketname wird normalisiert. Es sind ausschließlich kleine Buchstaben, Zahlen, Unterstriche und Bindestriche erlaubt! Gut: my-name/my-extension-name Schlecht: my_name/my_extension_name Ungültig: MyName/MyExtensionName

Beispiele

Repository mit TL_ROOT

Repository mit system/modules/my_extension

Repository das bei system/modules/my_extension startet

Neue Struktur