TYP03-Extensions entwickeln

Transkript

1 Dmitry Dulepov TYP03-Extensions entwickeln Der Entwicklerleitfaden für Extensions mitdertyp03-api YV ADDISOIM-WESLEY An imprint of Pearson Education München Boston San Francisco Harlow, England Don Mills, Ontario Sydney Mexico City Madrid Amsterdam

2 Der Autor 13 Der Fachgutachter 15 Vorwort 17 1 Über die TYPO3-API 21 l.i Überblick über die TYPO3-API PHP-Klassen und -Dateien t3lib_ tslib_ tx_ 24 ux user_ Datenspeicherung in TYPO Die allgemeine TYPO3-API Die Datenbank-API Extension-Verwaltung Helferfunktionen (t3lib_div) Sprachunterstützung Referenzindex Hooks Backend-API TCEforms TCEmain Frontend-API TSFE Inhaltsobjekte Die Plugin-API Zusammenfassung 50 2 Aufbau von TYPO3- Extensions Kategorien von ТУРОз-Extensions Frontend Frontend-Plugins Backend Backend-Module

3 2.1.5 Services Examples Templates Documentation Miscellaneous Dateien in Extensions Allgemeine Dateien Dateien für Frontend-Plugins Das Backend-Modul und seine Dateien Dateien für Modulfunktionen Dokumentationsdateien Zusammenfassung 73 3 Extensions planen Planung ist wichtig Wie wird geplant? Anforderungen sammeln Die Implementierung planen Die Dokumentation planen Planung für TYPO Extension Keys Die Datenbankstruktur Die Planung von Extensions Anforderungen Der Extension Key Frontend-Plugins Das Backend-Modul Weitere Klassen Die Datenbankstruktur der Extension Dokumentation Zusammenfassung 88 4 Extensions generieren Warum generieren? Die Generierung vorbereiten Die Schritte der Generierung Einen Extension Key eingeben Informationen über die Extension eingeben Sprachen einrichten 92

4 4.3.4 Neue Datenbanktabellen erstellen Vorhandene Tabellen erweitern Frontend-Plugins erstellen Backend-Module erstellen Integration in bestehende Module Kontextmenüeinträge hinzufügen Services erstellen Statischer TypoScript-Code TSConfig hinzufügen Die Extension generieren Extensions anpassen Aufräumen Felder ändern Tabellen verbergen Zusammenfassung Frontend-Plugins unter der Lupe Grundlagen von Frontend-Plugins Das Prinzip Plugin-Konfiguration Templates Lokalisierung Die Lokalisierung vorsehen Strings lokalisieren Lokalisierte Einträge abrufen Zeichensätze Caching Caching in TYPO Gecachte und nicht gecachte Ausgaben chash Zwei Dinge, die Sie vermeiden sollten Für Fortgeschrittene: USERJNT in USER einbetten Zusammenfassung Frontend-Plugins programmieren Generierte Dateien überprüfen und aktualisieren Dateien für das Frontend-Plugin Weitere verwandte Dateien Nicht überprüfte Dateien 136 9

5 6.2 Die Extension aufräumen Das Plugin programmieren Allgemeiner Arbeitsablauf Dateien hinzufügen Funktionen definieren Eine Extension initialisieren Die Flexform-Datenquelle ändern Aufrufe senden Templates verwenden Eine Einzelansicht erstellen Eine Listenansicht erstellen Eine Suchfunktion erstellen Hooks hinzufügen Was lässt sich optimieren? Zusammenfassung Backend-Module programmieren Ein Backend-Modul planen Funktionalität eines Backend-Moduls Frontend-Klassen Datenbankstrukturen Die Datenbank anpassen ext_tables.sql ext_tables.php tca.php Einen Frontend-Hook implementieren Grundlagen von Backend-Modulen Was ist ein Backend-Modul? Modulfunktionen Dateien des Backend-Moduls Die Backend-API Ein Backend-Modul implementieren Dateien und Klassen Ein Hinweis zu Backend-HTML Die Hauptklasse implementieren Die Liste der letzten Anmeldungen implementieren Die Monatsansicht implementieren

6 7.5.6 Eine Liste der aktiven Benutzer implementieren Seitenstatistiken implementieren Zusammenfassung Extensions abschließen Überblick Codedateien aktualisieren Den Code überprüfen Eleganterer Code mit extdeveval Skriptgesteuerte Dokumentation Einen Funktionsindex hinzufügen Den Code neu formatieren Dokumentation (Extension-Handbuch) schreiben Dokumentationsvorlagen Die Struktur der Vorlage Stile in der Vorlage Bilder in der Dokumentation Die Dokumentation schreiben Die Dokumentation verfügbar machen Extensions zum TER hochladen Zusammenfassung 221 Stichwortverzeichnis