In den folgenden Abschnitten wird nun beschrieben, wie XML mit PHP verarbeitbar wird. Dafür existieren innerhalb von PHP mehrere Technologien. Generell lässt sich zwischen zwei großen Möglichkeiten des Parsens unterscheiden:
- Einmal ist es möglich, die XML-Datei an einem Stück einzulesen. Erkennt der Parser dann Tags oder Text, so teilt er dies dem eigenen Code entsprechend mit. Der eigene Code ist dann dafür zuständig, die gewünschten Daten aus der XML-Datei zu sammeln und für das weitere Programm zur Verfügung zu stellen. Ist allerdings der Dateizeiger an einer Information innerhalb der XML-Datei einmal vorbei gelaufen, so wird diese Information nie wieder geliefert. Dieses sequentielle Einlesen hat den Vorteil, dass wenig Speicher gebraucht wird und auch sehr große XML-Dateien verarbeitet werden können.
- Eine andere Möglichkeit ist es, dass der Parser den Baum der XML-Datei zu Beginn komplett ließt und dann traversierbar im Speicher zur Verfügung stellt. Das klappt nur dann, wenn die XML-Datei klein genug ist, dass deren Repräsentation innerhalb des Arbeitsspeichers Platz hat. Weiterhin wird zu Beginn etwas Zeit verbraucht, ohne dass Daten verfügbar sind, da der Parser den Baum zunächst aufbauen muss. Ein großer Vorteil ist die Traversierbarkeit. So kann einfach auf Strukturinformationen zugegriffen werden.
Der Standard-XML-Parser von PHP verfolgt erste Strategie. Die XML-Datei wird sequentiell eingelesen und entsprechende Handler aufgerufen.
Damit der folgende Code ausgeführt werden kann, muss die Bibliothek LIBXML installiert sein, die allerdings standardmäßig mittlerweile mit PHP ausgeliefert wird.
Folgender PHP-Code demonstriert das sequentielle Lesen:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
<?php function startElement($parser, $tagName, $attrs) { switch($tagName) { case "SVG": echo "Bild startet: ( "; break; case "CIRCLE": echo "Kreis "; break; case "RECT": echo "Rechteck "; break; case "LINE": echo "Linie "; break; case "TEXT": echo "Text "; break; default: echo "Tag $tagName "; break; } } function endElement($parser, $tagName) { switch($tagName) { case "SVG": echo " ) Bild beendet. "; break; } } function characterData($parser, $data) { // trim() entfernt Leerzeichen zu Beginn und Ende // empty() prüft, ob es ein leerer String ist if (!empty(trim($data))) echo "Im Rumpf: $data"; } $fp = fopen("svgexample.svg","r"); $xml_parser = xml_parser_create(); xml_set_element_handler($xml_parser, "startElement", "endElement"); xml_set_character_data_handler($xml_parser, "characterData"); while ($data = fread($fp, 4096)) { $success = xml_parse($xml_parser, $data, feof($fp)); if ($success == 0) { die(sprintf("XML error: %s at line %d", xml_error_string(xml_get_error_code($xml_parser)), xml_get_current_line_number($xml_parser) )); } } fclose($fp); xml_parser_free($xml_parser); ?> |
Nachdem die XML-Datei mit fopen() geöffnet worden ist, wird der Parser mit xml_parser_create() erzeugt. Dem Parser wird mit der Funktion xml_set_element_handler() mitgeteilt, dass er bei einem Öffnungs-Tag, die weiter oben definierte Funktion startElement() aufrufen soll und bei einem Schließungs-Tag die oben definierte Funktion endElement(). Weiterhin wird ihm mit xml_set_character_data_handler() mitgeteilt, dass er die Funktion characterData() aufrufen soll, um die Rümpfe zu verarbeiten.
Innerhalb der While-Schleife wird die XML-Datei in kleinen Blöcken eingelesen und dem Parser übergeben. Hier findet auch eine Fehlerbehandlung statt, falls der Parser das eingegebene XML nicht verarbeiten kann. Beispielfehlercodes befinden sich in den Konstanten XML_ERROR_SYNTAX, XML_ERROR_INVALID_TOKEN oder XML_ERROR_UNKNOWN_ENCODING.
Zum Schluss erfolgt das Schließen der Datei und das Freigeben der Ressourcen des XML-Parsers. Dies ist wichtig, um die belegten Ressourcen im Arbeitsspeicher anderen Programmteilen zur Verfügung zu stellen und sie nicht unnötig zu belegen.
Innerhalb der beiden Funktionen startElement() und endElement() wird mit Switch-Anweisungen zwischen dem Tag-Namen unterschieden und eine entsprechende Ausgabe gemacht. Hier wäre es nun auch möglich globale Variablen zu setzen, um die Baumstruktur der XML-Datei auszuwerten. Innerhalb der Funktion characterData() wird – falls vorhanden – der Textrumpf innerhalb eines Tags ausgegeben.
Die Ausgabe des Beispiels ist nun: Bild startet: ( Kreis Linie Tag A Rechteck Text Im Rumpf: SVG ist XML ) Bild beendet.
Der Standard-XML-Parser von PHP hat weitere Besonderheiten. So ist es möglich, Namespaces aufzulösen, indem er über die alternative Funktion xml_parser_create_ns() erzeugt wird. Der Parser kann mit drei unterschiedlichen Encodings umgehen: UTF-8, US-ASCII und ISO-8859-1, wobei UTF-8 das Standardencoding darstellt. Das Encoding für die Eingabe kann bei der Initialisierung des Parsers mit übergeben werden und ist dann fix für diesen Parser. Bei der Übergabe an die vom Nutzer bereitgestellten Funktionen kann jedoch das Encoding der übergebenen Strings nochmals gewechselt werden. Dies ist jederzeit tauschbar mit der Funktion xml_parser_set_option("XML_OPTION_TARGET_ENCODING",...). Werden Zeichen gelesen, die im Encoding nicht dargestellt werden können, so erzeugen diese einen Parser-Fehler. Werden Zeichen übergeben, die nicht dargestellt werden können, so werden diese durch Fragezeichen (?) ersetzt. Weitere Optionen sind setzbar, wie das Umwandeln der Tagnamen in Großbuchstaben (XML_OPTION_CASE_FOLDING) oder das Eliminieren von White-Spaces (XML_OPTION_SKIP_WHITE).