在PHP中生成XML文档（转义字符）

Question

我从PHP脚本生成XML文档，我需要转义XML特殊字符。 我知道应该逃避的字符列表;但是做到这一点的正确方法是什么？

字符是否应该用反斜杠（\'）转义或者正确的方式是什么？ 是否有任何内置的PHP函数可以为我处理？

Answer 1

使用DOM类来生成你的整个XML文件。它将处理我们甚至不想关心的编码和解码。

---

编辑：这是批评@Tchalvak：

的DOM对象创建一个完整的XML文档，它不轻易出借自己刚刚编码它自己的字符串。

哪项是错误的，DOM文档可以正常输出只是一个片段，而不是整个文件：

$doc->saveXML($fragment); 

这给：

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

为：

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

// adding XML verbatim: 
$xml = "Test &amp; <b> and encode </b> :)\n"; 
$fragment->appendXML($xml); 

// adding text: 
$text = $xml; 
$fragment->appendChild($doc->createTextNode($text)); 

// output the result 
echo $doc->saveXML($fragment); 

见Demo

Answer 2

您可以使用此方法： http://php.net/manual/en/function.htmlentities.php

这样一来所有的实体（HTML/XML）被转义，并且你可以把你的字符串XML标签内

Answer 3

我创建简单的函数，与five "predefined entities"是在XML逸出：

function xml_entities($string) { 
    return strtr(
     $string, 
     array(
      "<" => "&lt;", 
      ">" => "&gt;", 
      '"' => "&quot;", 
      "'" => "&apos;", 
      "&" => "&amp;", 
     ) 
    ); 
} 

用法例子Demo：

$text = "Test &amp; <b> and encode </b> :)"; 
echo xml_entities($text); 

输出：

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

类似的效果，可以实现通过使用str_replace，但它是脆弱的，因为双重替换（未经测试，不推荐）：

function xml_entities($string) { 
    return str_replace(
     array("&",  "<", ">", '"',  "'"), 
     array("&amp;", "&lt;", "&gt;", "&quot;", "&apos;"), 
     $string 
    ); 
} 

Answer 4

努力地处理XML实体问题，解决了这种方式：

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

Answer 5

怎么样htmlspecialchars()功能？

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

注：如果您对PHP 5.4.0或更高版本的ENT_XML1标志才可用。

htmlspecialchars()与这些参数替换下列字符：

• &（符号）变成&
• "（双引号）变得"
• '（单引号）变得'
• <（小于）变成<
• >（大于）成为>

您可以通过使用get_html_translation_table()功能得到转换表。

Answer 6

为了有一个有效的最终XML文本，您需要转义所有XML实体，并使用与XML文档处理指令相同的编码（<?xml行中的“编码”）来编写文本。只要将重音字符编码为文档，则不需要转义字符。

然而，在许多情况下，简单地逃脱输入与htmlspecialchars可能会导致双编码实体（例如é将成为é），所以我首先建议解码HTML实体：

function xml_escape($s) 
{ 
    $s = html_entity_decode($s, ENT_QUOTES, 'UTF-8'); 
    $s = htmlspecialchars($s, ENT_QUOTES, 'UTF-8', false); 
    return $s; 
} 

现在，您需要确保所有重音字符在XML文档编码中都是有效的。我强烈建议始终使用UTF-8编码XML输出，因为并非所有XML解析器都遵守XML文档处理指令编码。如果您的输入可能来自不同的字符集，请尝试使用utf8_encode()。

有一种特殊情况，您的输入可能来自以下编码之一：ISO-8859-1，ISO-8859-15，UTF-8，cp866，cp1251，cp1252和KOI8-R - PHP对待他们都是一样的，但是他们之间有一些细微的差异 - 其中一些甚至不能处理iconv()。

