TYPO3-Extensions - Professionelle Frontend- und Backend-Programmierung

Inhalt

Vorwort

Teil I Klassische Extensionprogrammierung

1 Grundlagen

1.1 Aufbau und Struktur von TYPO3

1.2 Aufbau einer Extension

1.3 Arten und Einteilung von Extensions

1.4 Der Extension-Key

1.5 TYPO3 Coding Guidelines

1.5.1 Namespace

1.5.2 PHP-Regeln

1.5.3 Dateistruktur

1.5.4 PHP-Syntax

1.5.5 phpDoc2

1.5.6 Changelog

2 Eine Extension planen undentwickeln

2.1 Extensions planen

2.1.1 Wir planen eine Blog-Extension

2.2 Der Kickstarter

2.2.1 Die Datenbank

2.2.2 Datenbanktabellen und Formulare – eine Erklärung

2.2.3 Extend existing Tables

2.2.4 Frontend-Plug-ins

2.2.5 Backend-Module

2.2.6 Integrate in existing Modules

2.2.7 Clickmenu items

2.2.8 Services

2.2.9 Static TypoScript code

2.2.10 TSconfig

2.2.11 Die Extension erstellen

2.3 Extension-Konfiguration mit ext_emconf.php

2.4 Die weiteren Dateien der Extension

2.4.1 Verzeichnis doc

2.4.2 Verzeichnis mod#

2.4.2.1 Datei mod#/conf.php

2.4.2.2 Datei mod#/index.php

2.4.2.3 Datei mod#/locallang.xml

2.4.2.4 Datei mod#/locallang_mod.xml

2.4.3 Verzeichnis modfunc#

2.4.3.1 Datei modfunc#/class.tx_extkey_modfunc1.php

2.4.4 Verzeichnis pi#

2.4.4.1 Datei pi#/class.tx_extkey_pi#.php

2.4.4.2 Datei pi#/class.tx_extkey_pi#_wizicon.php

2.4.4.3 Datei pi#/ce_wiz.gif

2.4.4.4 Datei pi#/clear.gif

2.4.4.5 Datei pi#/static/setup.txt

2.4.5 Verzeichnis Static

2.4.6 Datei Changelog

2.4.7 Datei README.txt

2.4.8 Datei ext_icon.gif

2.4.9 Datei ext_localconf.php

2.4.10 Datei ext_tables.php

2.4.11 Datei ext_tables.sql

2.4.12 Datei ext_tables_static+adt.sql

2.4.13 Dateien Icon_tx_extkey_tabellenname.gif

2.4.14 Datei locallang.xml

2.4.15 Datei locallang_db.xml

2.4.16 Datei tca.php

2.4.16.1 Checkboxen

2.4.16.2 Erweiterte Input-Felder

2.4.16.3 Validierung mit eval

2.4.16.4 Benutzerdefinierte Validierung

2.4.16.5 Bildupload-Feld

2.4.16.6 Textfelder mit RTE

2.4.16.7 M-M-Relationen

3 Backend-Module erstellen

3.1 Module konfigurieren und im Hauptmenü anordnen

3.2 Einen eigenen Navigationsbaum erstellen

3.3 Backend-Modul erstellen

3.3.1 Das Modul initialisieren

3.3.2 Den Modulinhalt aufbauen

3.3.3 Extension-Konfiguration über ext_conf_template.txt

3.3.4 Backend-Formulare aufrufen

3.3.5 Eine Datensatzliste mit Bearbeitungsfunktionen erstellen

3.3.5.1 Einen Pagebrowser hinzufügen

3.3.6 Aufgabe: Module für Kommentare, Blog und Blogroll

3.3.6.1 Tipps

3.3.6.2 Zusatzaufgabe

3.4 Backend User Object – $BE_USER

3.5 Das Systemlog

4 Frontend-Plug-ins

4.1 Das Frontend-Plug-in im Überblick

4.2 Feldinhalte für die Ausgabe aufbereiten

4.2.1 Das Bild für Teaser Image

4.2.2 Ausgabe des Haupttextes in der Listenansicht, wennerwünscht

4.2.3 Haupttext mit RTE formatieren

4.2.4 Haupttext statt Teasertext anzeigen, falls dieser nichtverfügbar ist

4.2.5 Verlinken des Autorennamens mit der Mail-Adresse desAutors

4.2.6 Kategorien als Namen anzeigen und verlinken (Relationen)

4.3 HTML-Templates für das Plug-in

4.4 Die Kommentarfunktion mit AJAX und eID

