Skip to content

21. Procesamiento de documentos XML

Los servicios web que hemos escrito hasta ahora intercambian datos JSON. XML (eXtensible Markup Language) ha sido durante mucho tiempo el formato de intercambio más utilizado y todavía se encuentra con frecuencia: servicios web SOAP, canales RSS, archivos de configuración, documentos ofimáticos (un archivo [.odt] o [.docx] es un archivo comprimido de archivos XML). PHP ofrece dos API para trabajar con él:

  • [SimpleXML]: una API muy sencilla, en la que los elementos del documento se convierten en propiedades de un objeto;
  • [DOM] (Document Object Model): la API estándar del W3C, más completa y que además permite modificar un documento. PHP 8.4 introdujo una nueva versión, en el espacio de nombres [Dom], conforme al estándar web actual.

Los scripts de este capítulo se encuentran en la carpeta [scripts-console/xml]:

1
2
3
4
scripts-console/xml
├── data.xml
├── dom-01.php
└── simplexml-01.php

21.1. El documento en estudio

Consideramos el siguiente archivo XML [data.xml]:

<?xml version="1.0" encoding="UTF-8"?>

<tribe>
    <teacher>
        <person gender="M">
            <lastName>dupont</lastName>
            <firstName>jean</firstName>
            <age>28</age>
            this is a comment
        </person>
        <section>27</section>
    </teacher>
    <student>
        <person gender="F">
            <lastName>martin</lastName>
            <firstName>charline</firstName>
            <age>22</age>
        </person>
        <course>dess IAIE</course>
    </student>
</tribe>

Un documento XML es un árbol de elementos:

  • línea 1: el prólogo, que especifica la versión de XML y la codificación de caracteres del documento;
  • líneas 3–21: el elemento raíz [tribe]. Un documento XML tiene exactamente una raíz;
  • líneas 4–12: el elemento [teacher], hijo de [tribe]. Tiene dos hijos, [person] y [section];
  • línea 5: el elemento [person] tiene un atributo [gender] con el valor [M];
  • línea 9: un elemento puede contener tanto otros elementos como texto;
  • líneas 13–20: el elemento [student], que tiene la misma estructura que [teacher].

21.2. Procesamiento con SimpleXML

Analizamos este documento con el siguiente script [simplexml-01.php]:

<?php

declare(strict_types=1);

// el archivo XML que se usará
const FILE_NAME = "data.xml";

// carga del documento XML
$xml = simplexml_load_file(FILE_NAME);
if ($xml === false) {
    print "The file [" . FILE_NAME . "] could not be used\n";
    exit(1);
}
// visualización del documento
print_r($xml);
// el atributo [gender] de la persona docente
print_r($xml->teacher->person['gender']);
// valores de elementos y atributos, convertidos en cadenas
$lastName = (string) $xml->teacher->person->lastName;
print "lastName=$lastName\n";
$gender = (string) $xml->teacher->person['gender'];
print "gender=$gender\n";
$course = (string) $xml->student->course;
print "course=$course\n";
// existencia de un elemento
print "isset(lastName)=" . var_export(isset($xml->teacher->person->lastName), true) . "\n";
print "isset(xx)=" . var_export(isset($xml->teacher->person->xx), true) . "\n";
// una conversión a entero
$age = (int) $xml->student->person->age;
print "age of the student=$age\n";
// iteración sobre todos los elementos <person> del documento con XPath
foreach ($xml->xpath('//person') as $person) {
    print "person: {$person->firstName} {$person->lastName} ({$person['gender']})\n";
}

