Uso básico de SimpleXML

Muchos ejemplos en esta referencia requieren un string XML. En vez de repetir este string en cada ejemplo, se ha puesto en un fichero que se incluye en cada ejemplo. Este fichero se muestra en la siguiente sección de ejemplo. Alternativamente, puede crearse un document XML y leerlo con simplexml_load_file().

Ejemplo #1 ejemplo.php, fichero a incluir con el string XML

<?php
$xmlstr 
= <<<XML
<?xml version='1.0' standalone='yes'?>
<peliculas>
 <pelicula>
  <titulo>PHP: Tras el Parser</titulo>
  <personajes>
   <personaje>
    <nombre>Srta. Programadora</nombre>
    <actor>Onlivia Actora</actor>
   </personaje>
   <personaje>
    <nombre>Sr. Programador</nombre>
    <actor>El Actor</actor>
   </personaje>
  </personajes>
  <argumento>
   Así que, este lenguaje. Es como, un lenguaje de programación. ¿O es un
   lenguaje interpretado? Lo descubrirás en esta intrigante y temible parodia
   de un documental.
  </argumento>
  <grandes-lineas>
   <linea>PHP soluciona todos los problemas web</linea>
  </grandes-lineas>
  <puntuacion tipo="pulgares">7</puntuacion>
  <puntuacion tipo="estrellas">5</puntuacion>
 </pelicula>
</peliculas>
XML;
?>

La simplicidad de SimpleXML se ve claramente cuando se extrae un string o un número de un documento XMl básico.

Ejemplo #2 Obteniendo <argumento>

<?php
include 'ejemplo.php';

$peliculas = new SimpleXMLElement($xmlstr);

echo 
$peliculas->pelicula[0]->argumento;
?>

El resultado del ejemplo sería:


   Así que, este lenguaje. Es como, un lenguaje de programación. ¿O es un
   lenguaje interpretado? Lo descubrirás en esta intrigante y temible parodia
   de un documental.

El acceso a elementos dentro de un documento XML que contienen caracteres no permitidos por la convención de nombres de PHP (por ejemplo, el guión) puede realizarse encapsulando el nombre del elemento dentro de un par de llaves y comillas simples.

Ejemplo #3 Obteniendo <linea>

<?php
include 'example.php';

$peliculas = new SimpleXMLElement($xmlstr);

echo 
$peliculas->pelicula->{'grandes-lineas'}->linea;
?>

El resultado del ejemplo sería:

PHP soluciona todos los problemas web

Ejemplo #4 Accediendo a elementos no únicos en SimpleXML

Cuando existen múltiples instancias de un elemento como hijos de un único elemento padre, se aplican las técnicas normales de iteración.

<?php
include 'example.php';

$peliculas = new SimpleXMLElement($xmlstr);

/* Para cada <personaje>, mostramos cada <nombre>. */
foreach ($peliculas->pelicula->personajes->personaje as $personaje) {
   echo 
$personaje->nombre' interpretado por '$personaje->actorPHP_EOL;
}

?>

El resultado del ejemplo sería:

Srta. Programadora interpretado por Onlivia Actora
Sr. Programador interpretado por El Actor

Nota:

Las propiedades ($peliculas->pelicula en el ejemplo anterior) no son arrays. Son objetos iterables y accesibles.

Ejemplo #5 Usando atributos

Hasta aquí, únicamente se ha cubierto el trabajo de leer nombres de elementos y sus valores. SimpleXML puede también acceder a los atributos de los elementos. Para acceder a ellos, se realiza de la misma forma que si fuesen elementos de un array.

<?php
include 'example.php';

$peliculas = new SimpleXMLElement($xmlstr);

/* Acceso a los nodos <puntuacion> de la primera película.
 * Mostramos la escala (tipo) también. */
