Ein Gästebuch mit XML, XPATH, DOM und PHP Ein kleines Tutorial

Transkript

1 Ein Gästebuch mit XML, XPATH, DOM und PHP Ein kleines Tutorial

2 2 Ein Gästebuch mit XML, XPATH, DOM und PHP Inhaltsverzeichnis Vorwort 3 Datenhaltung 4 Prüfung der Daten 5 Darstellung 7 Datenverarbeitung 8 Helfer 16 Was könnte man verbessern 18 Fazit 18

3 3 Ein Gästebuch mit XML, XPATH, DOM und PHP Vorwort Auf der Suche nach einem geeigneten PHP Script für mein Gästebuch, kam ich auf die Idee hier gleich ein kleines Tutorial zu schreiben in dem wir gemeinsam ein Gästebuch mit PHP und XML als "Datenspeicher" bauen. Unser Ziel: Wir möchten ein Gästebuch welches die Daten in einer XML Datei abspeichert. Weiterhin sollen die einzelnen Einträge mit Hilfe von Templates auf der Webseite dargestellt werden. Hinzufügen, Löschen sowie Kommentieren von Einträgen soll ebenfalls möglich sein. Also packen wir es an. Was benötigen wir im Einzelnen? Wir benötigen was für die: Datenhaltung o hier unser XML Datei o Abbildung der XML Daten auf der Anwendungsseite Prüfung o prüfen unserer XML Struktur o prüfen der Eingabedaten Darstellung o Vorlage zur Darstellung von Einträgen o Vorlage zur Darstellung des Erfassungsformulars o Vorlage zur Darstellung des Kommentarformulars o Vorlage zur Darstellung zur Veränderung von Daten (löschen) Datenverarbeitung o laden der Daten aus der XML Datei o hinzufügen von neuen Daten o entfernen von Daten o verändern von Daten Helfer o Funktionalitäten zur Fehlerbehandlung o Kapselung von komplexen Abarbeitungen o Routine zur Übergabe der Eingabedaten (GET, POST) o Konfiguration der Anwendung Unser Projekt bezeichnen wir XMLGB und legen alles in folgender Struktur ab.

4 4 Ein Gästebuch mit XML, XPATH, DOM und PHP Sie sehen dass ich für die Funktionalitäten jeweils eine PHP Datei genommen habe. Weiterhin sind in diesen Dateien die speziellen Klassen definiert. Diese Anwendung werden wir objektorientiert umsetzen. Warum Objektorientiert? Die Vorzüge wie bessere Wartung und Pflege sowie weitere Aspekte der Objektorientierung möchte ich auch in diesem kleinen Projekt nicht missen. Ok, packen wir es an! Datenhaltung Für die Datenhaltung haben wir uns im Vorfeld für XML entschieden. Hier nun der Aufbau der Datei: Für die Eindeutigkeit eines Eintrags eindeutig ist das Attribut id im XML Tag entry zuständig. Zu beachten ist, dass Text und Kommentar in sogenannten CDATA Blöcken stehen. Nur so haben wir die Möglichkeit auch HTML als Text abzuspeichern (wenn gewünscht). Die dazugehörige XSD Datei zum Validieren der XML Struktur finden Sie im Projekt. Für die Abbildung auf der Anwendungsseite erstellen wir ein Klasse welche die Datenfelder bereitstellt.