4.4.1 Ausgabe vorhandener Kommentare

4.4.2 Das Kommentarformular hinzufügen

4.5 Was sind Hooks?

4.6 Flexforms

4.6.1 Erzeugen der Flexform

4.7 Das Plug-in pi2

5 Dokumentation und Abschluß

5.1 Code dokumentieren mit extdeveval

5.2 Extension-Dokumentation schreiben

5.2.1 Die Vorlage

5.2.2 Der Aufbau der Dokumentation

5.2.3 Vorlagenstile

5.2.4 Die Dokumentation verfassen

5.3 Upload ins TER

Teil II Funktionsreferenz zur klassischenExtensionprogrammierung

6 Datenbank

6.1 $GLOBALS['TYPO3_DB']

6.1.1 exec_SELECTquery

6.1.2 exec_SELECT_queryArray

6.1.3 exec_SELECTgetRows

6.1.4 exec_SELECT_mm_query

6.1.5 exec_INSERTquery

6.1.6 exec_UPDATEquery

6.1.7 exec_DELETEquery

6.1.8 sql_fetch_assoc

6.1.9 sql_fetch_row

6.1.10 searchQuery

6.1.11 listQuery

6.1.12 splitGroupOrderLimit

6.1.13 quoteStr

6.1.14 fullQuoteStr

6.1.15 fullQuoteArray

6.1.16 escapeStrForLike

6.1.17 cleanIntArray

6.1.18 cleanIntList

6.1.19 debug_lastBuiltQuery

6.2 tslib_pibase

6.2.1 pi_exec_query

6.2.2 pi_getPidList

6.2.3 pi_getRecord

6.2.4 pi_prependFieldsWithTable

6.3 cObj

6.3.1 DBgetDelete

6.3.2 DBgetInsert

6.3.3 DBgetUpdate

6.3.4 enableFields

7 Dateisystem

7.1 t3lib_div

7.1.1 dirname

7.1.2 fixWindowsFilePath

7.1.3 formatSize

7.1.4 get_dirs

7.1.5 getAllFilesAndFoldersInPath

7.1.6 getFileAbsFileName

7.1.7 getFilesInDir

7.1.8 getURL

7.1.9 isAbsPath

7.1.10 isAllowedAbsPath

7.1.11 mkdir

7.1.12 mkdir_deep

7.1.13 removePrefixPathFromList

7.1.14 resolveBackPath

7.1.15 rmdir

7.1.16 split_fileref

7.1.17 tempnam

7.1.18 unlink_tempfile

7.1.19 upload_copy_move

7.1.20 upload_to_tempfile

7.1.21 verifyFilenameAgainstDenyPattern

7.1.22 writeFile

7.1.23 writeFileToTypo3tempDir

8 Strings, Arrays undUmgebungsvariablen

8.1 Allgemeine Funktionen

8.1.1 _GET

8.1.2 _GETset

8.1.3 _GP

8.1.4 _POST

8.1.5 callUserFunction

8.1.6 clientInfo

8.1.7 compat_version

8.1.8 compileSelectedGetVarsFromArray

8.1.9 getHostname

8.1.10 getIndpEnv

8.1.11 getThisUrl

8.1.12 linkThisScript

8.1.13 linkThisUrl

8.1.14 locationHeaderUrl

8.1.15 makeInstance

8.1.16 makeInstanceService

8.1.17 rmFromList

8.1.18 sysLog

8.2 String-Funktionen

8.2.1 calcParenthesis

8.2.2 cmpFQDN

8.2.3 cmpIP

8.2.4 convUmlauts

8.2.5 csvValues

8.2.6 deHSCentities

8.2.7 expandList

8.2.8 fixed_lgd

8.2.9 fixed_lgd_pre

8.2.10 formatForTextarea

8.2.11 generateRandomBytes

8.2.12 get_tag_attributes

8.2.13 htmlspecialchars_decode

8.2.14 implodeArrayForUrl

8.2.15 implodeAttributes

8.2.16 inList

8.2.17 int_from_ver

8.2.18 intInRange

8.2.19 intval_positive

8.2.20 isFirstPartOfStr

8.2.21 md5int

8.2.22 milliseconds

8.2.23 modifyHTMLColor

8.2.24 modifyHTMLColorAll

8.2.25 normalizeIPv6

8.2.26 removeXSS

8.2.27 revExplode

8.2.28 rm_endcomma

8.2.29 shortMD5

8.2.30 split_tag_attributes