function encode_utf8($s) 
{ 
    $cp1252_map = array(
    "\xc2\x80" => "\xe2\x82\xac", 
    "\xc2\x82" => "\xe2\x80\x9a", 
    "\xc2\x83" => "\xc6\x92", 
    "\xc2\x84" => "\xe2\x80\x9e", 
    "\xc2\x85" => "\xe2\x80\xa6", 
    "\xc2\x86" => "\xe2\x80\xa0", 
    "\xc2\x87" => "\xe2\x80\xa1", 
    "\xc2\x88" => "\xcb\x86", 
    "\xc2\x89" => "\xe2\x80\xb0", 
    "\xc2\x8a" => "\xc5\xa0", 
    "\xc2\x8b" => "\xe2\x80\xb9", 
    "\xc2\x8c" => "\xc5\x92", 
    "\xc2\x8e" => "\xc5\xbd", 
    "\xc2\x91" => "\xe2\x80\x98", 
    "\xc2\x92" => "\xe2\x80\x99", 
    "\xc2\x93" => "\xe2\x80\x9c", 
    "\xc2\x94" => "\xe2\x80\x9d", 
    "\xc2\x95" => "\xe2\x80\xa2", 
    "\xc2\x96" => "\xe2\x80\x93", 
    "\xc2\x97" => "\xe2\x80\x94", 
    "\xc2\x98" => "\xcb\x9c", 
    "\xc2\x99" => "\xe2\x84\xa2", 
    "\xc2\x9a" => "\xc5\xa1", 
    "\xc2\x9b" => "\xe2\x80\xba", 
    "\xc2\x9c" => "\xc5\x93", 
    "\xc2\x9e" => "\xc5\xbe", 
    "\xc2\x9f" => "\xc5\xb8" 
    ); 
    $s=strtr(utf8_encode($s), $cp1252_map); 
    return $s; 
} 

Answer 7

如果您需要正确的XML输出，simplexml的是要走的路：

http://www.php.net/manual/en/simplexmlelement.asxml.php

Answer 8

正确的转义得到正确的方式，我只能通过补充utf8_encode()行为来解决这个编码问题XML输出但您需要以不同方式处理转义对于属性和元素。 （这是托马斯的回答不正确）。

我写/偷了一些​​一段时间后，区分属性和元素转义。原因在于XML解析器认为所有的空白空间都是特别特殊的。

将它移植到PHP应该很简单（可以使用Tomas Jancik的方法进行上述适当的转义）。如果您使用UTF-8，则不必担心转义扩展实体。

如果您不想移植我的Java代码，您可以查看基于流的XMLWriter，并使用libxml，因此它应该非常高效。

Answer 9

function replace_char($arr1) 
{ 
    $arr[]=preg_replace('>','&gt', $arr1); 
    $arr[]=preg_replace('<','&lt', $arr1); 
    $arr[]=preg_replace('"','&quot', $arr1); 
    $arr[]=preg_replace('\'','&apos', $arr1); 
    $arr[]=preg_replace('&','&amp', $arr1); 

    return $arr; 
    }  

Answer 10

基于sadeghj下面的代码的解决方案为我：

/** 
* @param $arr1 the single string that shall be masked 
* @return the resulting string with the masked characters 
*/ 
function replace_char($arr1) 
{ 
    if (strpos ($arr1,'&')!== FALSE) { //test if the character appears 
     $arr1=preg_replace('/&/','&', $arr1); // do this first 
    } 

    // just encode the 
    if (strpos ($arr1,'>')!== FALSE) { 
     $arr1=preg_replace('/>/','>', $arr1); 
    } 
    if (strpos ($arr1,'<')!== FALSE) { 
     $arr1=preg_replace('/</','&lt;', $arr1); 
    } 

    if (strpos ($arr1,'"')!== FALSE) { 
     $arr1=preg_replace('/"/','&quot;', $arr1); 
    } 

    if (strpos ($arr1,'\'')!== FALSE) { 
     $arr1=preg_replace('/\'/','&apos;', $arr1); 
    } 

    return $arr1; 
}