TYPO3 und TypoScript Kochbuch

35 Extensions erstellen und programmieren (S. 605-606)

Extensions sind im Grunde die Schatztruhe von TYPO3. Durch die schier unendlichen Möglichkeiten, die sich einem dort auftun, wird Ihnen der Weg geebnet, nahezu jeden Teilbereich des TYPO3-Systems an Ihre Bedürfnisse anzupassen.

Die tägliche Arbeit an Projekten zeigt, dass man zwar mit den standardmäßig von TYPO3 zur Verfügung gestellten Funktionen gut zurechtkommt und auch die bestehenden Extensions fast jeden Anwendungsfall abzudecken scheinen. Aber eben nur fast. Es besteht oft der Bedarf an individueller Anpassung, um entweder kleinere Funktionalitäten nachzurüsten oder auch komplexe Vorgänge zu realisieren.

Wenn Sie nun Ihre Anpassungen in Extension auslagern, sichern Sie sich zudem die Möglichkeit, Ihr TYPO3-Grundsystem (Core) beliebig updaten zu können. Außerdem lassen sich Ihre Extensions projektübergreifend immer wieder einsetzen.

Von Vorteil ist, dass Sie Ihre Extension anderen zur Verfügung stellen und damit öffentlich machen können, indem Sie diese in das TYPO3 Extension Repository (TER) laden. Generelles Unterscheidungsmerkmal jeder Extension ist der Name, der so genannte Extension Key, er wird jeweils nur ein einziges Mal vergeben.

Erläuterung

Da es wenig Sinn macht, dieses Kapitel zu allgemein zu halten, wollen wir in den folgenden Rezepten eine konkrete Extension aufbauen.

Der Name der Extension ist references2go und sie dient dazu, Referenzen (also Arbeitsproben, beispielsweise von Webdesignern) zu verwalten. Dafür sollen Firmen aufgenommen werden, denen wir konkrete Projekte zuordnen und diesen wiederum die Tätigkeiten. Schließlich beobachten wir auch, „wie viel" dieser Tätigkeit selbst umgesetzt wurde, das heißt, man beziffert beispielsweise die Tätigkeit Design mit einem Anteil von 50%. Als Ergebnis soll eine Matrix entstehen, die die Firmen und Projekte vertikal sowie die Tätigkeiten und deren Anteil horizontal auflistet.

R35.1 Extension Key festlegen
Aufgabe

Sie wollen eine eigene Extension entwickeln und benötigen hierfür einen möglichst sinnvollen Namen – den so genannten Extension Key.

Lösung

Jeder der momentan über 2000 öffentlichen Extensions wird über ihren Namen, den Extension Key, identifiziert.

Der Extension Key ist ein String, der Ihre Extension weltweit einzigartig und damit erkennbar macht. Die Einzigartigkeit liegt darin, dass Ihre Module, Plugins, PHP-Klassen, Datenbanktabellen und -felder mit einem Präfix benannt werden, den kein anderer benutzt. Dadurch garantiert der Extension Key globale Übertragbarkeit und Kompatibilität. Um dies sicherzustellen, muss der Extension Key registriert werden, was kostenfrei möglich ist und von der TYPO3-Community auch begrüßt wird. Mehr über die Registrierung erfahren Sie in Kapitel R35.2 Extension Key registrieren.

Für den Namen des Extension Keys gelten einige Richtlinien:

Verwenden Sie genügend Zeit zur sinnvollen Namensfindung. Ist der Name nämlich erst einmal gewählt, lässt er sich nicht mehr bzw. nur extrem aufwändig ändern. Achten Sie darauf, dass Ihr gewählter Name einzigartig ist. Selbst wenn Sie Ihre Extension nicht für die Öffentlichkeit bereitstellen und ins TER laden, kann es spätestens dann zu Konflikten kommen, wenn jemand eine gleichlautende Extension ins TER lädt und Sie diese benutzen wollen bzw. müssen. Im nächsten Kapitel zeigen wir Ihnen, wie Sie online im TER nachsehen, ob ein Extension Key bereits existiert.

Der Name darf nicht mit „u" oder „tx" anfangen, da diese Suffixe automatisch an die Klassennamen angehängt werden. Sollten Sie Ihre Extension lediglich lokal verwenden, gilt diese Einschränkung nicht, wenn Sie Ihre Extension mit user_ beginnen lassen. Erlaubt sind prinzipiell die Buchstaben a-z und die Zahlen 0-9.

Obwohl der Unterstrich erlaubt ist, sollten Sie möglichst auf ihn verzichten. Dies ist darauf zurückzuführen, dass der Unterstrich vom Kickstarter bei der Erstellung der Extension meist ohnehin getilgt wird. So sind beispielsweise das automatisch angelegte Verzeichnis, aber auch CSS, Datenbanktabellen und TypoScript ohne den Unterstrich angelegt.