8.2.31 splitCalc

8.2.32 strtolower

8.2.33 strtoupper

8.2.34 substUrlsInPlainText

8.2.35 testInt

8.2.36 trimExplode

8.2.37 uniqueList

8.2.38 validEmail

8.2.39 validIP

8.2.40 validIPv4

8.2.41 validIPv6

8.3 Array-Funktionen

8.3.1 addSlashesOnArray

8.3.2 array_merge

8.3.3 array_merge_recursive_overrule

8.3.4 array2json

8.3.5 array2xml

8.3.6 arrayToLogString

8.3.7 explodeUrl2Array

8.3.8 inArray

8.3.9 print_array

8.3.10 removeArrayEntryByValue

8.3.11 slashArray

8.3.12 view_array

8.3.13 xml2array

8.3.14 xml2tree

8.3.15 xmlGetHeaderAttribs

8.4 String-Funktionen in Frontend-Plug-ins

8.4.1 calcAge

8.4.2 checkEmail

8.4.3 codeString

8.4.4 encryptEmail

8.4.5 HTMLcaseshift

8.4.6 keywords

8.4.7 linebreaks

8.4.8 processParams

8.4.9 uniqueHash

8.4.10 URLqMark

9 Bilder

9.1 Einbinden

9.2 Bearbeiten

9.2.1 Bild umrechnen (fürs Web optimieren)

9.2.2 Abmessungen ändern

9.2.3 Zuschneiden

9.2.4 Graustufen

9.3 Erzeugen

9.3.1 Bild in bestehendes Bild einfügen

9.3.2 Text erzeugen

10 AJAX im Frontend

10.1 eID

10.1.1 Konfiguration

10.1.2 Basisdatei

10.2 Zusammenspiel AJAX & eID

10.2.1 Aufbau der XML-Response

10.2.2 AJAX-Request und Verarbeitung

11 Frontend-Plug-ins

11.1 Cache

11.1.1 cacheExpires

11.1.2 clearPageCacheContent

11.1.3 clearPageCacheContent_pidList

11.1.4 get_cache_timeout

11.1.5 set_cache_timeout_default

11.1.6 set_no_cache

11.2 Content-Elemente

11.2.1 cImage

11.2.2 cleanFormName

11.2.3 cObjGet

11.2.4 cObjGetSingle

11.2.5 currentPageUrl

11.2.6 fileResource

11.2.7 getImgResource

11.2.8 getSlidePids

11.2.9 gifBuilderTextBox

11.2.10 stdWrap

11.3 Links

11.3.1 baseUrlWrap

11.3.2 getMailTo

11.3.3 getTypoLink

11.3.4 getTypoLink_URL

11.3.5 http_makelinks

11.3.6 imageLinkWrap

11.3.7 mailto_makelinks

11.3.8 pi_getPageLink

11.3.9 pi_linkToPage

11.3.10 pi_linkTP

11.3.11 pi_linkTP_keepPIvars

11.3.12 pi_linkTP_keepPIvars_url

11.3.13 pi_openAtagHrefInJSwindow

11.3.14 prefixLocalAnchorsWithScript

11.4 Listen

11.4.1 pi_list_browseresults

11.4.2 pi_list_linkSingle

11.4.3 pi_list_makelist

11.4.4 pi_list_modeSelector

11.4.5 pi_list_searchBox

11.5 JavaScript

11.5.1 additionalHeaderData

11.5.2 additionalJavaScript

11.5.3 JSeventFuncCalls

11.5.4 minifyJavaScript

11.5.5 quoteJSvalue

11.5.6 rawUrlEncodeJS

11.5.7 setJS

11.5.8 wrapJS

11.6 CSS

11.6.1 additionalCSS

11.6.2 additionalHeaderData

11.6.3 pi_getClassName

11.6.4 pi_setClassStyle

11.6.5 setCSS

11.7 Mehrsprachigkeit

11.7.1 getLLL

11.7.2 pi_getLL

11.7.3 readLLfile

11.8 Umgebungsvariablen und allgemeine Funktionen

11.8.1 absRefPrefix

11.8.2 additionalHeaderData

11.8.3 all

11.8.4 anchorPrefix

11.8.5 applicationData

11.8.6 ATagParams

11.8.7 baseUrl

11.8.8 baseUrlWrap

11.8.9 beUserLogin

11.8.10 clientInfo

11.8.11 content

11.8.12 defaultBodyTag

11.8.13 domainStartPage

11.8.14 extTarget

11.8.15 fePreview

