在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; 
}