5 5 Ein Gästebuch mit XML, XPATH, DOM und PHP Ich möchte hier nicht auf alle einzelnen Methoden eingehen. Wichtig für uns ist hier vor allem der Konstruktor der Klasse. Hier wird die eindeutige ID des Eintrages mit Hilfe der PHP Funktionen uniqid, mt_rand und md5 erzeugt sowie das Erstellungsdatum zugewiesen (der Einfachheit halber im deutschen Format). Prüfung der Daten Zur Prüfung der XML Struktur habe ich eine XSD Datei erstellt in der der Aufbau der XML Datei definiert ist. Die Prüfung des Aufbaus erfolgt bei der Datenverarbeitung. Das Abprüfen gegen ein XSD Schema stellt sicher dass wir in unserer Anwendung mit einer gültigen XML Struktur arbeiten können. Für die inhaltliche Prüfung der einzelnen Einträge erstellen wir die Klasse XMLGB_XMLGuestbookItemValidator in der wir die einzelnen Datenfelder nach Inhalt und Gültigkeit prüfen. Die Prüfung der Adresse habe ich hier mit der Funktion filter_var abgebildet. Festzustellen ist jedoch dass wir hier eine explizite Konvertierung der Wertes in einen String vornehmen müssen da sonst die auch ungültige Mail Adressen angenommen werden (siehe

6 6 Ein Gästebuch mit XML, XPATH, DOM und PHP Der Schalter $HTMLinTEXT bestimmt ob auch HTML Codes als Text abgelegt werden kann (Voreinstellung ist false ).

7 7 Ein Gästebuch mit XML, XPATH, DOM und PHP Darstellung Bei der Darstellung der Daten benutzen wir sogenannte Templates. Die Templates werden aber nicht mit einer Template Engine wie zum Beispiel Smarty ausgewertet, doch dazu später. In den Templates bestimmen wir einfach das Aussehen und stellen für die eigentlichen Daten Platzhalter bereit. Ich habe die Form ::Platzhaltername:: gewählt. Als Beispiel hier ein Auszug des Templates zur Darstellung eines Eintrages. Hier werden auch alle CSS Klassen definiert mit denen wir dann die Darstellung nach unseren Wünschen anpassen können. Alle anderen Templates sind nach dem gleichen Prinzip aufgebaut.

8 8 Ein Gästebuch mit XML, XPATH, DOM und PHP Datenverarbeitung Hier ist das eigentliche Kernstück der Anwendung. Die Klasse XMLGB_XMLGuestbookDataMapper kümmert sich um das Laden, manipulieren und speichern der Daten in XML. Ich werde hier Stück für Stück die einzelnen Methoden erläutern. Als erstes definieren wir unsere Klassen und deren Mitglieder. Diese Klasse wird nach dem Singleton Pattern erstellt. Das bedeutet es steht immer nur eine Instanz der Klasse zur Verfügung. In PHP kann das nur zum Teil umgesetzt werden, da PHP ja nach Abarbeitung des Scripts (Klassen, Funktionen, ) den internen Speicher wieder frei gibt. Wenn wir aber innerhalb eines Scripts mehrmals die Klasse benötigen dann verweisen wir immer auf dieselbe Instanz der Klasse. Für die Speicherung der Instanz ist die private Variable $_instance zuständig. In $_entrys speichern wir später die Einträge die zur Anzeige kommen sollen. $_DOM und $_XPATH verweisen auf die jeweiligen Instanzen. Die Storage Variablen zeigen auf das Schema und die XML Datenbank. Wir belegen diese mit Standard Werten vor. Als erstes implementieren wir den Konstruktor. Da wir das Singleton Pattern einsetzen muss der Konstruktor als private definiert werden. Somit kann keine neue Instanz der Klasse über den new Operator erfolgen.

9 9 Ein Gästebuch mit XML, XPATH, DOM und PHP Als Übergabeparameter kann optional ein Pfad zu einer anderen XML Datenbank angegeben werden. Nur wenn dieser belegt ist wird diese XML Datei als Datenspeicher verwendet. Bei der Initialisierung werden ein Objekt von DOMDocument und DOMXPath den private Mitgliedern zugewiesen. Weiterhin laden wir das XML und prüfen es gegen das XSD Schema. Ist die Prüfung nicht erfolgreich erzeugen wir eine Ausnahme (Exception). Um die Klasse nutzen zu können benötigen wir eine weitere Methode zur Rückgabe einer Instanz der Klasse. Hier erzeugen wir nur eine Instanz wenn unsere interne Variable noch nicht belegt wurde. Nur mit dieser Funktion können wir später eine Referenz auf die Klasse erzeugen. Weiterhin rufen wir die Funktion zum Initialisieren der Klasse auf.

10 10 Ein Gästebuch mit XML, XPATH, DOM und PHP Die Klasse soll nach außen immer eine Array mit XMLGB_XMLGuestkookItem als Inhalt zurückgeben. Dazu benötigen wir eine Funktion die aus einer DOMNodeList, die wir bei den Abfragen mittels XPATH zurückerhalten, die Objekte erzeugt und im Array ablegt bzw. zurückgibt. Ein kleiner Trick hier ist das Zuweisen der XML Tag Werten zu den Objektmitgliedern. Wie erzeugen ein Array in denen als Schlüssel die Namen der XML Tags stehen und als Wert die Namen der Objektmitglieder. Die Vorgehensweise werde ich auch in abgewandelter Form in einem Tutorial (MVC im Eigenbau) zum Mappen von Daten zwischen Datenbank und Anwendungslogik vorstellen. In einer Schleife überprüfen wir nun ob der XML Tag als Objektmitglied existiert und wenn ja weisen wir den Wert der Objektvariablen zu. Die Schreibweise $GBItem->$_member = ist eine sehr gute Möglichkeit dynamisch Werte von Objektmitglieder zu belegen. Diese Funktionalität vermisse ich bei manch anderen Sprachen. Ebenso wie wir XML zu XMLGB_XMLGuestkookItem Objekten wandeln benötigen wir den Weg anders herum. Also XMLGB_XMLGuestkookItem zu XML Elementen. Dafür erstellen wir wider eine private Funktion welche diese Wandlung vornimmt. Als Parameter der Funktion erwarten wir eine Instanz eines XMLGB_XMLGuestkookItem Objektes. Nachfolgend ein Auszug der Funktion in der wir mit Hilfe der Funktion DOM::createElement(ElementName, Wert) die jeweiligen XML Elemente erzeugen und später dem Root Element entry mittels $_Entry->appendChild anhängen. Zu beachten ist dass wir für die Elemente Text und Kommentar einen CDATA Knoten erzeugen und dem eigentlichen Element als Kindelement zuweisen. Hier einmal beispielhaft für den Text im Gästebucheintrag.

11 11 Ein Gästebuch mit XML, XPATH, DOM und PHP

12 12 Ein Gästebuch mit XML, XPATH, DOM und PHP Jetzt können wir uns den eigentlichen Funktionalitäten widmen. All diese Funktionen nutzen als Abfragesprache XPATH. Um eine Einführung in XPATH zu erhalten empfehle ich - oder - Als erstes eine Funktion zum Ermitteln der Gesamtanzahl der Einträge. Hier verwenden wir evaluate, um auf das Ergebnis der Abfrage zurückgreifen zu können. Nun eine zur Rückgabe eines einzelnen Elementes anhand seiner ID. Hier unterscheiden wir zusätzlich ob wir ein XMLGB_XMLGuestkookItem Objekt oder ein DomElement zurückerhalten wollen. Diese Funktion nutzen wir um einen Kommentar an den Eintrag anzuhängen.

13 13 Ein Gästebuch mit XML, XPATH, DOM und PHP Jetzt eine Funktion um nur bestimmte Elemente zurückzuliefern. Diese werden wir hauptsächlich in der Anzeige der Einträge verwenden in der wir Seitenweise durch die Einträge navigieren. Die Funktionen zum Hinzufügen erwartet als Übergabeparameter ein gefülltes XMLGB_XMLGuestkookItem Objekt. Zu beachten ist hier dass wir prüfen müssen ob schon Einträge vorhanden sind. Wenn nein fügen wir dem Knoten <entrys> das Element zu. Sonst hängen wir das Element immer an den Anfang der XML Datei (neustes zuerst). Dazu benötigen wir erst die Funktion die uns das erste Element liefert.

14 14 Ein Gästebuch mit XML, XPATH, DOM und PHP Um ein Element zu entfernen erstellen wir folgende Funktion. Ein Entfernen eines Knotens erfolgt immer von seinem Vaterknoten(parentNode) aus.

15 15 Ein Gästebuch mit XML, XPATH, DOM und PHP Und zum Abschluss die Funktion zum Hinzufügen eines Kommentares zu einem Eintrag.

16 16 Ein Gästebuch mit XML, XPATH, DOM und PHP Helfer Einen Helfer, die Exception Klasse, haben wir ja schon in der vorangehenden Klasse verwendet. Diese dient zur Reaktion auf fehlerhafte Übergaben oder Pfade in unserer Anwendung und wird im Fehlerfall geworfen. Die Klasse wird von der Basisklasse Exception abgeleitet. Ein weiterer Helfer ist die Klasse XMLGB_XMLGuestbookFactory. Diese lädt die Konfigurationsdatei und erstellt je nach Kommando, welches als GET Parameter übergeben wurde, die erforderlichen Klassen zum Laden und zur Anzeige der Einträge. Die entscheidende Funktion ist die show Funktion die entweder ein Formular zum Eintragen eines Eintrages oder die Einträge an sich anzeigt. Der Parameter $Modify entscheidet welches Template (anzeigen, bearbeiten) herangezogen werden soll. Die Helferklasse XMLGB_XMLGuestbookRequestHandler kümmert sich in der Funktion handle um die Abarbeitung von POST Kommandos. Also Eintrag hinzufügen, löschen oder einen Kommentar anhängen. Hier ein Auszug:

17 17 Ein Gästebuch mit XML, XPATH, DOM und PHP Um flexible auf Anforderungen reagieren zu können setzen wir eine Konfigurationsdatei ein. Diese wird nach dem ini Schema gestaltet und von der Klasse XMLGB_XMLGuestbookFactory geladen und ausgewertet. Hier können wir die Templates für Anzeige und Modifikation der Einträge festlegen, den Pfad zur Datenbank angeben sowie die Anzahl der anzuzeigenden Einträge pro Seite einstellen.

18 18 Ein Gästebuch mit XML, XPATH, DOM und PHP Zum Schluss brauchen wir noch eine Seite index.php auf der wir das Gästebuch anzeigen wollen. In dieser Datei erstellen wir Links zum Bearbeiten, Hinzufügen und Anzeigen des Gästebuches. Wir müssen lediglich den Pfad und den Namen der ausführbaren Datei (index.php) an die Factory Klasse übergeben. Dem Handler übergeben wir eine Referenz der Factory und die POST und GET Arrays. Im handleresult erhalten wir Erfolgs oder Fehlnachrichten. Was ich hier vernachlässigt habe ist die Autorisierung eines Administrators. Diese kann von euch relativ einfach eingebaut werden. Eine Funktion zum Prüfen der Daten (Name und Kennwort) die Faktory Klasse ($GB->isAdmin(Name, Kennwort)) ebenfalls zur Verfügung. Was könnte man verbessern Eine kleine ToDo List kann man schon anlegen. Hier wäre zu erwähnen: - Ausgliederung von Texten des Handlers in eine separate Konfigurationsdatei - Hinzufügen mehrere Kommentare vom Administrator - Hinzufügen von Kommentaren von Nutzern (aber das würde eine Gästebuch Funktionalität schon überschreiten) - Zulassen von BB Codes - Fazit Auch mit XML und XPATH kann man komfortable Funktionalitäten abbilden. Was noch zu testen wäre ist das Gesamtverhalten bei vielen Einträgen. Mit Hilfe der Objektorientireung konnten wir uns auf die einzelnen Funktionalitäten konzentrieren und können Verbesserungen einfacher implementieren.