Extensions mit TYPO3 TYPO3

Transkript

1 Extensions mit TYPO3 PHP-Einsatz in TYPO3 eine Einführung Tobias Hauser Arrabiata Solutions GmbH TYPO3 Aktuell ist Version 4.2 Version 4.3 ist RC, erscheint Ende November 4.4 wird es noch geben Dann kommt der große Sprung auf Version 5 1

2 PHP in TYPO3 iframes nicht weiter spannend PHP-Includes als Inhaltselement User-Functions Eigene Extensions Erweiterung bestehender Extensions Hooks XCLASS Eigene Extensions mit und ohne Datenbankfelder/-tabellen PHP-Includes PHP-Code wird als Inhaltselement angelegt Hierfür gibt es einige Erweiterungen: lumophpinclude localphpinclude mh_phpinclude 2

3 User Functions User Functions werden an verschiedenen Stellen eingesetzt Im Install-Tool In TypoScript Eigene Erweiterungen Um eigene Erweiterungen zu entwickeln, benötigen Sie das Grundgerüst Dafür eignet sich der Kickstarter Oder SIe adaptieren eine bestehende Extension Die Ausgabe erfolgt mit einer Klasse Typo3 besitzt eine eigene API mit Formularlementen, Backend und Datenbanksteuerung 3

4 Kickstarter Ist eine Extension mit dem Namen kickstarter Der Kickstarter wird über den Ext-Manager installiert Fügt im Ext-Manager dann Menüpunkt Create new Extension ein Erstellt das Grundgerüst für Extensions (nur den Anfang) Erlaubt keine späteren Änderungen sobald Sie an den Dateien der Extension etwas ändern, verwenden Sie nicht mehr den Kickstarter! Extension Key Jede Erweiterung hat einen eindeutigen Schlüssel Der Schlüssel sollte folgenden Kriterien genügen: Eindeutigkeit Keine Unterstriche Erlaubt sind prinzipiell die Buchstaben a-z und die Zahlen 0-9 Am Anfang kein u oder tx, da dies das automatische Präfix ist Länge zwischen 3 und 30 Zeichen 4

5 Extension Key + Upload Offiziell zu beantragen: Dafür ist ein Login von notwendig Upload kann direkt über den Ext-Manager erfolgen, wenn der Key registriert ist Lizenz: Key + Upload zu TER = GPL Namespaces TYPO3 verwendet intern Namespaces, um Dateien zuordnen zu können: t3lib für verschiedene Backend- und Frontend-Dateien vom System. typo3 für das Backend. tslib Teil der cms-extension für Frontend-Generierung tx_ - für Extensions. PHP-Klassen werden mit class.tx_ benannt. class.tx_namederextensionohneunterstriche_namederklasse.php user_ - nur für die aktuelle Installation vom Implementierer angelegt. Klassen oder Funktionen darin beginnen mit user_ ux_ - reserviert für XCLASS. 5

6 Dateien in Extensions Datei und/oder Verzeichnis ext_emconf.php ext_icon.gif Funktion Basis-Informationen zur Extension, wie Name, Kategorie, Abhängigkeiten und weitere. Programmtechnisch werden die Dateien in die Variable $EM_CONF[$_EXTKEY] eingelesen. Diese Datei ist zum Start der Extension dringend notwendig. Das Icon der Extension. GIF-Bild mit den Ausmaßen 18 x 16 px. Angezeigt wird das Icon beispielsweise im Extension Manager. ext_localconf.php Diese Datei ist die zentrale PHP-Steuerdatei der Extension. API-Aufrufe und Userfunktionen sind dort enthalten. Da der Inhalt der Datei (zusammengefasst mit derselben Datei der anderen Extensions) in typo3temp/ gecached wird, müssen Sie bei Änderungen den Cache löschen. Dateien in Extensions Datei und/oder Verzeichnis ext_tables.php locallang.xml locallang_db.xml pi1/ pi2/ pi1/static/ pi1/ce_wiz.gif pi1/class.tx_[$_extkey]_pi1.php pi1/class.tx_[$_extkey]_pi1_wizicon.php pi1/clear.gif Funktion Hier findet sich das TCA (Table Configuration Array). Ein Array mit dem Namen $TCA, das alle Meta-Informationen zu sämtlichen angelegten Tabellen, Feldern und deren Beziehung untereinander enthält. Die Sprach-Labels für die Extension selbst in einer XML-Struktur gespeichert. Die Sprach-Labels für die in der Extension benutzten Tabellen und Tabellenfelder in einer XML-Struktur gespeichert. In diesen Verzeichnissen befinden sich alle Dateien, die zu Ihren Frontend-Plugins gehören. In diesem Verzeichnis liegen statische TypoScript-Dateien, die Sie mittels Include static (im Template) einbinden können. Das 22 x 23 px große GIF-Icon wird im Wizard bei Neues Inhaltselement angezeigt. Die Hauptklasse des Plugins. Sie ist für die komplette Logik und Darstellung verantwortlich. Darstellung des ce_wiz.gif Icons. Die 1 x 1 px große transparente GIF-Datei wird zum Positionieren verwendet. 6

