Generierung von XML-Dokument in PHP (Sonderzeichen entkommen)

Question

Ich erstelle ein XML-Dokument aus einem PHP-Skript und muss die XML-Sonderzeichen escapen. Ich kenne die Liste der Zeichen, die escaped werden sollten; aber wie mache ich das korrekt?

Sollen die Zeichen einfach nur mit einem Backslash (\) escaped werden oder was ist der richtige Weg? Gibt es eine eingebaute PHP-Funktion, die das für mich erledigen kann?

Answer 1

Ich habe eine einfache Funktion erstellt, die mit den fünf "vordefinierten Entitäten" umgeht, die in XML enthalten sind:

function xml_entities($string) {
    return strtr(
        $string, 
        array(
            "<" => "<",
            ">" => ">",
            '"' => """,
            "'" => "'",
            "&" => "&",
        )
    );
}

Verwendungsbeispiel Demo:

$text = "Test &  and encode  :)";
echo xml_entities($text);

Ausgabe:

Test &amp; <b> and encode </b> :)

Ein ähnlicher Effekt kann durch Verwendung von str_replace erzielt werden, aber es ist anfällig für doppelte Ersetzungen (nicht getestet, nicht empfohlen):

function xml_entities($string) {
    return str_replace(
        array("&",     "<",    ">",    '"',      "'"),
        array("&", "<", ">", """, "'"), 
        $string
    );
}

Answer 2

Verwenden Sie die DOM-Klassen, um Ihr gesamtes XML-Dokument zu generieren. Es kümmert sich um Codierungen und Dekodierungen, um die wir uns nicht einmal kümmern wollen.

---

Bearbeitung: Dies wurde von @Tchalvak kritisiert:

Das DOM-Objekt erstellt ein vollständiges XML-Dokument, es lässt sich nicht so einfach darauf beschränken, nur einen String zu codieren.

Was falsch ist, DOMDocument kann problemlos nur ein Fragment richtig ausgeben:

$doc->saveXML($fragment);

was folgendes ergibt:

Test &  and encode  :)
Test &amp; <b> and encode </b> :)

wie folgt:

$doc = new DOMDocument();
$fragment = $doc->createDocumentFragment();

// XML wörtlich hinzufügen:
$xml = "Test &  and encode  :)\n";
$fragment->appendXML($xml);

// Text hinzufügen:
$text = $xml;
$fragment->appendChild($doc->createTextNode($text));

// das Ergebnis ausgeben
echo $doc->saveXML($fragment);

Siehe Demo

Answer 3

Was ist mit der htmlspecialchars() Funktion?

htmlspecialchars($input, ENT_QUOTES | ENT_XML1, $encoding);

Hinweis: das ENT_XML1 Flag ist nur verfügbar, wenn Sie PHP 5.4.0 oder höher haben.

htmlspecialchars() mit diesen Parametern ersetzt die folgenden Zeichen:

• & (kaufmännisches Und) wird zu &
• " (Anführungszeichen) wird zu "
• ' (Einfache Anführungszeichen) wird zu '
• < (kleiner als) wird zu <
• > (größer als) wird zu >

Sie können die Übersetzungstabelle mit der get_html_translation_table() Funktion erhalten.

Answer 4

Habe versucht, das Problem mit XML-Entitäten zu lösen, auf diese Weise gelöst:

htmlspecialchars($Wert, ENT_QUOTES, 'UTF-8')

Answer 5

Richtige Escapen ist der richtige Weg, um korrekte XML-Ausgabe zu erzielen, aber Sie müssen das Escapen unterschiedlich für Attribute und Elemente behandeln. (Das ist Tomas' Antwort ist falsch).

Ich habe / gestohlen vor einer Weile Java-Code geschrieben, der zwischen Attribut- und Element-Escapen unterscheidet. Der Grund dafür ist, dass der XML-Parser jede Leerstelle insbesondere in Attributen als speziell betrachtet.

Es sollte trivial sein, das auf PHP zu portieren (Sie können Tomas Janciks Ansatz mit dem obigen entsprechenden Escapen verwenden). Sie müssen sich keine Sorgen um das Escapen erweiterter Entitäten machen, wenn Sie UTF-8 verwenden.

Wenn Sie meinen Java-Code nicht portieren möchten, können Sie sich XMLWriter anschauen, das strombasiert ist und libxml verwendet, sodass es sehr effizient sein sollte.