PHP: Uso Básico de SimpleXML

Uso Básico de SimpleXML

Muitos exemplos nesta referência requerem uma string XML. Em vez de repetir esta string em todos os exemplos, ela foi colocada em um arquivo que incluímos em cada exemplo. Este arquivo incluído é mostrado na seção de exemplo a seguir. Alternativamente, um documento XML pode ser criado e lido com simplexml_load_file().

Exemplo #1 Inclusão do arquivo exemplo.php com string XML

<?php
$xmlstr = <<<XML
<?xml version='1.0' standalone='yes'?>
<filmes>
 <filme>
  <titulo>PHP: Nos Bastidores do Interpretador</titulo>
  <personagens>
   <personagem>
    <nome>Srta. Codificadora</nome>
    <ator>Onlivia Actora</ator>
   </personagem>
   <personagem>
    <nome>Sr. Codificador</nome>
    <ator>El Act&#243;r</ator>
   </personagem>
  </personagens>
  <resumo>
   Então, essa linguagem. Se parece com uma linguagem de programação. Ou seria uma
   liguagem de scripts? Tudo é revelado nesta emocionante paródia de terror
   de um documentário.
  </resumo>
  <melhores-frases>
   <frase>O PHP resolve todos os meus problemas!</frase>
  </melhores-frases>
  <classificacao tipo="gostei">7</classificacao>
  <classificacao tipo="estrelas">5</classificacao>
 </filme>
</filmes>
XML;
?>

A simplicidade do SimpleXML aparece mais claramente quando se extrai uma string ou número de um documento XML básico.

Exemplo #2 Obtendo o <resumo>

<?php
include 'exemplo.php';

$filmes = new SimpleXMLElement($xmlstr);

echo $filmes->filme[0]->resumo;
?>

O exemplo acima produzirá:


   Então, essa linguagem. Se parece com uma linguagem de programação. Ou seria uma
   liguagem de scripts? Tudo é revelado nesta emocionante paródia de terror
   de um documentário.

O acesso a elementos em um documento XML que contém caracteres não permitidos pela convenção de nomenclatura do PHP (por exemplo, o hífen) pode ser realizado encapsulando o nome do elemento entre chaves e apóstrofo.

Exemplo #3 Obtendo <frase>

<?php
include 'exemplo.php';

$filmes = new SimpleXMLElement($xmlstr);

echo $filmes->filme->{'melhores-frases'}->frase;
?>

O exemplo acima produzirá:

O PHP resolve todos os meus problemas!

Exemplo #4 Acessando elementos não exclusivos em SimpleXML

Quando existem múltiplas instâncias de um elemento como filhos de um único elemento pai, aplicam-se técnicas normais de iteração.

<?php
include 'exemplo.php';

$filmes = new SimpleXMLElement($xmlstr);

/* Para cada nó <personagem>, é mostrado um <nome> separado. */
foreach ($filmes->filme->personagens->personagem as $personagem) {
   echo $personagem->nome, ' representado(a) por ', $personagem->ator, PHP_EOL;
}

?>

O exemplo acima produzirá:

Srta. Codificadora representado(a) por Onlivia Actora
Sr. Codificador representado(a) por El Actór

Nota:
Propriedades ($filmes->filme no exemplo anterior) não são arrays. Elas são objetos iteráveis e acessíveis.

Exemplo #5 Usando atributos

Até agora, foi coberto apenas o trabalho de leitura dos nomes dos elementos e seus valores. SimpleXML também pode acessar atributos de elementos. Os atributos de um elemento são acessados da mesma forma que os elementos de um array.

<?php
include 'exemplo.php';

$filmes = new SimpleXMLElement($xmlstr);

/* Acessando os nós <classificacao> do primeiro filme.
 * Mostra o valor da classificação também. */
foreach ($filmes->filme[0]->classificacao as $classificacao) {
    switch((string) $classificacao['tipo']) { // Obtém atributos como índices de elementos
    case 'gostei':
        echo $classificacao, ' gostaram, ';
        break;
    case 'estrelas':
        echo $classificacao, ' estrelas';
        break;
    }
}
?>

O exemplo acima produzirá:

7 gostaram, 5 estrelas