7 Dateien in Extensions Dateien und/oder Verzeichnisse pi1/locallang.xml mod1/ mod2/ mod1/clear.gif mod1/conf.php mod1/index.php mod1/locallang.xml mod1/locallang_mod.xml mod1/moduleicon.gif Funktion Hier werden die Sprach-Labels für das jeweilige Plugin in einer XML-Struktur gespeichert. Alle Dateien, die zu den Backend-Modulen gehören. Die 1 x 1 px große transparente GIF-Datei kommt zum Einsatz beim Positionieren. Die prinzipielle Modulkonfiguration. Ist obligatorisch. Die Konfiguration wird in den Variablen $MCONF und $MLANG gespeichert. Die Hauptklasse des Moduls und ist für die komplette Logik und Darstellung verantwortlich. Sprach-Labels, die nach dem Aufrufen des Moduls im Backend zum Einsatz kommen. Die Sprach-Labels für das Modul selbst. Ein 11 x 12 px großes GIF-Icon, das im Backend ganz links im Modulbereich angezeigt ist. Dateien in Extensions Datei und/oder Verzeichnis Funktion ext_tables.sql Die SQL-Struktur (also ganz normale SQL-Befehle), die nötig ist, um die Tabellen anzulegen, die in der Extension vorhanden sind. icon_tx_[$_extkey]_[$_tablename].gif tca.php Je Tabelle ist ein Icon vorhanden, das angezeigt wird, wenn ein neuer Datensatz über das List-Modul angelegt werden soll. Das TCA (das Array $TCA), das diese Datei beinhaltet, ist das Herzstück der Extension. Alle Meta-Daten aus dem Kickstarter. doc/ Enthält das Manual der Extension. 7

8 Konventionen - Datei Öffnender PHP-Tag Copyright-Hinweis Dateiinformationen (mit optionalem Funktionsindex) im phpdoc-format Include-Dateien Klasseninformationen im phpdoc-format PHP-Klasse XCLASS-Deklaration Optionaler Code zum Ausführen von Modulen Schließender PHP-Tag API in Plugins $GLOBALS['TSFE']->id Diese Variable enthält die ID der aktuellen Seite. $this->pi_getpagelink($globals['tsfe']->id) Dies erzeugt einen Link auf eine Seite als Parameter wird die ID einer Seite erwartet. $this->prefixid Diese Variable enthält einen String, der das Prefix der Extension enthält. $this->pivars['input_field'] Mit dieser Methode kann auf ein Formularfeld nach dem Absenden zugegriffen werden. 8

9 API in Plugins $this->pi_getll(string) Die Methode versucht, die aktuell gültige Übersetzung für string zu ermitteln. Ist die Sprache nicht vorhanden, wird die Standard-Sprache verwendet. Exemplarisch lässt sich sprachabhängige Beschriftung für einen Submit-Button mit dem Ausdruck $this- >pi_getll('submit_button_label') finden. $this->pi_linktopage($linkname,$seitenid) Hier wird ein komplettes Anchor-Tag mit der Beschriftung $linkname und dem Ziel $seitenid generiert. Übersetzungen Das Übersetzen von Strings in Extensions basiert auf XML-Dateien locallang.xml Extension mit Editor für Sprachdateien: lfeditor 9

10 Datenbanksteuerung Sie müssen grundlegend entscheiden, ob Sie bestehende Tabellen erweitern oder eigene anlegen Relationen werden über entsprechende Selector-Inhaltsfelder angelegt Typo3 erlaubt in den eigenen Abfragen keine JOINs Dafür verwenden Sie direkt SQL-Statements Hooks Ein Hook wird an beliebiger Stelle in einer Extension eingebaut Andere Extensions können den Hook dann nutzen 10

11 Hooks - Beispiel DerHook: function finishit($paymentobj = NULL) { [...] $hookobjectsarr = array(); if (is_array ($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['commerce/pi3/class.tx_commerce_pi3.php']['finishIt'])) { foreach ($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['commerce/pi3/class.tx_commerce_pi3.php']['finishIt'] as $classref) { $hookobjectsarr[] = &t3lib_div::getuserobj($classref); } } } Die Anbindung: $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['commerce/pi3/class.tx_commerce_pi3.php']['finishIt'][] = 'EXT:com_ordernumber/class.com_ordernumber_orderhooks.ph p:tx_com_ordernumber_orderhooks'; XCLASS Beispiel: if (defined('typo3_mode') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['ext/tipafriend/pi/class.tx_ti pafriend.php']) { include_once($typo3_conf_vars[typo3_mode]['xclass']['ext/tipafriend/pi/ class.tx_tipafriend.php']); } Einbindung dann in der ext_localconf.php der neuen Extension: $TYPO3_CONF_VARS['FE']['XCLASS']['ext/tipafriend/pi/class.tx_tipa friend.php'] = t3lib_extmgm::extpath($_extkey).'class.ux_tx_tipafriend.php' ; Methoden lassen sich dann überschreiben und Ergebnisse übergeordneter Methoden verwenden 11

12 FLOW3 mit 4.3 Erweiterung mit ExtBase FLUID als Template ähnlich wie Smarty Bei TYPO3 4.3 mit dabei Eine Beispielanwendung mit einem Blog ist ebenfalls mit dabei Tipp: Die Erweiterung efempty ist ein einfaches leeres Gerüst Dokumentation Dokuemntation: Sonstiges: Podcast zu FLUID und ExtBase: %E2%80%93-podcast/ 12

13 Vielen Dank! Ihre Fragen? Kontakt: Tobias Hauser +49 (89)