Eine Extension mit dem Kickstarter erstellen - pro:med Pflege

Typo3-Dokumentation
Eine Extension mit dem Kickstarter erstellen
Ziel
Erstellung einer Extension zur Darstellung und Bearbeitung tabellarischer Daten (Mitarbeiter-
Verzeichnis, CD-Sammlung, ...), hier am Beispiel Mitarbeiter-Verzeichnis.
Die Daten werden im Backend eingegeben und mit einem Frontend-Plugin ausgegeben.
Die Extension soll nur einsprachig verwendet werden.
Voraussetzung
Notwendige Extension: Extension Repository Kickstarter
Kickstarter aufrufen
Im Modul Extension Manager im Pulldown-Menü Make new extension auswählen.

Extension-Schlüssel eingeben
TYPO3 – Extensionerstellung – 2 –
Einen eindeutigen Schlüssel für die Extension vergeben. Der Schlüssel ist nachträglich nur
schwer zu ändern!
Soll die Extension in anderen Sites verwendet oder später im Repository veröffentlicht
werden, einen weltweit eindeutigen Schlüssel wählen (Namensbestandteil wählen, Schlüssel
ggf. im Extension-Repository auf Typo3.org registrieren lassen).

Generelle Daten der Extension festlegen
TYPO3 – Extensionerstellung – 3 –
Im Kickstarter Wizard mit Klick auf das + hinter General Info die Felder für die generellen
Informationen zur Extension aufrufen.
Tabelle anlegen und erstes Feld eingeben
Im Kickstart-Wizard mit Klick auf das + in New Database Tables eine neue Tabelle
anlegen.
Einen Tabellennamen eingeben, z. B. personen. Der Tabellenname wird automatisch ergänzt,
indem die Zeichenfolge tx_extensionkey davor gesetzt wird, in diesem Beispiel also die
Zeichenfolge tx_tkmitarbeiter. Die Unterstrichzeichen im Extension key werden
automatisch entfernt.
Damit die Tabelle auf normalen Seiten im Backend bearbeitet werden kann, müssen die
beiden folgenden Felder aktiviert sein:
Allowed on pages
Allowed in 'Insert Records' field in content elements
Es kann das erste Feld der Tabelle angelegt werden. Es wird der Name des Feldes für die
Datenbank angegeben. Der festzulegende Titel erscheint im Backend für die Bearbeitung der
Tabelle und sollte „sprechend“ sein.
Es muss der Typ des Feldes festgelegt werden. Für Namen wird üblicherweise String input
verwendet.Mit update wird die Eingabe abgeschlossen.

TYPO3 – Extensionerstellung – 4 –

Weitere Felder hinzufügen
TYPO3 – Extensionerstellung – 5 –
Nach jedem Update in der Tabelle-Eingabe kann ein weiteres Feld hinzugefügt werden.
Plugin einrichten
Für die Ausgabe der Daten mit einem Frontend-Plugin muss ein solches in der Extension
eingerichtet werden.
Klick auf + hinter Frontend Plugins öffnet den Plugin-Wizard.
Es muss ein Name für das Plugin vergeben werden, hier: Mitarbeiter-Verzeichnis. Das
Plugin soll im Pulldown-Menü für Content-Elemente erscheinen, daher wird der vorbesetzte
Wert Add to 'Insert Plugin' list in Content Elements in der Radio-Button-Liste
beibehalten.
Unter
If you have configured custom tables you can select one of the tables to
list by default as an example:
ist im Pulldown-Menü die neu angelegte Tabelle tx_tkmitarbeiter_personen
auszuwählen.

TYPO3 – Extensionerstellung – 6 –

Extension sichern und installieren
TYPO3 – Extensionerstellung – 7 –
Sind alle Eingaben für die Extension durchgeführt, kann die Extension endgültig gesichert
und installiert werden.
Klick auf view result zeigt die Ergebnisse der bisherigen Extension-Entwicklung. Alle für
die Extension in der aktuellen Fassung notwendigen Dateien ext_localconf.php
ext_tables.php locallang_db.php class.tx_tkmitarbeiter_pi1.php, … werden
angezeigt.
Mit Klick auf write werden die Dateien in das Dateiverzeichnis geschrieben.
Es handelt sich um eine lokale Extension. Alle vom Kickstarter für diese Extension erzeugten
Dateien liegen dann im Verzeichnis ../typo3conf/ext/tk_mitarbeiter