Exemplo #6 Comparando Elementos e Atributos com Texto

Para comparar um elemento ou atributo com uma string ou passá-lo para uma função que requer uma string, ele deve ser convertido em uma string usando (string). Caso contrário, o PHP trata o elemento como um objeto.

<?php
include 'exemplo.php';

$filmes = new SimpleXMLElement($xmlstr);

if ((string) $filmes->filme->titulo == 'PHP: Nos Bastidores do Interpretador') {
    print 'Meu filme favorito. ';
}

echo htmlentities((string) $filmes->filme->titulo);
?>

O exemplo acima produzirá:

Meu filme favorito. PHP: Nos Bastidores do Interpretador

Exemplo #7 Comparando Dois Elementos

Dois SimpleXMLElements são considerados diferentes mesmo que apontem para o mesmo elemento.

<?php
include 'exemplo.php';

$filmes1 = new SimpleXMLElement($xmlstr);
$filmes2 = new SimpleXMLElement($xmlstr);
var_dump($filmes1 == $filmes2);
?>

O exemplo acima produzirá:

bool(false)

Exemplo #8 Usando XPath

SimpleXML inclui suporte interno a XPath. Para encontrar todos os elementos <personagem>:

<?php
include 'exemplo.php';

$filmes = new SimpleXMLElement($xmlstr);

foreach ($filmes->xpath('//personagem') as $personagem) {
    echo $personagem->nome, ' representado(a) por ', $personagem->ator, PHP_EOL;
}
?>

'//' serve como um coringa. Para especificar caminhos absolutos, basta omitir uma das barras.

O exemplo acima produzirá:

Srta. Codificadora representado(a) por Onlivia Actora
Sr. Codificador representado(a) por El Actór

Exemplo #9 Definindo valores

Os dados no SimpleXML não precisam ser constantes. O objeto permite a manipulação de todos os seus elementos.

<?php
include 'exemplo.php';
$filmes = new SimpleXMLElement($xmlstr);

$filmes->filme[0]->personagens->personagem[0]->nome = 'Senhorita Codificadora';

echo $filmes->asXML();
?>

O exemplo acima produzirá:

<?xml version="1.0" standalone="yes"?>
<filmes>
 <filme>
  <titulo>PHP: Nos Bastidores do Interpretador</titulo>
  <personagens>
   <personagem>
    <nome>Senhorita Codificadora</nome>
    <ator>Onlivia Actora</ator>
   </personagem>
   <personagem>
    <nome>Sr. Codificador</nome>
    <ator>El Act&#xF3;r</ator>
   </personagem>
  </personagens>
  <resumo>
   Então, essa linguagem. Se parece com uma linguagem de programação. Ou seria uma
   liguagem de scripts? Tudo é revelado nesta emocionante paródia de terror
   de um documentário.
  </resumo>
  <melhores-frases>
   <frase>O PHP resolve todos os meus problemas!</frase>
  </melhores-frases>
  <classificacao tipo="gostei">7</classificacao>
  <classificacao tipo="estrelas">5</classificacao>
 </filme>
</filmes>

Exemplo #10 Adicionando elementos e atributos

SimpleXML tem a capacidade de adicionar facilmente filhos e atributos.

<?php
include 'exemplo.php';
$filmes = new SimpleXMLElement($xmlstr);

$personagem = $filmes->filme[0]->personagens->addChild('personagem');
$personagem->addChild('nome', 'Sr. Interpretador');
$personagem->addChild('ator', 'Fulano de Tal');

$classificacao = $filmes->filme[0]->addChild('classificacao', 'PG');
$classificacao->addAttribute('tipo', 'mpaa');

echo $filmes->asXML();
?>

O exemplo acima produzirá:

<?xml version="1.0" standalone="yes"?>
<filmes>
 <filme>
  <titulo>PHP: Nos Bastidores do Interpretador</titulo>
  <personagens>
   <personagem>
    <nome>Srta. Codificadora</nome>
    <ator>Onlivia Actora</ator>
   </personagem>
   <personagem>
    <nome>Sr. Codificador</nome>
    <actor>El Act&#xF3;r</actor>
   </personagem>
  <personagem><nome>Sr. Interpretador</nome><ator>Fulano de Tal</ator></personagem></personagens>
  <resumo>
   Então, essa linguagem. Se parece com uma linguagem de programação. Ou seria uma
   liguagem de scripts? Tudo é revelado nesta emocionante paródia de terror
   de um documentário.
  </resumo>
  <melhores-frases>
   <frase>O PHP resolve todos os meus problemas!</frase>
  </melhores-frases>
  <classificacao tipo="gostei">7</classificacao>
  <classificacao tipo="estrelas">5</classificacao>
 <classificacao tipo="mpaa">PG</classificacao></filme>
</filmes>

Exemplo #11 Interoperabilidade com o DOM

PHP possui um mecanismo para converter nós XML entre os formatos SimpleXML e DOM. Este exemplo mostra como um elemento DOM pode ser alterado para SimpleXML.

<?php
$dom = new DOMDocument;
$dom->loadXML('<livros><livro><titulo>Blá</titulo></livro></livros>');
if (!$dom) {
    echo 'Erro ao interpretar o documento.';
    exit;
}

$livros = simplexml_import_dom($dom);

echo $livros->livro[0]->titulo;
?>

O exemplo acima produzirá:

Blá

Melhore Esta Página

Aprenda Como Melhorar Esta Página • Envie uma Solicitação de Modificação • Reporte um Problema

＋adicione uma nota

Notas Enviadas por Usuários (em inglês) 9 notes

down

rowan dot collins at gmail dot com ¶

9 years ago

There is a common "trick" often proposed to convert a SimpleXML object to an array, by running it through json_encode() and then json_decode(). I'd like to explain why this is a bad idea.

Most simply, because the whole point of SimpleXML is to be easier to use and more powerful than a plain array. For instance, you can write <?php $foo->bar->baz['bing'] ?> and it means the same thing as <?php $foo->bar[0]->baz[0]['bing'] ?>, regardless of how many bar or baz elements there are in the XML; and if you write <?php (string)$foo->bar[0]->baz[0] ?> you get all the string content of that node - including CDATA sections - regardless of whether it also has child elements or attributes. You also have access to namespace information, the ability to make simple edits to the XML, and even the ability to "import" into a DOM object, for much more powerful manipulation. All of this is lost by turning the object into an array rather than reading understanding the examples on this page.

Additionally, because it is not designed for this purpose, the conversion to JSON and back will actually lose information in some situations. For instance, any elements or attributes in a namespace will simply be discarded, and any text content will be discarded if an element also has children or attributes. Sometimes, this won't matter, but if you get in the habit of converting everything to arrays, it's going to sting you eventually.

Of course, you could write a smarter conversion, which didn't have these limitations, but at that point, you are getting no value out of SimpleXML at all, and should just use the lower level XML Parser functions, or the XMLReader class, to create your structure. You still won't have the extra convenience functionality of SimpleXML, but that's your loss.

down

jishcem at gmail dot com ¶

11 years 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

down

Anonymous ¶

7 years ago

If your xml string contains booleans encoded with "0" and "1", you will run into problems when you cast the element directly to bool:

$xmlstr = <<<XML
<?xml version='1.0' standalone='yes'?>
<values>
    <truevalue>1</truevalue>
    <falsevalue>0</falsevalue>
</values>
XML;
$values = new SimpleXMLElement($xmlstr);
$truevalue = (bool)$values->truevalue; // true
$falsevalue = (bool)$values->falsevalue; // also true!!!

Instead you need to cast to string or int first:

$truevalue = (bool)(int)$values->truevalue; // true
$falsevalue = (bool)(int)$values->falsevalue; // false

down

Josef ¶

3 years ago

How to find out if a Node exists:

<?xml version='1.0' standalone='yes'?>
<book>
  <author>Josef</author>
  <isbn></isbn>
</book>

empty($xml->isbn) will be true
isset($xml->isbn) will be true

empty($xml->title) will be true
isset($xml->title) will be false

down

ie dot raymond at gmail dot com ¶

14 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();

?>

down

gkokmdam at zonnet dot nl ¶

13 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");

?>

down

kdos ¶

13 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

down

Max K. ¶

14 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].

down

-1

php at keith tyler dot com ¶

14 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.

＋adicione uma nota