11.8.16 id

11.8.17 imagesOnPage

11.8.18 intTarget

11.8.19 lang

11.8.20 lastImageInfo

11.8.21 loginUser

11.8.22 no_cache

11.8.23 page

11.8.24 printError

11.8.25 rootLine

11.8.26 siteScript

11.8.27 tmpl->config, tmpl->setup

11.8.28 type

11.8.30 uniqueString

11.9 Konfiguration mit Flexforms

11.9.1 Erstellen einer Plug-in_Flexform

11.9.2 Auslesen der Formulardaten

11.10 Konfiguration mit TypoScript

11.11 Konfiguration im Extension-Manager

12 Frontend-User & Sessions

12.1 Frontend-User

12.1.1 Daten des aktuell angemeldeten Users

12.2 Sessions

12.2.1 Daten speichern

12.2.2 Daten auslesen

12.2.3 Warenkorb aufbauen

13 Backend & Services

13.1 Eigene Flexforms

13.1.1 Mehrsprachigkeit

13.1.2 Tabs

13.1.3 Elemente

13.1.4 Flexform-Daten im Frontend

13.2 Backend-Module

13.2.1 Dokumententypen für $this->doc

13.2.2 TypoScript einer Seite auslesen

13.2.3 AJAX im Backend

13.3 Services

13.4 cli

13.5 Debugging

13.5.1 debug

13.5.2 debug_ordvalue

13.5.3 debug_trail

13.5.4 debugRows

13.5.5 devLog

Teil III Extbase und Fluid

14 Der neue Weg der Extension-Programmierung

14.1 Grundlagen der objektorientierten Programmierung

14.1.1 Klassen und Objekte

14.1.2 Vererbung von Klassen

14.1.3 Kontrollierte Vererbung – abstrakte und finale Klassen

14.1.4 Sichtbarkeiten: public, private und protected

14.1.5 Interfaces

14.1.6 Type Hints

14.1.7 Statische Methoden und Eigenschaften

14.1.8 Namespaces

14.2 Neue Konzepte

14.2.1 Domain Driven Design

14.2.2 Model-View-Controller

14.2.3 Modellierung

14.2.4 Gemeinsamens Vokabular – Ubiquitous Language

14.2.5 Die Elemente des Modells

14.2.5.1 Entities (Entitäten)

14.2.5.2 Value Objects

14.2.5.3 Services

14.2.5.4 Aggregates

14.2.5.5 Factories

14.2.5.6 Repositories

15 Ein Rundgang durchs System

15.1 Installation von Extbase und Fluid

15.2 Installation der Extension blog_example

15.3 Datenstruktur im Blog-Example

15.4 Namenskonventionen

15.4.1 Verzeichnis- und Dateinamen

15.4.2 Klassennamen

15.4.3 Controller und Actions

15.5 Die Dateistruktur im Extension-Root-Verzeichnis

15.5.1 Die Datei ext_emconf.php

15.5.2 Die Datei ext_tables.php

15.5.3 Die Datei ext_localconf.php

15.5.4 Die Dateien ext_tables.sql und ext_icon.gif

15.6 Die Verzeichnisstruktur

15.6.1 Das Verzeichnis Classes

15.6.2 Das Verzeichnis Configuration

15.6.3 Das Verzeichnis Module

15.6.4 Das Verzeichnis Resources

15.6.5 Weitere Verzeichnisse

15.7 Der prinzipielle Ablauf

15.7.1 Aufruf des Dispatchers (Schritt 1)

15.7.2 Aufruf des Controllers (Schritt 2)

15.7.3 Ansprechen des Respositorys (Schritt 3)

15.7.4 Zurückliefern der Blog-Objekte (Schritt 4)

15.7.5 Das Objekt wird dem View zugeordnet (Schritt 5)

15.7.6 Rückgabe der Template-Ausgabe an den Controller (Schritt 6)

15.7.7 Rückgabe der Ausgabe an den Dispatcher (Schritt 7)

15.7.8 Rückgabe der Ausgabe an TYPO3 (Schritt 8)

16 Entwicklung eines eigenenPlug-ins

16.1 Aufbau einer minimal funktionstüchtigen Extension

16.1.1 Extension-Key

16.1.2 Verzeichnisse anlegen

16.1.3 Die Datei ext_emconf.php

16.1.4 Die Dateien ext_localconf.php und ext_tables.php

16.1.5 Einrichten eines Standard-Controllers

16.1.6 Installieren der Extension und das erste Erfolgserlebnis