TYPO3 – Extensionerstellung – 8 –
Nach Klick auf write kann die Extension endgültig installiert werden:
Mit Klick auf Install extension folgt die Aufforderung, die notwendigen Tabellen in die
Datenbank einzutragen:

TYPO3 – Extensionerstellung – 9 –
Die Extension ist anschließend verfügbar und wird im Extension-Modul unter Loaded-
Extensions angezeigt:

Ausgabe im Frontend
Frontend-Plugin der Extension in der Seite aufrufen
TYPO3 – Extensionerstellung – 10 –
Auf einer Seite ein Content-Element einfügen, z. B. ein Text-Element. Das Pulldown-Menü
für den Typ aufklappen und insert plugin auwählen.
Das Pulldown-Menü im Feld Plugin aufklappen und als Plugin Mitarbeiter-Verzeichnis
auswählen.
Die Seite speichern und im Frontend anzeigen. Das Plugin sollte dann folgende Ausgabe
liefern:

Daten im Backend eingeben
TYPO3 – Extensionerstellung – 11 –
Um Daten im Backend eingeben zu können, wird im List-Modul die Seite ausgewählt, auf der
das Plugin der Extension als Content-Element eingesetzt ist.
Die Extension ist derzeit so programmiert, dass mit dem Frontend-Plugin die Datensätze der
Mitarbeiter-Tabelle angezeigt werden, die auf der Seite gespeichert sind, auf der das
Frontend-Plugin eingebunden ist.
Mit Klick auf Create new record wird ein neuer Datensatz angelegt. Im List-Modul stehen
verschiedene Datensätze zur Auswahl (je nach installierten Extensions).
Im Beispiel der Mitarbeiter-Extension sollen Datensätze für Personen angelegt werden
(Personen ist der Tabellen-Name, der beim Anlegen der Extension vergeben wurde, siehe
Tabelle anlegen und erstes Feld eingeben).

TYPO3 – Extensionerstellung – 12 –
Mit Klick auf Personen können neue Personen-Datensätze eingegeben werden:
Nachdem mehrere Personen-Datensätze eingegeben wurden, erscheinen diese als Liste im
Backend:

Hinweis:
TYPO3 – Extensionerstellung – 13 –
Die Extension ist derzeit noch so programmiert, dass standardmäßig die uid der Personen-
Datensätze in der Liste angezeigt wird. Soll die Liste etwas leichter lesbar werden, können
z. B. die Felder Name und Vorname zusätzlich in der Liste aufgeklappt werden: Klick auf das
+-Zeichen in der Überschriftenzeile hinter „Personen“. In der dann erscheinenden Liste die
Auswahl der anzuzeigenden Felder treffen (z. B. Name und Vorname) und diese dann mit Set
fields in der Liste anzeigen lassen.
Im Frontend werden jetzt die Namen aus der Tabelle Personen aufgeführt.
Die Ausgabe, d.h. die Links Mode1, Mode2, .., die tabellarische Darstellung der Daten und das
Suchfeld, erfolgt durch php-Funktionen in der Extension-Datei:
typo3conf\ext\tk_mitarbeiter\pi1\class.tx_tkmitarbeiter_pi1.php

