21. XML-Dokumente verarbeiten
Die bisher geschriebenen Webservices tauschen JSON-Daten aus. XML (eXtensible Markup Language) war lange das am weitesten verbreitete Austauschformat und begegnet uns noch häufig: SOAP-Webservices, RSS-Feeds, Konfigurationsdateien, Office-Dokumente (eine [.odt]- oder [.docx]-Datei ist ein Archiv aus XML-Dateien). PHP stellt zwei APIs für die Arbeit damit bereit:
- [SimpleXML]: eine sehr einfache API, bei der die Elemente des Dokuments zu Objekteigenschaften werden;
- [DOM] (Document Object Model): die Standard-API des W3C, die umfassender ist und auch das Ändern eines Dokuments erlaubt. PHP 8.4 hat eine neue Version im Namespace [Dom] eingeführt, die dem aktuellen Webstandard entspricht.
Die Skripte dieses Kapitels befinden sich im Ordner [scripts-console/xml]:
21.1. Das betrachtete Dokument
Wir betrachten die folgende XML-Datei [data.xml]:
Ein XML-Dokument ist ein Baum aus Elementen:
- Zeile 1: der Prolog, der die XML-Version und die Zeichencodierung des Dokuments angibt;
- Zeilen 3–21: das Wurzelelement [tribe]. Ein XML-Dokument hat genau eine Wurzel;
- Zeilen 4–12: das Element [teacher], ein Kind von [tribe]. Es hat zwei Kinder, [person] und [section];
- Zeile 5: Das Element [person] hat ein Attribut [gender] mit dem Wert [M];
- Zeile 9: Ein Element kann sowohl andere Elemente als auch Text enthalten;
- Zeilen 13–20: das Element [student], das dieselbe Struktur hat wie [teacher].
21.2. Verarbeitung mit SimpleXML
Wir analysieren dieses Dokument mit dem folgenden Skript [simplexml-01.php]:
Anmerkungen
- Zeile 6: Der XML-Dateiname ist eine Konstante. Das Skript wird in seinem eigenen Ordner ausgeführt, dem von [data.xml];
- Zeile 9: Die Funktion [simplexml_load_file] lädt das Dokument und gibt ein Objekt vom Typ [SimpleXMLElement], zurück, das das Wurzelelement [tribe] darstellt. Im Fehlerfall (fehlende Datei, fehlerhaftes XML) gibt sie [false] zurück, was wir in Zeile 10 prüfen;
- Zeile 15: Anzeige des Dokuments. [print_r] zeigt, wie [SimpleXML] den XML-Baum sieht;
- Zeile 17: Auf Kindelemente wird wie auf Eigenschaften zugegriffen ([$xml->teacher->person]), auf Attribute wie auf Array-Schlüssel ([['gender']]). Beachten Sie, dass die Wurzel [tribe] im Code nicht vorkommt: [$xml] ist bereits dieses Element;
- Zeile 19: [$xml->teacher->person->lastName] ist kein String, sondern ein Objekt [SimpleXMLElement]. Die Umwandlung mit [(string)] liefert dessen Text. Mit [declare(strict_types=1)] führt man diese Umwandlung am besten explizit durch, bevor man den Wert an eine Funktion übergibt, die einen String erwartet;
- Zeile 21: der Wert des Attributs [gender];
- Zeilen 26–27: [isset] stellt fest, ob ein Element existiert. Das PHP-7-Skript gab das Boolesche Ergebnis mit [print] aus, das [1] für [true] und einen leeren String für [false] liefert. Wir verwenden [var_export], das [true] oder [false] anzeigt;
- Zeile 29: Die Umwandlung [(int)] liefert den ganzzahligen Wert des Elementtextes;
- Zeile 32: Die Methode [xpath] wertet einen XPath-Ausdruck aus. Der Ausdruck [//person] bezeichnet alle [person]-Elemente im Dokument, unabhängig von ihrer Ebene. Das Ergebnis ist ein Array aus [SimpleXMLElement]-Objekten.
Konsolenausgabe
- Zeilen 2–38: das XML-Dokument in Form eines Objekts [SimpleXMLElement]. Beachten Sie, dass der Text [this is a comment] nicht erscheint: [print_r] zeigt nur die Elemente und Attribute;
- Zeilen 39–42: Auch ein Attribut ist ein Objekt [SimpleXMLElement];
- Zeilen 43–48: die aus dem Dokument gelesenen Werte;
- Zeilen 49–50: der XPath-Durchlauf der beiden Personen.
21.3. Verarbeitung mit der neuen DOM-API aus PHP 8.4
Ab PHP 8.4 bietet der Namespace [Dom] eine neue DOM-API: die Klasse [Dom\XMLDocument] für XML-Dokumente und die Klasse [Dom\HTMLDocument] für HTML5-Dokumente. Sie ist ein besserer Ersatz für die alte Klasse [DOMDocument] (die weiterhin verfügbar ist): Sie entspricht dem aktuellen DOM-Standard und stellt die Methoden [querySelector] und [querySelectorAll] bereit, die JavaScript-Entwicklern vertraut sind. Mit diesen Methoden lassen sich Elemente über CSS-Selektoren suchen.
Das Skript [dom-01.php] verwendet dasselbe Dokument:
Anmerkungen
- Zeile 7: die Klasse [XMLDocument] im Namespace [Dom];
- Zeile 14: Die statische Methode [createFromFile] lädt das Dokument. Anders als [simplexml_load_file] löst sie bei einem Fehler eine Ausnahme aus;
- Zeile 20: Die Eigenschaft [documentElement] ist das Wurzelelement; [tagName] ist sein Name;
- Zeile 22: Der CSS-Selektor [teacher > person] bezeichnet ein Element [person], das ein direktes Kind eines Elements [teacher] ist. [querySelector] gibt das erste passende Element zurück oder [null] , falls es keines gibt;
- Zeile 23: Die Eigenschaft [textContent] ist der im Element enthaltene Text;
- Zeile 24: der Wert eines Attributs;
- Zeile 27: Ein fehlendes Element liefert [null];
- Zeile 29: alle Elemente [person] im Dokument;
- Zeile 31: Würde das Element [firstName] fehlen, ergäbe [querySelector('firstName')] den Wert [null]. Der Null-Safe-Operator [?->] (PHP 8.0) gibt dann [null] zurück, statt einen Fehler zu verursachen, und der Operator [??] ersetzt dieses [null] durch ['?'];
- Zeile 37: Die DOM-API erlaubt auch, das Dokument zu ändern: Hier wird der Text des Elements [section] geändert;
- Zeile 39: [saveXml] gibt den XML-Text des Dokuments zurück oder den eines seiner Elemente, wenn dieses als Parameter übergeben wird.
Konsolenausgabe
- Zeile 16: die vom Skript vorgenommene Änderung.
Diese beiden Beispiele zeigen nicht alle Möglichkeiten von [SimpleXML] und [DOM], aber sie genügen, um eine neue Version der Übungsanwendung zu schreiben. Die Dokumentation von PHP beschreibt sie ausführlich: SimpleXML und DOM.