16.2 Hinzufügen eines Views

16.3 Entitäten einführen

16.4 Daten persistieren (Datenspeicher)

16.4.1 Datenbankstruktur – die Datei ext_tables.sql

16.4.2 Datenbankstruktur – das TCA

16.5 Anlegen eines Repositorys

16.6 Anlegen einer neuen Action

16.6.1 Anlegen der Action addAction()

16.7 Daten per Formular eingeben und auswerten

16.8 Objekte aus dem Repository entfernen

16.8.1 Zufügen der Action delete in der Konfiguration

16.8.2 Anpassen der Template-Datei index.html

16.8.2.1 Zufügen der Action delete im Blog-Controller

16.9 Update von Objekten

16.9.1 Edit- und Update-Action hinzufügen

16.10 Der Query-Manager

16.11 Eingabevalidierung

16.12 Validatoren

16.12.1 Vordefinierte Validatoren

16.12.2 Eigene Validatoren

16.12.3 Ausgabe der Fehler

16.12.4 Optionale Argumente

16.13 Relationen zu anderen Tabellen

16.13.1 Erweiterung des TCA

16.13.2 Die Domain-Klasse Tx_Simpleblog_Domain_Model_Post

16.13.3 Registrieren der Actions in der Datei ext_localconf.php

16.13.4 Erstellung des Post-Controllers

16.13.5 Neue Templates und Template-Änderungen

16.13.6 Ändern der Blog-Identity

16.13.7 Aufruf der Extension im Frontend

16.14 Relationen zu anderen Tabellen m:n

16.15 Mehrsprachigkeit zufügen

16.16 Konfiguration mittels TypoScript

16.17 Backend-Module mit Extbase

16.18 Der Extbase-Kickstarter

16.18.1 Installation des Extbase-Kickstarters

16.18.2 Überblick über den Arbeitsbereich

16.18.3 Eingabe der Extension-Konfiguration

16.18.4 Modellierung

16.18.4.1 Anlegen des Blog-Objekts

16.18.5 Anlegen des Post-Objekts

16.18.6 Anlegen des Tag-Objekts

16.18.7 Relationen festlegen

16.19 Weitere Extbase-Interna

16.19.1 StoragePid

16.19.1.1 Schreibzugriffe

16.19.1.2 Aktualisieren

16.19.1.3 Lesen

16.19.2 MVC-Request

16.19.3 FlashMessages realisieren

17 Die Fluid-Template-Engine

17.1 Vorbereitung

17.2 Basissyntax und einfache Ausgabe

17.2.1 Arrays

17.2.2 Objekte

17.3 Fluid ViewHelper-Syntax

17.3.1 Namespace (Namensraum)

17.3.2 Argumente

17.3.2.1 Boolesche Ausdrücke

17.3.2.2 Komplexe boolesche Ausdrücke

17.3.2.3 Arrays

17.4 ViewHelper-Übersicht

17.4.1 alias

17.4.2 base

17.4.3 cObject

17.4.4 count

17.4.5 cycle

17.4.6 debug

17.4.7 else

17.4.8 for

17.4.9 form

17.4.9.1 form.checkbox

17.4.9.2 form.error

17.4.9.3 form.hidden

17.4.9.4 form.password

17.4.9.5 form.radio

17.4.9.6 form.select

17.4.9.7 form.submit

17.4.9.8 form.textarea

17.4.9.9 form.textbox

17.4.9.10 form.upload

17.4.10 format

17.4.10.1 format.crop

17.4.10.2 format.currency

17.4.10.3 format.date#

17.4.10.4 format.html

17.4.10.5 format.nl2br

17.4.10.6 format.number

17.4.10.7 format.padding

17.4.10.8 format.printf

17.4.11 groupedFor

17.4.12 if

17.4.13 image

17.4.14 layout

17.4.15 link

17.4.15.1 link.action

17.4.15.2 link.email

17.4.15.3 link.external

17.4.15.4 link.page

17.4.16 render

17.4.17 renderFlashMessages

17.4.18 section

17.4.19 then

17.4.20 translate

17.4.21 uri

17.5 Erstellen eines eigenen ViewHelpers

17.5.1 Der Dummytext-ViewHelper

17.5.2 Zugriff auf die übergebenen Argumente

17.5.3 Zufügen von Argumenten

17.5.4 Tag-basierende ViewHelper

17.5.5 Der Variablen-Container

17.6 Verwendung von Fluid in klassischen Extensions

17.7 Layouts und Partials

Register