Inhalt. Teil I Klassische Extensionprogrammierung

Transkript

1 Teil I Klassische Extensionprogrammierung 1 Grundlagen Aufbau und Struktur von TYPO Aufbau einer Extension Arten und Einteilung von Extensions Der Extension-Key TYPO3 Coding Guidelines Namespace PHP-Regeln Dateistruktur PHP-Syntax phpdoc Changelog Eine Extension planen und entwickeln Extensions planen Wir planen eine Blog-Extension Der Kickstarter Die Datenbank Datenbanktabellen und Formulare eine Erklärung Extend existing Tables Frontend-Plug-ins Backend-Module Integrate in existing Modules Clickmenu items Services Static TypoScript code...43 V

2 TSconfig Die Extension erstellen Extension-Konfiguration mit ext_emconf.php Die weiteren Dateien der Extension Verzeichnis doc Verzeichnis mod# Verzeichnis modfunc# Verzeichnis pi# Verzeichnis Static Datei Changelog Datei README.txt Datei ext_icon.gif Datei ext_localconf.php Datei ext_tables.php Datei ext_tables.sql Datei ext_tables_static+adt.sql Dateien Icon_tx_extkey_tabellenname.gif Datei locallang.xml Datei locallang_db.xml Datei tca.php Backend-Module erstellen Module konfigurieren und im Hauptmenü anordnen Einen eigenen Navigationsbaum erstellen Backend-Modul erstellen Das Modul initialisieren Den Modulinhalt aufbauen Extension-Konfiguration über ext_conf_template.txt Backend-Formulare aufrufen Eine Datensatzliste mit Bearbeitungsfunktionen erstellen Aufgabe: Module für Kommentare, Blog und Blogroll Backend User Object $BE_USER Das Systemlog Frontend-Plug-ins Das Frontend-Plug-in im Überblick Feldinhalte für die Ausgabe aufbereiten Das Bild für Teaser Image Ausgabe des Haupttextes in der Listenansicht, wenn erwünscht Haupttext mit RTE formatieren Haupttext statt Teasertext anzeigen, falls dieser nicht verfügbar ist Verlinken des Autorennamens mit der Mail-Adresse des Autors Kategorien als Namen anzeigen und verlinken (Relationen) HTML-Templates für das Plug-in Die Kommentarfunktion mit AJAX und eid Ausgabe vorhandener Kommentare VI

3 4.4.2 Das Kommentarformular hinzufügen Was sind Hooks? Flexforms Erzeugen der Flexform Das Plug-in pi Dokumentation und Abschluß Code dokumentieren mit extdeveval Extension-Dokumentation schreiben Die Vorlage Der Aufbau der Dokumentation Vorlagenstile Die Dokumentation verfassen Upload ins TER Teil II Funktionsreferenz zur klassischen Extensionprogrammierung 6 Datenbank $GLOBALS['TYPO3_DB'] exec_selectquery exec_select_queryarray exec_selectgetrows exec_select_mm_query exec_insertquery exec_updatequery exec_deletequery sql_fetch_assoc sql_fetch_row searchquery listquery splitgrouporderlimit quotestr fullquotestr fullquotearray escapestrforlike cleanintarray cleanintlist debug_lastbuiltquery tslib_pibase pi_exec_query pi_getpidlist pi_getrecord pi_prependfieldswithtable VII

4 6.3 cobj DBgetDelete DBgetInsert DBgetUpdate enablefields Dateisystem t3lib_div dirname fixwindowsfilepath formatsize get_dirs getallfilesandfoldersinpath getfileabsfilename getfilesindir geturl isabspath isallowedabspath mkdir mkdir_deep removeprefixpathfromlist resolvebackpath rmdir split_fileref tempnam unlink_tempfile upload_copy_move upload_to_tempfile verifyfilenameagainstdenypattern writefile writefiletotypo3tempdir Strings, Arrays und Umgebungsvariablen Allgemeine Funktionen _GET _GETset _GP _POST calluserfunction clientinfo compat_version compileselectedgetvarsfromarray gethostname getindpenv getthisurl linkthisscript VIII