Comentarios

  • línea 6: el nombre del archivo XML es una constante. El script se ejecuta en su propia carpeta, la de [data.xml];
  • Línea 9: la función [simplexml_load_file] carga el documento y devuelve un objeto de tipo [SimpleXMLElement], que representa el elemento raíz [tribe]. En caso de error (archivo inexistente, XML mal formado), devuelve [false], lo que verificamos en la línea 10;
  • línea 15: visualización del documento. [print_r] muestra cómo [SimpleXML] ve el árbol XML;
  • línea 17: se accede a los elementos hijos como propiedades ([$xml->teacher->person]) y a los atributos como claves de un arreglo ([['gender']]). Observe que la raíz [tribe] no aparece en el código: [$xml] ya es ese elemento;
  • línea 19: [$xml->teacher->person->lastName] no es una cadena sino un objeto [SimpleXMLElement]. La conversión [(string)] produce su texto. Con [declare(strict_types=1)], lo mejor es realizar esta conversión explícitamente antes de pasar el valor a una función que espera una cadena;
  • Línea 21: el valor del atributo [gender];
  • Líneas 26–27: [isset] determina si existe un elemento. El script de PHP 7 mostraba el resultado booleano con [print], que devuelve [1] para [true] y una cadena vacía para [false]. Nosotros usamos [var_export], que muestra [true] o [false];
  • línea 29: la conversión [(int)] devuelve el valor entero del texto del elemento;
  • línea 32: el método [xpath] evalúa una expresión XPath. La expresión [//person] designa todos los elementos [person] del documento, sea cual sea su nivel. Devuelve un arreglo de [SimpleXMLElement].

Salida en la consola

> php simplexml-01.php
SimpleXMLElement Object
(
    [teacher] => SimpleXMLElement Object
        (
            [person] => SimpleXMLElement Object
                (
                    [@attributes] => Array
                        (
                            [gender] => M
                        )

                    [lastName] => dupont
                    [firstName] => jean
                    [age] => 28
                )

            [section] => 27
        )

    [student] => SimpleXMLElement Object
        (
            [person] => SimpleXMLElement Object
                (
                    [@attributes] => Array
                        (
                            [gender] => F
                        )

                    [lastName] => martin
                    [firstName] => charline
                    [age] => 22
                )

            [course] => dess IAIE
        )

)
SimpleXMLElement Object
(
    [0] => M
)
lastName=dupont
gender=M
course=dess IAIE
isset(lastName)=true
isset(xx)=false
age of the student=22
person: jean dupont (M)
person: charline martin (F)
  • Líneas 2–38: el documento XML en forma de objeto [SimpleXMLElement]. Observe que el texto [this is a comment] no aparece: [print_r] solo muestra los elementos y los atributos;
  • líneas 39–42: un atributo también es un objeto [SimpleXMLElement];
  • líneas 43–48: los valores leídos del documento;
  • líneas 49–50: el recorrido XPath de las dos personas.

21.3. Procesamiento con la nueva API DOM de PHP 8.4

A partir de PHP 8.4, el espacio de nombres [Dom] ofrece una nueva API DOM: la clase [Dom\XMLDocument] para documentos XML y la clase [Dom\HTMLDocument] para documentos HTML5. Es un mejor reemplazo de la antigua clase [DOMDocument] (que sigue disponible): cumple con el estándar DOM actual y proporciona los métodos [querySelector] y [querySelectorAll] conocidos por los desarrolladores de JavaScript. Estos métodos permiten buscar elementos mediante selectores CSS.

El script [dom-01.php] usa el mismo documento:

<?php

declare(strict_types=1);

// el mismo documento usado con la nueva API DOM de PHP 8.4

use Dom\XMLDocument;

// el archivo XML que se usará
const FILE_NAME = "data.xml";

try {
    // carga del documento XML
    $document = XMLDocument::createFromFile(FILE_NAME);
} catch (Throwable $ex) {
    print "The file [" . FILE_NAME . "] could not be used: {$ex->getMessage()}\n";
    exit(1);
}
// el elemento raíz
print "root=" . $document->documentElement->tagName . "\n";
// la 1.ª persona docente, encontrada con un selector CSS
$person = $document->querySelector('teacher > person');
print "lastName=" . $person->querySelector('lastName')->textContent . "\n";
print "gender=" . $person->getAttribute('gender') . "\n";
print "course=" . $document->querySelector('student > course')->textContent . "\n";
// un elemento ausente: querySelector devuelve null
print "xx exists=" . var_export($person->querySelector('xx') !== null, true) . "\n";
// todas las personas del documento
foreach ($document->querySelectorAll('person') as $person) {
    // el operador nullsafe ?-> protege contra un elemento ausente
    $firstName = $person->querySelector('firstName')?->textContent ?? '?';
    $lastName = $person->querySelector('lastName')?->textContent ?? '?';
    print "person: $firstName $lastName ({$person->getAttribute('gender')})\n";
}
// modificación del documento: cambiamos el contenido del elemento <section> del docente
$section = $document->querySelector('teacher > section');
$section->textContent = "26";
// el documento modificado, como texto XML
print $document->saveXml($document->querySelector('teacher')) . "\n";

Comentarios

  • línea 7: la clase [XMLDocument] del espacio de nombres [Dom];
  • Línea 14: el método estático [createFromFile] carga el documento. A diferencia de [simplexml_load_file], lanza una excepción si se produce un error;
  • línea 20: la propiedad [documentElement] es el elemento raíz; [tagName] es su nombre;
  • línea 22: el selector CSS [teacher > person] designa un elemento [person] que es hijo directo de un elemento [teacher]. [querySelector] devuelve el primer elemento que coincide, o [null] si no hay ninguno;
  • línea 23: la propiedad [textContent] es el texto contenido en el elemento;
  • línea 24: el valor de un atributo;
  • línea 27: un elemento inexistente devuelve [null];
  • línea 29: todos los elementos [person] del documento;
  • Línea 31: si faltara el elemento [firstName], [querySelector('firstName')] daría como resultado [null]. El operador null-safe [?->] (PHP 8.0) devuelve entonces [null] en lugar de causar un error, y el operador [??] reemplaza este [null] por ['?'];
  • línea 37: la API DOM también permite modificar el documento: aquí se cambia el texto del elemento [section];
  • línea 39: [saveXml] devuelve el texto XML del documento, o de uno de sus elementos si se pasa como parámetro.

Salida en la consola

> php dom-01.php
root=tribe
lastName=dupont
gender=M
course=dess IAIE
xx exists=false
person: jean dupont (M)
person: charline martin (F)
<teacher>
        <person gender="M">
            <lastName>dupont</lastName>
            <firstName>jean</firstName>
            <age>28</age>
            this is a comment
        </person>
        <section>26</section>
    </teacher>
  • línea 16: la modificación realizada por el script.

Estos dos ejemplos no muestran todas las capacidades de [SimpleXML] y [DOM], pero son suficientes para escribir una nueva versión del ejercicio de aplicación. La documentación de PHP los describe en detalle: SimpleXML y DOM.