|
|
| (17 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt) |
| Zeile 1: |
Zeile 1: |
| | {{stub}} | | {{stub}} |
| − | [[Category:Dev_HOWTOS]] | + | Tagebuch einer Extension-Entwicklung / Vorbemerkungen der Wiki-Autoren |
| − | {{AppliesTo|Ext1=Extension Creator|TLVersion=ab TL 2.8}} | + | [[Category:Tagebuch_einer_Extension-Entwicklung]] |
| − | =Vorbemerkung=
| + | {{AppliesTo |
| − | Dieser Artikel nimmt einen sehr ausführlichen Forumsbeitrag aus dem Contao-Community-Forum ''Allgemeine Infos für Third-Party Extensions -> Entwickler-Tutorials'' auf, der unter dem Titel ''Tagebuch einer Extension-Entwicklung'' von dl1ely (Stefan) verfasst wurde. Sie finden den Beitrag hier: [[http://www.contao-community.de/showthread.php?6570-Tagebuch-einer-Extension-Entwicklung Original Forumsbeitrag]]
| + | |Ext1=Extension Creator |
| | + | |TLVersion=ab TL 2.8}} |
| | | | |
| − | Entgegen den Wiki-Gepflogenheiten ist dieser Artikel in der Ich-Form gehalten, da es sich um einen Erfahrungsbericht handelt.
| + | =Vorbemerkungen= |
| − | =Allgemeine Hinweise= | + | * Die Artikel nehmen einen sehr ausführlichen Forumsthread aus dem Contao-Community-Forum ''Allgemeine Infos für Third-Party Extensions -> Entwickler-Tutorials'' auf, der unter dem Titel ''Tagebuch einer Extension-Entwicklung'' von dl1ely (Stefan) verfasst wurde. |
| − | Ich möchte hier gerne eine Art "Tagebuch" einer Extension-Entwicklung schreiben. Ich besitze das TL-Buch, ich kenne das "Hello, World"-Beispiel, ich kenne das CD-Collection-Beispiel, ich kenne das FlowPlayer-Beispiel.
| + | |
| − |
| + | |
| − | Trotzdem ist mir weiterhin nicht glasklar, welche Schritte man bis zur eigenen Extension gehen muss. Ich bin PHP-erfahren, habe aber noch nie eine TL-Extension geschrieben. Ich möchte mit diesem Tagebuch anderen "Anfängern" die Möglichkeit geben, an einem realen Beispiel zu lernen, und auch meine Entscheidungen und Gedanken entlang des Wegs kennen zulernen. In vielen Tutorials wird nur vorgegeben, was in welche Datei geschrieben wird, und was Zeile X oder Zeile Y dort tut. Der Prozess hin zu Zeile X oder Y bleibt leider zu oft im Dunkeln, und erschwert mir die Übertragung der vorgestellten Tutorial-Inhalte auf meine eigenen Probleme. Ich möchte hier auch Irrwege dokumentieren, wie sie für Extension-Anfänger wahrscheinlich typisch sind, und nicht nur ein Tutorial zum Endprodukt abliefern. Ich hoffe, die Foren-Admin akzeptieren so etwas als "Tutorial", falls nicht, dann bitte ich um Verschiebung in die "Fragen"-Sektion. Wobei ich eher berichten als fragen möchte. Natürlich freue ich mich auch über Hinweise, wenn ich vielleicht ganz in die falsche Richtung denke, oder ich im Rahmen meines "Tutorials" selbst nicht mehr weiter weiß.
| + | |
| | | | |
| − | Vorneweg:
| + | * Sie finden den Thread hier: [[http://www.contao-community.de/showthread.php?6570-Tagebuch-einer-Extension-Entwicklung Original Forumsbeitrag]]. Dort können Sie die Diskussion weiterführen. Ob künftige Forumsbeiträge hier eingearbeitet werden, ist nicht sichergestellt. |
| − | TL = TYPOlight
| + | |
| − | FE = Frontend (Seite, die jeder Surfer sieht)
| + | |
| − | BE = Backend (Seite, die nur eingeloggte "Redakteure" sehen unter der /typolight URL)
| + | |
| | | | |
| − | Alles soll sich unter TL 2.8.0 abspielen, und ich werde den Extension Creator verwenden, um mir das "Skelett" der Extension zu erstellen.
| + | * Die Originalbeiträge wurden redaktionell leicht überarbeitet. Dabei wurden neben forumspezifischen Besonderheiten auch Überleitungen, Anrede- und Grußformeln, Bewertungen ("Ich finde das Tutorial gaaaanz toll!") u.ä. entfernt. |
| − | Die Extension wird sehr speziell auf die Bedürfnisse der von mir betreuten Seite zugeschnitten sein. Ich glaube nicht, dass mit dem engen Scope jemand anders sie nutzen kann. Darum werde ich sie wohl auch nicht im Extension-Repository veröffentlichen. Ich kann und werde den Quelltext aber sicherlich zur Verfügung stellen, sei es zur Benutzung oder zum "Studium".
| + | |
| | | | |
| − | =Anforderungen und Randbedingungen=
| + | * An einigen Stellen wurden kleine Ergänzungen eingefügt. |
| − | Zunächst mal zum Hintergrund:
| + | |
| − | Ich bin Webmaster der Seite http://www.gruen-weiss-aachen.de , der Webpräsenz des momentan größten Tanzsportvereins in NRW, und einem der größten in Deutschland. Wie man unschwer erkennen kann, bedarf die Seite dringend eines Relaunchs, der auf Basis von TYPOlight erfolgen soll. Dazu erfolgt auf einer Subdomain parallel zum weiteren Betrieb der bisherigen Webseite der Aufbau einer TL-basierten Seite.
| + | |
| − |
| + | |
| − | Das Design steht noch nicht, erstmal soll die technische Funktionalität geschaffen werden. 95% der bisherigen Seiteninhalte lassen sich mit "TL-Bordmitteln" oder schon verfügbaren Extensions wie efg erschlagen. Allerdings gibt es auf der alten Seite einige "handgestrickte" PHP-Skripte, deren Funktionalität mehr oder weniger auf der neuen Seite erhalten bleiben soll.
| + | |
| | | | |
| − | Eine Funktionalität, die sich mit verfügbaren Extensions meiner Meinung nach nicht nachbilden lässt, und für die ich deshalb eine eigene Extension entwickeln möchte/muss, ist folgende:
| + | * Entgegen den Wiki-Gepflogenheiten sind die Artikel in der Ich-Form gehalten, da es sich um einen Erfahrungsbericht handelt. |
| | | | |
| − | Der Verein besitzt eine Menge an Tanzturnierpaaren. Zu diesen Turnierpaaren gehören Daten wie Name(n), Start- und Alterklassen, und ein Flag, ob es noch aktiv ist. Diese Daten werden von einer berechtigten Person (Sportwart) im BE gepflegt. Zusätzlich gehört zu einem Turnierpaar eine Art "Visitenkarte" mit Bild, Freitext, Email-Adresse, Telefonnummer...Diese Daten sollen auch im Backend pflegbar sein, zusätzlich sollen diese Daten aber auch von dem Turnierpaar selbst unter Kenntnis eines individuellen Passworts veränderbar sein. Dazu möchte ich aber KEINE Frontend-User-Verwaltung nutzen.
| + | * Im Großen und Ganzen orientiert sich das Tutorial an der TL/contao-Systematik und besteht daher aus den zwei Blöcken ''Backend'' und ''Frontend''. Eine strikte thematische Gliederung ist hier allerdings nicht möglich. Als Erfahrungsbericht glänzt das Tutorial ja gerade dadurch, dass die im Verlauf der Entwicklung auftretenden Probleme und Fragestellungen abgearbeitet werden und entsprechende Rücksprünge an vorherige, bereits erledigt geglaubte Bearbeitungsschritte erfordern. |
| − |
| + | |
| − | Für jedes Turnierpaar gibt es N "Meldungen", dies sind Datensätze, die enthalten, zu welchem Tanzturnier ein Paar fahren wird/gefahren ist. Turnierpaare informieren den Sportwart darüber, bei welchen Turnieren sie starten wollen. Der Sportwart führt die Anmeldung beim Turnierveranstalter durch (So ist das Procedere im Tanzsport), und trägt danach die "Meldung" in der Datenbank ein. Auf der sog. "Meldeliste" kann das Tanzpaar dann selbst sehen, ob es zu einem Turnier gemeldet worden ist. Die Liste der Meldungen (1:N-Beziehung zu den Turnierpaaren) wird vom Sportwart im BE gepflegt. Auch hier gibt es die Möglichkeit, dass ein Turnierpaar unter Kenntnis seines Passworts seinen erzielten Platz auf einem Turnier und einen freien Kommentar zu einer Meldung hinzufügen kann.
| + | |
| − |
| + | |
| − | Sollte das Tanzpaar das Turnier seiner Leistungsklasse gewonnen haben, darf es direkt im Anschluss das Turnier der nächsthöheren Klasse mittanzen (Ohne Meldung durch den Sportwart). Hier muss es die Möglichkeit geben, dass das Paar selbst einen Meldungs-Eintrag in der Datenbank vornehmen kann (Das sog. Folgeturnier).
| + | |
| − |
| + | |
| − | Die Meldeliste dient also mehreren Zwecken:
| + | |
| − | - Rückmeldung vom Sportwart an die Paare, dass die Meldung beim Veranstalter erfolgt ist
| + | |
| − | - Außenwirkung für den Verein: Wie viele Paare haben wir, und wo starten sie
| + | |
| − | - Außenwirkung für die Tanzpaare selbst: Wie gut haben wir abgeschnitten
| + | |
| | | | |
| − | Übertragen auf die Tabellenstruktur handelt es sich also um die Tabelle der Turnierpaare, klassisch im BE durch ein BE-Modul gepflegt. Die Meldungen sind "Childs" der Turnierpaare, und sollten so auch im Backend angezeigt werden (Wie Artikel - Inhaltselemente). Zugriff auf das BE-Modul hat nur der Sportwart.
| |
| − |
| |
| − | Zusätzlich soll es einen Mechanismus geben, unter Angabe eines Tanzpaar-spezifischen Passworts bestimmte Felder in der Tanzpaar-Tabelle und in der Melde-Tabelle durch ein Frontend-Formular zu verändern. Außerdem soll es die Möglichkeit geben, einen neuen Satz in der Melde-Tabelle anzulegen.
| |
| − |
| |
| − | Die Ausgabe der Daten im Frontend soll auf verschiedene Weisen geschehen:
| |
| | | | |
| − | ● Modul ''Aktive Turnierpaare''
| + | Und so ist das Tutorial aufgebaut: |
| | | | |
| − | ● Modul ''Ehemalige Turnierpaare''
| + | *TEE-00 Vorbemerkungen |
| | | | |
| − | Für beide Module jeweils eine Detail-Ansicht des gewählten Turnierpaares mit Bild, Freitext, freigegebenen Kontaktdaten wie Telefon oder Email, und einer Liste aller Meldungen dieses Paares.
| + | *[[TEE-01 Einleitung|TEE-01 Einleitung]] |
| − | | + | *[[TEE-02 Extension Creator|TEE-02 Extension Creator]] |
| − | ● Modul ''Meldeliste'' - Eine chronologisch absteigend sortierte Liste aller Melde-Einträge, Neueste also zuerst.
| + | *[[TEE-03 Backend BE-Modul und SQL|TEE-03 Backend BE-Modul und SQL]] |
| − | | + | *[[TEE-04 Backend DCA|TEE-04 Backend DCA]] |
| − | ● Module/Formulare für Änderung der Paardaten im Frontend und zum Hinzufügen von Platzierung/Kommentar bei Meldungen
| + | *[[TEE-05 Backend Language Files|TEE-05 Backend Language Files]] |
| − | | + | *[[TEE-06 Backend Callbacks und Subpaletten|TEE-06 Backend Callbacks und Subpaletten]] |
| − | Da das Ergänzen/Ändern der einzelnen Tabellenfelder mithilfe des Paar-Passworts ohne die Einführung von Frontend-Usern doch ziemlich an der TL-Philosophie vorbeigeht, tendiere ich momentan dazu, dafür Formulare zu verwenden, deren Weiterleitungsziel eine Seite ist, die per insert-Tag ein stand-alone-PHP-File einbindet, was nach Prüfung des Passworts die entsprechenden Datenbankfelder updatet.
| + | *[[TEE-07 Frontend Simpel-Version|TEE-07 Frontend Simpel-Version]] |
| − | | + | *[[TEE-08 Frontend Parametrisierung|TEE-08 Frontend Parametrisierung]] |
| − | Gibt es hier eigentlich Erfahrungen mit zeitgleichem Zugriff auf Tabellen bei zwei eingeloggten BE-Usern, oder wie hier in meinem Fall, wenn ein Skript auf FE-Seite potentiell Daten in der Datenbank ändert, die vielleicht gerade ein BE-User betrachtet? Aber damit werde ich leben, die Kollisionswahrscheinlichkeit ist sehr gering.
| + | *[[TEE-09 Frontend Detailliste|TEE-09 Frontend Detailliste]] |
| − | | + | *[[TEE-10 Frontend Feinschliff|TEE-10 Frontend Feinschliff]] |
| − | Coming up next: Extension-"Skelett" anlegen mit dem Extension-Creator.
| + | *[[TEE-11 Backend Zweite Tabelle|TEE-11 Backend Zweite Tabelle]] |
| − | | + | *[[TEE-12 Backend Callback-Magie|TEE-12 Backend Callback-Magie]] |
| − | ==Diskussionsbeiträge aus dem Forum==
| + | *[[TEE-13 Frontend Meldeliste|TEE-13 Frontend Meldeliste]] |
| − | {{Hinweis| Diskussionsbeiträge aus dem Forum einarbeiten!}}
| + | *[[TEE-14 Downloads|TEE-14 Downloads]] |
| − | =Extension Creator=
| + | *[[TEE-15 Werkzeuge|TEE-15 Werkzeuge]] |
| − | Also, los geht es mit dem Skelett für die geplante Extension. Ich verwende den Extension-Creator aus dem Extension-Repository.
| + | |
| − | | + | |
| − | ● Titel: Es geht um Turnierpaar-"Verwaltung", und um Namenskonflikte zu vermeiden möchte ich gerne einen spezifischen Präfix nutzen: gw angelehnt an den Vereinsnamen "Grün-Weiß". Also: Titel = ''gw_turnierpaare''. An dieser Stelle bin ich mir noch nicht so sicher, wo dieser "Titel" überall erscheinen wird, und ob es deshalb ein beliebiger Text sein soll, oder eher ein "identifier", also z.b. ohne Leerzeichen u.ä. Sicherheitshalber gehe ich den Identifier-Weg. Besser hässlich als nicht-funktionierend.
| + | |
| − | | + | |
| − | ● Ordnername: Ebenfalls ''gw_turnierpaare''.
| + | |
| − | | + | |
| − | ● Autor, Copyright und Lizenz: Selbsterklärend
| + | |
| − | | + | |
| − | ● Paket: Ein Paketname ist gefragt. Der Hilfetext unter dem Eingabefeld schlägt hilfreich "z.B. meinEigenesModul" vor. Ist das Modul jetzt das Paket? Was ist ein Paket? Sowas wie ein Namensraum? Da ich noch nicht weiß, ob ich für die Vereinsseite noch andere Extensions pogrammieren werde, nehme ich die Vereinsabkürzung als "Paketname", also ''GW''. Weitere vereinsspezifische Extensions würde ich dann in dasselbe Paket stecken.
| + | |
| − | | + | |
| − | ● Ein Backend-Modul hinzufügen: Ja klar, schließlich sollen Daten im Backend bearbeitet werden. Also dort ein Häkchen.
| + | |
| − | | + | |
| − | ● Backend-Klassen: Wenig hilfreicher Erklärungstext: "Hier können Sie eine kommagetrennte Liste der zu erstellenden Backend-Klassen eingeben." - Was sind Backend-Klassen? Wofür brauche ich die? Eigentlich müsste doch alles, was ich im Backend vorhabe, durch Einträge im DCA-File realisierbar sein, schließlich geht es nur um Pflege von zwei abhängigen Datenbanktabellen. Also mal mutig leer gelassen, falls das falsch ist kann man es später noch hinzufügen.
| + | |
| − | | + | |
| − | ● Backend-Tabellen: Das sind wohl meine Datentabellen, ich will eine für Turnierpaare, eine für Meldungen, also: ''tl_gw_turnierpaare,tl_gw_meldungen''.
| + | |
| − | | + | |
| − | ● Backend-Templates: Auch hier wieder wenig erhellender Hilfetext. Auch das TL-Buch beschränkt sich da leider fast auf das Abschreiben der Hilfetexte unter den Eingabefeldern. Ich kenne Templates nur für das Frontend, also beschließe ich mutig, dass ich das wohl nicht brauche. Sollte sich das später als Irrtum herausstellen, wird es sich hoffentlich noch korrigieren lassen.
| + | |
| − | | + | |
| − | ● Ein Frontend-Modul hinzufügen: Aber klar, die Daten sollen schließlich im Frontend visualisiert werden. Also Haken dran.
| + | |
| − | | + | |
| − | ● Frontend-Klassen: So weit wie ich es bisher verstanden habe, braucht jedes Modul eine eigene Klasse. Nach meiner bisherigen Planung brauche ich ein Modul ''Turnierpaarliste'' inklusive Detail-Ansicht der einzelnen Paar-Einträge. Die Unterscheidung aktiv/nicht aktiv würde ich gerne über einen Parameter im Modul lösen, so dass dasselbe Modul die Liste der aktiven und der ehemaligen Paare anzeigen kann. Außerdem benötige ich ein Modul ''Meldeliste'' mit der chronologisch sortierten Übersicht der Meldungen. Also: ''gwTurnierpaarliste,gwMeldeliste'' als Klassennnamen.
| + | |
| − | | + | |
| − | ● Frontend-Tabellen: Ratlosigkeit. Was unterscheidet Frontend-Tabellen von Backend-Tabellen? Da ich meine Tabellen schon in den Backend-Tabellen abgehandelt habe, lasse ich das Feld leer.
| + | |
| − | | + | |
| − | ● Frontend-Templates: Natürlich! ''gw_turnierpaarliste,gw_turnierpaarliste_detail,gw _meldeliste'' fallen mir sofort ein, vielleicht genügt das schon. Falls nicht, kann ich später noch welche hinzufügen.
| + | |
| − | | + | |
| − | ● Sprachpakete erstellen: Natürlich. Auch wenn es wahrscheinlich niemand in Englisch benutzen wird, tut es mir aber auch nicht weh, also Sprachen = ''en,de''.
| + | |
| − | | + | |
| − | Dann "speichern und schließen", und auf den grünen Haken am Ende der neuen Zeile ''gw_turnierpaare'' im Extension-Creator geklickt. Die Warnung bestätigt, und der Extension-Creator hat mir erstmal den Grundstock an Files in ''/system/modules/gw_turnierpaare/'' erzeugt.
| + | |
| − |
| + | |
| − | Und zwar:
| + | |
| − | | + | |
| − | ● ''gwMeldeliste.php,gwTurnierpaarliste.php'': meine Frontendklassen
| + | |
| − | | + | |
| − | ● ''config/config.php'' und ''config/database.sql'' (Letzteres für meine SQL-Tabellenstruktur)
| + | |
| − | | + | |
| − | ● ''dca/tl_gw_turnierpaare.php'' und ''dca/tl_gw_meldungen.php'': Die DCA-Definitionen für meine Tabellen zur Bearbeitung im Backend
| + | |
| − | | + | |
| − | ● ''languages/...'': Die Sprachfiles in en und de-Variante
| + | |
| − | | + | |
| − | ● ''templates/...'': Die drei Frontend-Templates, die ich angegeben hatte
| + | |
| − | | + | |
| − | Im nächsten Schritt orientieren wir uns etwas und beginnen, die vorgegebenen Files zu modifizieren.
| + | |
| − | | + | |
| − | P.S.: Wenn die erfahrenen TL-Programmierer jetzt schon Gänsehaut haben: Sorry. Ich mache das zum ersten
| + | |
| − | Mal, und stelle mich nicht künstlich dumm an. Ich versuche so zu schildern, wie ich als Einsteiger die Sachen
| + | |
| − | sehe, was mich verwirrt usw...Bin für Verbesserungsvorschläge z.B. zu Namens-Schemata usw immer zu haben.
| + | |
| − | Genauso freue ich mich über Aufklärung zu Dingen, die ich selbst nicht verstehe...Backendklassen, Backend-
| + | |
| − | Templates, Frontend-Tabellen, Paket...
| + | |
| − | | + | |
| − | =Backend-Modul registrieren=
| + | |
| − | ==SQL reloaded==
| + | |
| − | =Wir wagen uns in das DCA-Land=
| + | |
| − | ==Verwirrung im DCA-Land==
| + | |
| − | ==Leichte Entwirrung im DCA-Land==
| + | |
| − | ==DCA-Polishing==
| + | |
| − | ==Nochmals anders==
| + | |
| − | ==DCA - Almost there==
| + | |
| − | =Language Files=
| + | |
| − | =Von Callbacks und Subpaletten=
| + | |
| − | =Endlich Frontend!=
| + | |
| − | ==Ein wenig Finetuning==
| + | |
| − | =Parameter fürs Modul=
| + | |
| − | ==Parameter fürs Modul, die Zweite==
| + | |
| − | =Details, Details, Details=
| + | |
| − | =Etwas Feinschliff=
| + | |
| − | =Die zweite Tabelle=
| + | |
| − | =Callback-Magie=
| + | |
| − | =Frontendmodul Meldeliste=
| + | |
| − | ==JOIN-Power==
| + | |
| − | =Downloads=
| + | |
| − | dl1ely hat eine gezippte Version seiner Extension zum Download zur Verfügung gestellt, der Stand ist vom 29.05.2010.
| + | |
| − | Diese Datei entpacken Sie bitte in den TL/contao-Ordner ''/system/modules/''.
| + | |
| − | | + | |
| − | [http://dl.dropbox.com/u/804662/gw_turnierpaare_20100529.zip Quelltext des Moduls]
| + | |
| − | | + | |
| − | Schnippsel hat aus den Forumsbeiträgen bis #104 eine PDF-Datei erstellt, die minimal gekürzt ist. Insbesondere alle forumsspezifischen Details (z.B. Fotos der Poster etc.), Anreden und Grußformeln sowie die Lobeshymnen ("Ich finde dein Tutorial gaaaaaanz toll!") wurden entfernt. Trotzdem hat die Datei eine Größe von ca. 1,5 MB und umfasst ca. 125 Seiten!
| + | |
| − | | + | |
| − | [[http://de.contaowiki.org/images/de/d/d2/Tagebuch_einer_Extension-Entwicklung_-_bis_104.pdf PDF-Datei mit Forumsbeiträgen]] | + | |