foreach ($peliculas->pelicula[0]->puntuacion as $puntuacion) {
    switch((string) 
$puntuacion['tipo']) { // Toma los atributos como índices del elemento
    
case 'pulgares':
        echo 
$puntuacion' votos positivos';
        break;
    case 
'estrellas':
        echo 
$puntuacion' estrellas';
        break;
    }
}
?>

El resultado del ejemplo sería:

7 votos positivos5 estrellas

Ejemplo #6 Comparando elementos y atributos con texto

Para comparar un elemento o atributo con un string o pasarlo a una función que requiera un string, debe realizarse un cast a string usando (string). Si no se realiza de esta forma, PHP trata al elementos como un objeto.

<?php     
include 'example.php';

$peliculas = new SimpleXMLElement($xmlstr);

if ((string) 
$peliculas->pelicula->titulo == 'PHP: Tras el Parser') {
    print 
'Mi película favorita.';
}

echo 
htmlentities((string) $peliculas->pelicula->titulo);
?>

El resultado del ejemplo sería:

Mi película favorita.PHP: Tras el Parser

Ejemplo #7 Comparando dos elementos

Dos SimpleXMLElements son considerados distintos aún cuando ambos apuntan al mismo elemento desde PHP 5.2.0.

<?php
include 'example.php';

$pelicula1 = new SimpleXMLElement($xmlstr);
$pelicula2 = new SimpleXMLElement($xmlstr);
var_dump($pelicula1 == $pelicula2); // false desde PHP 5.2.0
?>

El resultado del ejemplo sería:

bool(false)

Ejemplo #8 Usando XPath

SimpleXML incorpora soprote XPath. Para encontrar todos los elementos <personaje>:

<?php
include 'example.php';
$peliculas = new SimpleXMLElement($xmlstr);

foreach (
$peliculas->xpath('//personaje') as $personaje) {
    echo 
$personaje->nombre ' interpretado por ' $personaje->actorPHP_EOL;
}
?>

'//' actúa un comodín. Para especificar una ruta absoluta, hay que omitir una de las dos barras.

El resultado del ejemplo sería:

Srta. Programadora interpretado por Onlivia Actora
Sr. Programador interpretado por El Actor

Ejemplo #9 Estableciendo valores

Los datos en SimpleXML no tienen que ser constantes. El objeto permite que se manipulen todos sus elementos.

<?php
include 'example.php';
$peliculas = new SimpleXMLElement($xmlstr);

$peliculas->pelicula[0]->personajes->personaje[0]->nombre 'Señorita Programadora';

echo 
$peliculas->asXML();
?>

El resultado del ejemplo sería:

<?xml version="1.0" standalone="yes"?>
<peliculas>
 <pelicula>
  <titulo>PHP: Tras el Parser</titulo>
  <personajes>
   <personaje>
    <nombre>Srta. Programadora</nombre>
    <actor>Onlivia Actora</actor>
   </personaje>
   <personaje>
    <nombre>Sr. Programador</nombre>
    <actor>El Actor</actor>
   </personaje>
  </personajes>
  <argumento>
   Así que, este lenguaje. Es como, un lenguaje de programación. ¿O es un
   lenguaje interpretado? Lo descubrirás en esta intrigante y temible parodia
   de un documental.
  </argumento>
  <grandes-lineas>
   <linea>PHP soluciona todos los problemas web</linea>
  </grandes-lineas>
  <puntuacion tipo="pulgares">7</puntuacion>
  <puntuacion tipo="estrellas">5</puntuacion>
 </pelicula>
</peliculas>
+

Ejemplo #10 Añadiendo elementos y atributos

Desde PHP 5.1.3, SimpleXML tiene la capacidad de añadir fácilmente hijos y atributos.

<?php
include 'example.php';
$peliculas = new SimpleXMLElement($xmlstr);

$character $peliculas->pelicula[0]->personajes->addChild('personaje');
$character->addChild('nombre''Sr. Parser');
$character->addChild('actor''John Doe');

$rating $peliculas->pelicula[0]->addChild('puntuacion''Todos los públicos');
$rating->addAttribute('tipo''clasificación');