5 linkthisurl locationheaderurl makeinstance makeinstanceservice rmfromlist syslog String-Funktionen calcparenthesis cmpfqdn cmpip convumlauts csvvalues dehscentities expandlist fixed_lgd fixed_lgd_pre formatfortextarea generaterandombytes get_tag_attributes htmlspecialchars_decode implodearrayforurl implodeattributes inlist int_from_ver intinrange intval_positive isfirstpartofstr md5int milliseconds modifyhtmlcolor modifyhtmlcolorall normalizeipv removexss revexplode rm_endcomma shortmd split_tag_attributes splitcalc strtolower strtoupper substurlsinplaintext testint trimexplode uniquelist valid validip IX

6 validipv validipv Array-Funktionen addslashesonarray array_merge array_merge_recursive_overrule array2json array2xml arraytologstring explodeurl2array inarray print_array removearrayentrybyvalue slasharray view_array xml2array xml2tree xmlgetheaderattribs String-Funktionen in Frontend-Plug-ins calcage check codestring encrypt HTMLcaseshift keywords linebreaks processparams uniquehash URLqMark Bilder Einbinden Bearbeiten Bild umrechnen (fürs Web optimieren) Abmessungen ändern Zuschneiden Graustufen Erzeugen Bild in bestehendes Bild einfügen Text erzeugen AJAX im Frontend eid Konfiguration Basisdatei X

7 10.2 Zusammenspiel AJAX & eid Aufbau der XML-Response AJAX-Request und Verarbeitung Frontend-Plug-ins Cache cacheexpires clearpagecachecontent clearpagecachecontent_pidlist get_cache_timeout set_cache_timeout_default set_no_cache Content-Elemente cimage cleanformname cobjget cobjgetsingle currentpageurl fileresource getimgresource getslidepids gifbuildertextbox stdwrap Links baseurlwrap getmailto gettypolink gettypolink_url http_makelinks imagelinkwrap mailto_makelinks pi_getpagelink pi_linktopage pi_linktp pi_linktp_keeppivars pi_linktp_keeppivars_url pi_openataghrefinjswindow prefixlocalanchorswithscript Listen pi_list_browseresults pi_list_linksingle pi_list_makelist pi_list_modeselector pi_list_searchbox XI

8 11.5 JavaScript additionalheaderdata additionaljavascript JSeventFuncCalls minifyjavascript quotejsvalue rawurlencodejs setjs wrapjs CSS additionalcss additionalheaderdata pi_getclassname pi_setclassstyle setcss Mehrsprachigkeit getlll pi_getll readllfile Umgebungsvariablen und allgemeine Funktionen absrefprefix additionalheaderdata all anchorprefix applicationdata ATagParams baseurl baseurlwrap beuserlogin clientinfo content defaultbodytag domainstartpage exttarget fepreview id imagesonpage inttarget lang lastimageinfo loginuser no_cache page printerror rootline sitescript XII

9 tmpl->config, tmpl->setup type TYPO3_CONF_VARS uniquestring Konfiguration mit Flexforms Erstellen einer Plug-in_Flexform Auslesen der Formulardaten Konfiguration mit TypoScript Konfiguration im Extension-Manager Frontend-User & Sessions Frontend-User Daten des aktuell angemeldeten Users Sessions Daten speichern Daten auslesen Warenkorb aufbauen Backend & Services Eigene Flexforms Mehrsprachigkeit Tabs Elemente Flexform-Daten im Frontend Backend-Module Dokumententypen für $this->doc TypoScript einer Seite auslesen AJAX im Backend Services cli Debugging debug debug_ordvalue debug_trail debugrows devlog Teil III Extbase und Fluid 14 Der neue Weg der Extension-Programmierung Grundlagen der objektorientierten Programmierung Klassen und Objekte Vererbung von Klassen XIII

