Skip to content

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]:

1
2
3
4
scripts-console/xml
├── data.xml
├── dom-01.php
└── simplexml-01.php

21.1. Das betrachtete Dokument

Wir betrachten die folgende XML-Datei [data.xml]:

<?xml version="1.0" encoding="UTF-8"?>

<tribe>
    <teacher>
        <person gender="M">
            <lastName>dupont</lastName>
            <firstName>jean</firstName>
            <age>28</age>
            this is a comment
        </person>
        <section>27</section>
    </teacher>
    <student>
        <person gender="F">
            <lastName>martin</lastName>
            <firstName>charline</firstName>
            <age>22</age>
        </person>
        <course>dess IAIE</course>
    </student>
</tribe>

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]:

<?php

declare(strict_types=1);

// die zu verwendende XML-Datei
const FILE_NAME = "data.xml";

// Laden des XML-Dokuments
$xml = simplexml_load_file(FILE_NAME);
if ($xml === false) {
    print "The file [" . FILE_NAME . "] could not be used\n";
    exit(1);
}
// Anzeige des Dokuments
print_r($xml);
// das Attribut [gender] der lehrenden Person
print_r($xml->teacher->person['gender']);
// Werte von Elementen und Attributen, in Strings umgewandelt
$lastName = (string) $xml->teacher->person->lastName;
print "lastName=$lastName\n";
$gender = (string) $xml->teacher->person['gender'];
print "gender=$gender\n";
$course = (string) $xml->student->course;
print "course=$course\n";
// Existenz eines Elements
print "isset(lastName)=" . var_export(isset($xml->teacher->person->lastName), true) . "\n";
print "isset(xx)=" . var_export(isset($xml->teacher->person->xx), true) . "\n";
// eine Umwandlung in eine ganze Zahl
$age = (int) $xml->student->person->age;
print "age of the student=$age\n";
// Iteration über alle <person>-Elemente des Dokuments mit XPath
foreach ($xml->xpath('//person') as $person) {
    print "person: {$person->firstName} {$person->lastName} ({$person['gender']})\n";
}

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

> php simplexml-01.php
SimpleXMLElement Object
(
    [teacher] => SimpleXMLElement Object
        (
            [person] => SimpleXMLElement Object
                (
                    [@attributes] => Array
                        (
                            [gender] => M
                        )

                    [lastName] => dupont
                    [firstName] => jean
                    [age] => 28
                )

            [section] => 27
        )

    [student] => SimpleXMLElement Object
        (
            [person] => SimpleXMLElement Object
                (
                    [@attributes] => Array
                        (
                            [gender] => F
                        )

                    [lastName] => martin
                    [firstName] => charline
                    [age] => 22
                )

            [course] => dess IAIE
        )

)
SimpleXMLElement Object
(
    [0] => M
)
lastName=dupont
gender=M
course=dess IAIE
isset(lastName)=true
isset(xx)=false
age of the student=22
person: jean dupont (M)
person: charline martin (F)
  • 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:

<?php

declare(strict_types=1);

// dasselbe Dokument, verwendet mit der neuen DOM-API von PHP 8.4

use Dom\XMLDocument;

// die zu verwendende XML-Datei
const FILE_NAME = "data.xml";

try {
    // Laden des XML-Dokuments
    $document = XMLDocument::createFromFile(FILE_NAME);
} catch (Throwable $ex) {
    print "The file [" . FILE_NAME . "] could not be used: {$ex->getMessage()}\n";
    exit(1);
}
// das Wurzelelement
print "root=" . $document->documentElement->tagName . "\n";
// die 1. lehrende Person, gefunden mit einem CSS-Selektor
$person = $document->querySelector('teacher > person');
print "lastName=" . $person->querySelector('lastName')->textContent . "\n";
print "gender=" . $person->getAttribute('gender') . "\n";
print "course=" . $document->querySelector('student > course')->textContent . "\n";
// ein fehlendes Element: querySelector gibt null zurück
print "xx exists=" . var_export($person->querySelector('xx') !== null, true) . "\n";
// alle Personen des Dokuments
foreach ($document->querySelectorAll('person') as $person) {
    // der Nullsafe-Operator ?-> schützt vor einem fehlenden Element
    $firstName = $person->querySelector('firstName')?->textContent ?? '?';
    $lastName = $person->querySelector('lastName')?->textContent ?? '?';
    print "person: $firstName $lastName ({$person->getAttribute('gender')})\n";
}
// Ändern des Dokuments: wir ändern den Inhalt des Elements <section> des Lehrenden
$section = $document->querySelector('teacher > section');
$section->textContent = "26";
// das geänderte Dokument als XML-Text
print $document->saveXml($document->querySelector('teacher')) . "\n";

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

> php dom-01.php
root=tribe
lastName=dupont
gender=M
course=dess IAIE
xx exists=false
person: jean dupont (M)
person: charline martin (F)
<teacher>
        <person gender="M">
            <lastName>dupont</lastName>
            <firstName>jean</firstName>
            <age>28</age>
            this is a comment
        </person>
        <section>26</section>
    </teacher>
  • 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.