SimpleXML para manipular XML pelo PHP

Introdução

SimpleXML é uma extensão do PHP que permite ler e manipular XML de maneira bastante simples, embora com várias restrições. A principal restrição é que um elemento (tag) só pode conter texto ou outros elementos, nunca texto junto com outros elementos, como ocorre no HTML.

Exemplo de XML que não é corretamente manipulado por SimpleXML:

<?xml version="1.0" ?>
<teste>
  <frase>A linguagem <negrito>PHP<negrito> é legal.</frase>
</teste>

SimpleXML foi feito para manipular XML que representam pacotes de dados sobre determinado registro, diferente do HTML, que é utilizado para formatar um documento, ou seja, são propósitos distintos.

A extensão provê duas funções principais: simplexml_load_string e simplexml_load_file. A primeira carrega um XML a partir de uma string e a segunda carrega um XML a partir do nome de um arquivo. Ambas devolvem um objeto da classe SimpleXMLElement, que é a classe principal da extensão.

---

Leitura usando SimpleXML

Em geral, a classe SimpleXMLElement representa um elemento dentro do XML, mas também pode representar uma coleção de elementos. Supondo o XML seguinte:

<?xml version="1.0" ?>
<livro>
  <nome>Exemplos de XML</nome>
  <data formato="w3c">2011-02-28</data>
  <edicao>1</edicao>
  <autor>
    <nome>Rubens Takiguti Ribeiro</nome>
    <site>http://rubsphp.blogspot.com</site>
  </autor>
  <comentarios>
    <comentario>
      <autor>Alguém</autor>
      <texto>Gostei muito do livro</texto>
    </comentario>
    <comentario>
      <autor>Outro</autor>
      <texto>Poderia ter mais figuras.</texto>
    </comentario>
  </comentarios>
</livro>

Para obter os dados do livro e do autor, basta acessá-los pela estrutura hierárquica do XML:

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

echo strval($xml->nome); // Obtem o nome do livro
echo strval($xml->data); // Obtem a data do livro
echo strval($xml->data['formato']); // Obtem o atributo "formato" da data do livro

echo strval($xml->autor->nome); // Obtem o nome do autor do livro
echo strval($xml->autor->site); // Obtem o endereco do site do autor do livro

Porém, o número de comentários do livro é variado, logo, é preciso usar uma estrutura de repetição:

// Obtendo o nome do autor do primeiro comentario da lista de comentarios
echo strval($xml->comentarios->comentario->autor);

// Forma alternativa para obter autor do primeiro comentario
echo strval($xml->comentarios[0]->comentario[0]->autor[0]);

// Obtendo o nome do autor do segundo comentario
echo strval($xml->comentarios[0]->comentario[1]->autor[0]);

// Percorrendo os elementos "comentario" que estao dentro do primeiro elemento "comentarios"
foreach ($xml->comentarios->comentario as $comentario) {
    echo strval($comentario->autor); // Obtem o nome do autor do comentario
    echo strval($comentario->texto); // Obtem o texto do comentario
}

Observe que a expressão $xml->comentarios->comentario expressa tanto o primeiro elemento "comentario" encontrado dentro do primeiro elemento "comentarios" quanto o array de comentários que estão dentro do elemento "comentarios". O comportamento do objeto depende do contexto em que se encontra. A função strval é utilizada para extrair o valor do elemento na forma de string, caso contrário, seria devolvido outro objeto da classe SimpleXMLElement.

De fato, se uma instrução echo é aplicada a um objeto da classe SimpleXMLElement, é exibido o conteúdo textual do elemento. Porém, para realizar comparações, é importante converter este valor para string e, opcionalmente, para outros tipos depois. Veja o exemplo:

var_dump($xml->nome == $xml->data); // retorna true
var_dump(strval($xml->nome) == strval($xml->data)); // retorna false

No primeiro caso estão sendo comparados dois objetos e no segundo estão sendo comparadas duas strings.

Além disso, a leitura pode ser feita usando XPath através do método xpath, que devolve um array de elementos encontrados.