10 Kontrollierte Vererbung abstrakte und finale Klassen Sichtbarkeiten: public, private und protected Interfaces Type Hints Statische Methoden und Eigenschaften Namespaces Neue Konzepte Domain Driven Design Model-View-Controller Modellierung Gemeinsamens Vokabular Ubiquitous Language Die Elemente des Modells Ein Rundgang durchs System Installation von Extbase und Fluid Installation der Extension blog_example Datenstruktur im Blog-Example Namenskonventionen Verzeichnis- und Dateinamen Klassennamen Controller und Actions Die Dateistruktur im Extension-Root-Verzeichnis Die Datei ext_emconf.php Die Datei ext_tables.php Die Datei ext_localconf.php Die Dateien ext_tables.sql und ext_icon.gif Die Verzeichnisstruktur Das Verzeichnis Classes Das Verzeichnis Configuration Das Verzeichnis Module Das Verzeichnis Resources Weitere Verzeichnisse Der prinzipielle Ablauf Aufruf des Dispatchers (Schritt 1) Aufruf des Controllers (Schritt 2) Ansprechen des Respositorys (Schritt 3) Zurückliefern der Blog-Objekte (Schritt 4) Das Objekt wird dem View zugeordnet (Schritt 5) Rückgabe der Template-Ausgabe an den Controller (Schritt 6) Rückgabe der Ausgabe an den Dispatcher (Schritt 7) Rückgabe der Ausgabe an TYPO3 (Schritt 8) Entwicklung eines eigenen Plug-ins Aufbau einer minimal funktionstüchtigen Extension Extension-Key Verzeichnisse anlegen XIV

11 Die Datei ext_emconf.php Die Dateien ext_localconf.php und ext_tables.php Einrichten eines Standard-Controllers Installieren der Extension und das erste Erfolgserlebnis Hinzufügen eines Views Entitäten einführen Daten persistieren (Datenspeicher) Datenbankstruktur die Datei ext_tables.sql Datenbankstruktur das TCA Anlegen eines Repositorys Anlegen einer neuen Action Anlegen der Action addaction() Daten per Formular eingeben und auswerten Objekte aus dem Repository entfernen Zufügen der Action delete in der Konfiguration Anpassen der Template-Datei index.html Update von Objekten Edit- und Update-Action hinzufügen Der Query-Manager Eingabevalidierung Validatoren Vordefinierte Validatoren Eigene Validatoren Ausgabe der Fehler Optionale Argumente Relationen zu anderen Tabellen Erweiterung des TCA Die Domain-Klasse Tx_Simpleblog_Domain_Model_Post Registrieren der Actions in der Datei ext_localconf.php Erstellung des Post-Controllers Neue Templates und Template-Änderungen Ändern der Blog-Identity Aufruf der Extension im Frontend Relationen zu anderen Tabellen m:n Mehrsprachigkeit zufügen Konfiguration mittels TypoScript Backend-Module mit Extbase Der Extbase-Kickstarter Installation des Extbase-Kickstarters Überblick über den Arbeitsbereich Eingabe der Extension-Konfiguration Modellierung Anlegen des Post-Objekts Anlegen des Tag-Objekts Relationen festlegen XV

12 16.19 Weitere Extbase-Interna StoragePid MVC-Request FlashMessages realisieren Die Fluid-Template-Engine Vorbereitung Basissyntax und einfache Ausgabe Arrays Objekte Fluid ViewHelper-Syntax Namespace (Namensraum) Argumente ViewHelper-Übersicht alias base cobject count cycle debug else for form format groupedfor if image layout link render renderflashmessages section then translate uri Erstellen eines eigenen ViewHelpers Der Dummytext-ViewHelper Zugriff auf die übergebenen Argumente Zufügen von Argumenten Tag-basierende ViewHelper Der Variablen-Container Verwendung von Fluid in klassischen Extensions Layouts und Partials Register XVI