echo 
$peliculas->asXML();
?>

El resultado del ejemplo sería:

<?xml version="1.0" standalone="yes"?>
<peliculas>
 <pelicula>
  <titulo>PHP: Tras el Parser</titulo>
  <personajes>
   <personaje>
    <nombre>Srta. Programadora</nombre>
    <actor>Onlivia Actora</actor>
   </personaje>
   <personaje>
    <nombre>Sr. Programador</nombre>
    <actor>El Actor</actor>
   </personaje>
  </personajes>
  <argumento>
   Así que, este lenguaje. Es como, un lenguaje de programación. ¿O es un
   lenguaje interpretado? Lo descubrirás en esta intrigante y temible parodia
   de un documental.
  </argumento>
  <grandes-lineas>
   <linea>PHP soluciona todos los problemas web</linea>
  </grandes-lineas>
  <puntuacion tipo="pulgares">7</puntuacion>
  <puntuacion tipo="estrellas">5</puntuacion>
 </pelicula>
</peliculas>

Ejemplo #11 Interoperatibilidad DOM

PHP tiene un mecanismo para convertor nodos XML entre los formatos SimpleXML y DOM. Este ejemplo muestra como cambiar un elemento DOM a SimpleXML.

<?php
$dom 
= new DOMDocument;
$dom->loadXML('<libros><libro><titulo>blah</titulo></libro></libros>');
if (!
$dom) {
    echo 
'Error al analizar el documento');
    exit;
}

$s simplexml_import_dom($dom);

echo 
$s->libro[0]->titulo;
?>

El resultado del ejemplo sería:

blah

add a note add a note

User Contributed Notes 11 notes

up
20
jishcem at gmail dot com
1 year ago
For me it was easier to use arrays than objects,

So, I used this code,

$xml = simplexml_load_file('xml_file.xml');
   
$json_string = json_encode($xml);
   
$result_array = json_decode($json_string, TRUE);

Hope it would help someone
up
8
ie dot raymond at gmail dot com
4 years ago
If you need to output valid xml in your response, don't forget to set your header content type to xml in addition to echoing out the result of asXML():

<?php

$xml
=simplexml_load_file('...');
...
...
xml stuff
...

//output xml in your response:
header('Content-Type: text/xml');
echo
$xml->asXML();
?>
up
3
bjorn at xQmail dot eu
4 years ago
If you're not sure the XML will be valid you'd better use:

<?php
$xmlObject
= simplexml_load_string($xml);
// or
$xmlObject = simplexml_load_file(xml);
?>

Both of these return a SimpleXMLElement Object or a libXMLError Object.
up
1
kdos
3 years ago
Using stuff like: is_object($xml->module->admin) to check if there actually is a node called "admin", doesn't seem to work as expected, since simplexml always returns an object- in that case an empty one  - even if a particular node does not exist.
For me good old empty() function seems to work just fine in such cases.

Cheers
up
1
gkokmdam at zonnet dot nl
3 years ago
A quick tip on xpath queries and default namespaces. It looks like the XML-system behind SimpleXML has the same workings as I believe the XML-system .NET uses: when one needs to address something in the default namespace, one will have to declare the namespace using registerXPathNamespace and then use its prefix to address the otherwise in the default namespace living element.

<?php
$string
= <<<XML
<?xml version='1.0'?>
<document xmlns="http://www.w3.org/2005/Atom">
 <title>Forty What?</title>
 <from>Joe</from>
 <to>Jane</to>
 <body>
  I know that's the answer -- but what's the question?
 </body>
</document>
XML;

$xml = simplexml_load_string($string);
$xml->registerXPathNamespace("def", "http://www.w3.org/2005/Atom");

$nodes = $xml->xpath("//def:document/def:title");

?>
up
1
RiKdnUA at mail dot ru
4 months ago
Если кодировка XML-документа отличается от UTF-8, объявление кодировки должно следовать сразу после version='...' и перед standalone='...'. Это требование стандарта XML.