Extension bearbeiten
TYPO3 – Extensionerstellung – 14 –
Die Bearbeitung von Extensions kann je nach Ziel der Bearbeitung mit unterschiedlichen
Verfahren erfolgen:
1. Ergänzung einer bestehenden Extension im Kickstarter
Hiermit kann eine vorhandene Extension um Tabellen, Tabellenfelder und
Funktionalitäten wie Plugins, Clickmenues, Tags, etc. ergänzt werden.
Tabellennamen und Typen können geändert werden.
Der Extension-Key bleibt bei der Ergänzung erhalten.
2. Bearbeitung der Abläufe in den php-Dateien, z. B. um die Ausgabe des Plugins zu
ändern.
Hierzu ist die Bearbeitung der entsprechenden php-Dateien der Extension notwendig,
d. h. Programmierung.
3. Ergänzung einer bestehenden Extension durch Bearbeitung der Extension-
Konfigurationsdateien „von Hand“ im Editor
Dieses Verfahren erfordert entsprechende Erfahrung im Umgang mit Extension-
Konfigurationsdateien.
Ergänzung einer Extension mit Kickstarter
� Warnung und Hinweis:
Im Folgenden wird beschrieben, wie mit dem Kickstarter eine bestehende Extension ergänzt
wird. Dabei wird aufbauend auf dem Gerüst einer vorhandenen Extension eine neue
Extension erstellt.
Alle in der vorhandenen Extension nicht vom Kickstarter durchgeführten Einträge,
Änderungen und Programmierarbeiten in den class_tx_extension_pi1.php-Dateien gehen
verloren!
Die vorhandene Extension sollte vorher gesichert werden, z. B. indem das gesamte Extension-
Verzeichnis typo3conf/ext/ext_key kopiert wird.
Ergänzung der Extension
Die vorhandene Extension Mitarbeiter-Verzeichnis soll um weitere Tabellenfelder
ergänzt werden:
Den Ext. Manager aufrufen und im Pulldown-Menü Loaded extensions auswählen, und
anschließend durch Klick die zu bearbeitende Extension laden, in diesem Fall also
Mitarbeiter-Verzeichnis.

Es erscheint eine Seite mit Informationen zu der Extension:
Im Pulldown-Menü das Feld Backup/Delete auswählen.
TYPO3 – Extensionerstellung – 15 –

TYPO3 – Extensionerstellung – 16 –
Mit Klick auf Start new wird eine neue Extension auf dem Gerüst der bereits vorhandenen
Extension Mitarbeiter-Verzeichnis aufgebaut.
� Alle in der vorhandenen Extension nicht vom Kickstarter durchgeführten Einträge,
Änderungen und Programmierarbeiten in den class_tx_extension_pi1.php-Dateien
gehen verloren!

TYPO3 – Extensionerstellung – 17 –
Mit Klick auf den Tabellennamen Personen erscheint die Tabelle im Wizard und kann
bearbeitet werden. Es können neue Felder eingetragen werden, Typen bestehender Felder
geändert werden etc.

TYPO3 – Extensionerstellung – 18 –
Es wird noch das Feld telefon in die Tabelle Personen eingefügt:
Nach Klick auf update kann die Extension mit view und write in der aktuellen Version
geschrieben werden. Nach write erfolgt noch ein Hinweis auf die ergänzten Tabellenfelder:

TYPO3 – Extensionerstellung – 19 –
Mit Make updates wird die aktuelle Extension-Version dann installiert.
Tabellenwert statt uid in Backend-Datenliste
Im Backend wurde in der Liste für die Personen-Datensätze die uid angezeigt (siehe Daten im
Backend eingeben). Diese wenig sprechende Kennzeichnung von Datensätzen kann durch ein
Wert aus dem Daten (Tabellenwert) ersetzt werden. Im vorliegen Beispiel soll statt der uid der
Name der Person im Backend erscheinen.
Im Kickstarter wird dazu die Tabelle Personen ausgewählt. Im Pulldown für das Feld Labelfield
wird das Feld ausgewählt, das statt der uid als Label im Backend verwendet werden
soll.

Zweite Tabelle und Verknüpfung
TYPO3 – Extensionerstellung – 20 –
Die Extension soll um eine weitere Tabelle ergänzt werden, zwischen den Tabellen soll eine
Verknüpfung erstellt werden.
Im vorliegenden Fall soll es im Mitarbeiter-Verzeichnis eine weitere Tabelle
Arbeitsbereich geben. Jeder Arbeitsbereich hat eine Abkürzung und eine Beschreibung und
eine eigene Homepage. Jeder Mitarbeit kann in mehreren Arbeitsbereichen tätig sein.
Im Kickstarter Wizard wird zunächst eine neue Tabelle angelegt (Klick auf New Database
Table) und die Tabelle mit einer Bezeichnung und einem Titel versehen:

TYPO3 – Extensionerstellung – 21 –
Es werden die drei benötigten Felder angelegt: kennung für die Abkürzung als Typ String
Input, beschreibung als Typ Text Area, und homepage als Typ Link.

Die Tabelle Arbeitsbereich wird mit update gesichert.
TYPO3 – Extensionerstellung – 22 –
Es soll nun die Verknüpfung erstellt werden, mit der jeder Mitarbeiter mehreren
Arbeitsbereichen angehören kann. Dazu wird die Tabelle Personen angeklickt und ein neues
Feld arbeitsbereich mit dem Typ Database relation angelegt.
Nach update kann die Verknüpfung für das Feld arbeitsbereich spezifiziert werden:

TYPO3 – Extensionerstellung – 23 –
Im Pulldown-Menü Create relation table wird die Tabelle ausgewählt, mit der eine
Verknüpfung erstellt werden soll. Im Beispiel ist dies die Tabelle
tx_tkmitarbeiter_Arbeitsbereich.
Als Typ der Verknüpfung wird Selectorbox, select global ausgewählt.
Es sollen maximal 4 Verknüpfungen zulässig sein, d. h. eine Person kann zu maximl vier
Arbeitsbereichen gehören. Die Zahl ist frei wählbar, und hängt von der Anwendung ab.
Die Größe der Selectorbox wird auf 8 Felder festgelegt.
Die Auswahl der Felder Add Add Record, Add List Record, Add Edit Record ermöglicht
es im Backend, die Datensätze für die Arbeitsbereiche direkt von der Eingabemöglichkeit der
Personen-Datensätze zu erreichen.
Die Extension kann nun mit view und write in der aktuellen Version geschrieben werden.
Nach write werden die neu angelegten Tabellen und Tabellenfelder angezeigt:

Mit Make updates wird die Extension installiert.
TYPO3 – Extensionerstellung – 24 –
Wird mit der aktualisierten Extension die Seite mit dem Extension-Plugin im Frontend
aufgerufen, werden jetzt zusätzlich die Felder „Arbeitsbereich“ und „Telefon“ aufgeführt
(ggf. ist Cache zu löschen, um die neue Anzeige zu erhalten):
Wird die Seite mit dem Extension-Plugin im List-Modul aufgerufen, ergibt sich folgende
Darstellung:

TYPO3 – Extensionerstellung – 25 –
In der Liste der Personen-Datensätze erscheint jetzt der Name (siehe Tabellenwert statt uid in
Backend-Datenliste).
Wird ein Personen-Datensatz bearbeitet (Klick auf Stift-Symbol), werden vorhandene Felder
angezeigt:
Es gibt noch keine Arbeitsbereiche, denen Frau Mustermann zugeordnet werden kann.
Um Arbeitsbereiche anzulegen, kann auf das +-Zeichen in der Items-Liste der Arbeitsbereiche
geklickt werden.

TYPO3 – Extensionerstellung – 26 –
Im Beispiel wird der Arbeitsbereich mit der Kennung forschung angelegt, die Homepage
befindet sich innerhalb der aktuellen Site mit der Seiten-ID 8.
Datensätze für die Arbeitsbereich können auch, wie im Kapitel „Daten im Backend eingeben“
beschrieben, bearbeitet werden.
Liegen mehrere Datensätze für die Arbeitsbereiche vor, können diese einer Person zugeordnet
werden. Im folgenden Beispiel gehört Hans im Glück zu drei Arbeitsbereichen:
Damit die Arbeitsbereiche, wie in der obigen Abbildung dargestellt, mit ihrer
Kurzbezeichnung in der Selectorbox erscheinen, muss in der Tabelle für Arbeitsbereiche das
Label-Feld mit dem Feld kennung gesetzt sein (siehe Tabellenwert statt uid in Backend-
Datenliste). Ggf. muss die Extension nochmals im Kickstarter mit
Backup/Delete Start new aufgerufen werden. Das Label-Feld für die Tabelle kann dann
wie im Kapitel „Tabellenwert statt uid in Backend-Datenliste“ beschrieben, gesetzt werden.
Sind alle Personen-Datensätze geändert, ergibt sich im Frontend z.B. folgendes Bild:

TYPO3 – Extensionerstellung – 27 –