Generando documento XML en PHP (caracteres de escape)

Question

Estoy generando un documento XML a partir de un script PHP y necesito escapar de los caracteres especiales XML. Conozco la lista de caracteres que deberían escaparse; pero, ¿cuál es la forma correcta de hacerlo?

¿Se deben escapar los caracteres solo con barra invertida (\ ') o cuál es la forma correcta? ¿Hay alguna función PHP incorporada que pueda manejar esto por mí?

Answer 1

Utilice los DOM clases para generar todo el código XML documento. Manejará codificaciones y decodings que ni siquiera queremos preocuparnos.

---

Editar: Este fue criticada por @Tchalvak:

El objeto DOM crea un documento XML completo, no se presta fácilmente a poco se codifica una cadena por sí mismo.

que está mal, DOMDocument puede adecuadamente salida sólo un fragmento no todo el documento:

$doc->saveXML($fragment); 

lo que da:

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

como en:

$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); 

Ver Demo

Answer 2

Puede utilizar estos métodos: http://php.net/manual/en/function.htmlentities.php

de esa manera se escapan todas las entidades (HTML/XML) y usted puede poner su cadena dentro de las etiquetas XML

Answer 3

I creados función simple que escapa con el five "predefined entities" que están en XML:

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

Ejemplo de uso Demo:

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

de salida:

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

Un efecto similar puede lograrse usando str_replace pero es frágil debido a doble-replacings (no probado, no se recomienda):

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

Answer 4

se esforzó para hacer frente a problema de entidad XML, resolver de esta manera:

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

Answer 5

¿Qué pasa con la función htmlspecialchars()?

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

Nota: la bandera ENT_XML1 sólo está disponible si tiene PHP 5.4.0 o superior.

htmlspecialchars() con estos parámetros sustituye a los siguientes caracteres:

• & (signo) se convierte en &
• " (comillas dobles) se convierte en "
• ' (comilla simple) se convierte en '
• < (menos de) se convierte en <
• > (mayor que) se convierte en >

, usted puede obtener la tabla de traducción mediante el uso de la función get_html_translation_table().

Answer 6

Para tener un texto XML final válido, debe escapar de todas las entidades XML y tener el texto escrito en la misma codificación que el documento XML-instruction instructions (la "codificación" en la línea <?xml). Los caracteres acentuados no necesitan escaparse mientras estén codificados como el documento.

Sin embargo, en muchas situaciones, simplemente escapar de la entrada con htmlspecialchars puede conducir a doble codificado entidades (por ejemplo é se convertiría en é), por lo que sugiero entidades html decodificación primera:

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

A continuación, debe asegúrese de que todos los caracteres acentuados sean válidos en la codificación del documento XML. Recomiendo encarecidamente codificar siempre la salida XML en UTF-8, ya que no todos los analizadores XML respetan la codificación de instrucciones de procesamiento de documentos XML. Si su entrada puede provenir de un juego de caracteres diferente, intente con utf8_encode().

Hay un caso especial, que es su entrada puede venir de una de estas codificaciones: ISO-8859-1, ISO-8859-15, UTF-8, cp866, cp1251, cp1252 y KOI8-R - PHP los trata de todos modos, pero hay algunas pequeñas diferencias en ellos, algunos de los cuales incluso iconv() no pueden manejar. Sólo podía resolver este problema codificación complementando utf8_encode() comportamiento:

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

Si necesita una salida XML adecuado, simplexml es el camino a seguir:

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

Answer 8

escape adecuada es la manera de conseguir correcta XML de salida, pero necesita manejar escapando de manera diferente para atributos y elementos. (Esa es la respuesta de Tomás es incorrecta).

Escribí/robé unos Java code hace un tiempo que diferencia entre el atributo y el elemento que se escapa. La razón es que el analizador XML considera todo el espacio en blanco especial, en particular en los atributos.

Debe ser trivial trasladar eso a PHP (puede usar el enfoque de Tomás Jancik con el escape apropiado anterior). No tiene que preocuparse por escapar de entidades extendidas si usa UTF-8.

Si no desea portar mi código Java, puede mirar XMLWriter que se basa en la transmisión y usa libxml, por lo que debería ser muy eficiente.

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

Sobre la base de la solución de sadeghj el siguiente código trabajó para mí:

/** 
* @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; 
}