If encoding XML-document differs from UTF-8. Encoding declaration should follow immediately after the version = '...' and before standalone = '...'. This requirement is standard XML.

<?xml version='1.0' encoding='windows-1251' standalone='yes'?>
Ok
<?xml version='1.0' standalone='yes' encoding='windows-1251'?>
<body>Русский язык. Russian language</body>
Fatal error: Uncaught exception 'Exception' with message 'String could not be parsed as XML' in...
up
0
eng dot emad_2010 at yahoo dot com
6 months ago
Example #  DOM Interoperability التشغيل البيني   
PHP has a mechanism to convert XML nodes between SimpleXML and DOM formats. This example shows how one might change a DOM element to SimpleXML  .
The simplexml_import_dom() function returns a SimpleXMLElement object from a DOM node.
DOM         object

<?php
//create DOM  document $dom that contain XML
$dom = new DOMDocument;
$dom->loadXML('<books><book><title>blah</title></book></books>');
if (!
$dom) {
    echo
'Error while parsing the document';
    exit;
}
//convert DOM document $dom to object $books
$books = simplexml_import_dom($dom);

//access object $books
echo $books->book[0]->title;
?>
up
0
dmitron1036 at mail dot ru
8 months ago
Hello, everyboady!
How can I change attributes in xml object?
like this:
$children[0]["@attributes"]['x'] = '0';

I try:
$children = $xml->children();
var_dump($children[0]["@attributes"]);//"NULL"
var_dump($children[0]);//(2) ["@attributes"]=>array(1) {['x']=> string(1) '2'}
up
0
Max K.
3 years ago
From the README file:

SimpleXML is meant to be an easy way to access XML data.

SimpleXML objects follow four basic rules:

1) properties denote element iterators
2) numeric indices denote elements
3) non numeric indices denote attributes
4) string conversion allows to access TEXT data

When iterating properties then the extension always iterates over
all nodes with that element name. Thus method children() must be
called to iterate over subnodes. But also doing the following:
foreach ($obj->node_name as $elem) {
  // do something with $elem
}
always results in iteration of 'node_name' elements. So no further
check is needed to distinguish the number of nodes of that type.

When an elements TEXT data is being accessed through a property
then the result does not include the TEXT data of subelements.

Known issues
============

Due to engine problems it is currently not possible to access
a subelement by index 0: $object->property[0].
up
0
php at keith tyler dot com
4 years ago
[Editor's Note: The SimpleXMLIterator class, however, does implement these methods.]

While SimpleXMLElement claims to be iterable, it does not seem to implement the standard Iterator interface functions like ::next and ::reset properly. Therefore while foreach() works, functions like next(), current(), or each() don't seem to work as you would expect -- the pointer never seems to move or keeps getting reset.
up
-1
radams at circlepix com
4 years ago
To test whether an element exists:

<?php

    $xml
= <<<EOT
<?xml version='1.0' standalone='yes'?>
<root>
    <test1></test1>
    <test2 />
    <test4> </test4>
</root>
EOT;

   
$xmlDoc = new SimpleXMLElement($xml);

echo
"Test1: \n";
var_dump($xmlDoc->test1);
echo
"\n(" . (bool)$xmlDoc->test1 . ")";
echo
"\n\n";

echo
"Test2: \n";
var_dump($xmlDoc->test2);
echo
"\n(" . (bool)$xmlDoc->test2 . ")";
echo
"\n\n";

echo
"Test3: \n";
var_dump($xmlDoc->test3);
echo
"\n(" . (bool)$xmlDoc->test3 . ")";
echo
"\n\n";

echo
"Test4: \n";
var_dump($xmlDoc->test4);
echo
"\n(" . (bool)$xmlDoc->test4 . ")";
echo
"\n\n";

?>

The var_dumps for test1, test2, and test3 are identical, but the (bool) test gives a '1' for test1 and test2, and a '' for test3.
To Top