Finalmente, existem os métodos children e attributes. O primeiro obtem todos os elementos filhos de determinado elemento, e o segundo obtém todos os atributos de determinado elemento. Para obter o nome do elemento ou atributo percorrido, basta usar o método getName.

---

Escrita usando SimpleXML

A escrita em um documento precisa que o documento seja criado, pelo menos, com uma tag raiz. Em seguida, é possível usar os métodos addChild e addAttribute, respectivamente, para adicionar elementos filhos ou atributos ao elemento. Exemplo:

// Criando um elemento raiz vazio
$xml = new SimpleXMLElement('<?xml version="1.0" ?><livro />');

// Adicionando elementos "nome" e "data"
$xml->addChild('nome', 'Nome do livro');
$elemento_data = $xml->addChild('data', '2011-02-28');

// Incluindo um atributo "formato" no elemento "data"
$elemento_data->addAttribute('formato', 'w3c');

// Exibindo o XML na forma textual
echo $xml->asXML();

Uma forma alternativa, é acessar os elementos e atributos como se eles já existissem. Os elementos filhos são acessados como se fossem atributos do objeto, enquanto os atributos são acessados como se fossem posições de um array (utilizando o operador colchetes):

// Criando um elemento raiz vazio
$xml = new SimpleXMLElement('<?xml version="1.0" ?><livro />');

// Adicionando elementos "nome" e "data"
$xml->nome = 'Nome do livro';
$xml->data = '2011-02-28';

// Incluindo um atributo "formato" no elemento "data"
$xml->data['formato'] = 'w3c';

// Exibindo o XML na forma textual
echo $xml->asXML();

Para remover um elemento, basta aplicar a função unset sobre ele. Por exemplo, para remover o elemento "data":

unset($xml->data);

---

Salvando o arquivo XML

Ao manipular um objeto SimpleXML, estas alterações ficam apenas na memória RAM. Para persistir estas informações em um arquivo em disco, basta usar o método asXML passando como parâmetro o nome do arquivo que deseja gravar. Neste caso, ao invés de devolver uma string com o conteúdo do arquivo, a função vai jogar o conteúdo em um arquivo e devolver true ou false (indicando sucesso ou não). Exemplo:

// Gravando o conteudo em um arquivo XML
if ($xml->asXML('teste.xml')) {
    echo 'gravou arquivo XML';
}

Observação: o método saveXML é um apelido do método asXML e, neste caso, torna o código mais legível. Afinal, se estamos salvando um arquivo, o método saveXML é auto-explicativo.

// Gravando o conteudo em um arquivo XML
if ($xml->saveXML('teste.xml')) {
    echo 'gravou arquivo XML';
}

---

Identificando problemas com XML

Caso seu XML tenha algum problema, você pode identificá-los utilizando as funções libxml_use_internal_errors em conjunto com libxml_get_errors, conforme exemplo:

libxml_use_internal_errors(true);
$xml = simplexml_load_string("<?xml version='1.0'><exemplo><quebrado></exemplo>");
if (!$xml) {
    foreach(libxml_get_errors() as $erro) {
        echo $erro->message . "\n";
    }
}

---

Observações

É possível importar um documento (ou elemento) estruturado através da extensão DOM para a forma mais simples do SimpleXML através da função simplexml_import_dom.

Para ler elementos que possuem "-" (sinal de menos) no nome, basta utilizar a notação:

$xml->{'nome-com-sinal-de-menos'}->nome;

Caso o XML de uma string ou de um arquivo esteja com falhas, ele não será lido corretamente por simplexml_load_string ou simplexml_load_file, mas os erros podem ser recuperados através da função libxml_get_errors, que faz parte da extensão libxml, vem instalada por padrão no PHP (embora possa ser removida).

Com SimpleXML não é possível manipular diretamente comentários, blocos CDATA, o DOCTYPE do documento, entre outras coisas. Caso seja necessário um nível mais aprofundado de manipulação, pode-se usar a extensão DOM, que é mais completa e robusta.