CXIII. Fonctions SimpleXML

Introduction

L'extension SimpleXML fournit des outils très simples et faciles à utiliser pour convertir du XML en un objet qui peut être manipulé avec ses propriétés et les itérateurs de tableaux.

Pré-requis

L'extension SimpleXML requière PHP 5.

Installation

L'extension SimpleXML est activé par défaut. Pour la désactiver, utilisez l'option de configuration --disable-simplexml.

Exemples

Plusieurs exemples de ce chapitre requièrent une chaîne XML. Plutôt que de la repéter à chaque exemple, nous allons la placer dans un fichier que nous incluerons à chaque exemple. Le contenu de ce fichier est montré dans l'exemple qui suit. Alternativement, vous pouvez créer un document XML et le lire avec simplexml_load_file().

Exemple 1. Fichier avec une chaîne XML qui sera inclus partout : example.php

<?php
$xmlstr
= <<<XML
<?xml version='1.0' standalone='yes'?>
<movies>
<movie>
  <title>PHP: Behind the Parser</title>
  <characters>
   <character>
    <name>Ms. Coder</name>
    <actor>Onlivia Actora</actor>
   </character>
   <character>
    <name>Mr. Coder</name>
    <actor>El Act&oacute;r</actor>
   </character>
  </characters>
  <plot>
   So, this language. It's like, a programming language. Or is it a
   scripting language? All is revealed in this thrilling horror spoof
   of a documentary.
  </plot>
  <rating type="thumbs">7</rating>
  <rating type="stars">5</rating>
</movie>
</movies>
XML;
?>

La simplicité de SimpleXML apparaît plus clairement lorsqu'on essaye d'extraire une chaîne ou un nombre d'un document XML basique.

Exemple 2. Obtenir <plot>

<?php
include 'example.php';

$xml = simplexml_load_string($xmlstr);

echo
$xml->movie[0]->plot; // "So this language. It's like..."
?>

Exemple 3. Accéder à un élément non-unique avec SimpleXML

Lorsque plusieurs instances d'un élément existent en tant que fils d'un élément père unique, les techniques normales d'itération peuvent être appliquées.

<?php
include 'example.php';

$xml = simplexml_load_string($xmlstr);

/* Pour chaque <movie>, nous affichons un <plot>. */
foreach ($xml->movie as $movie) {
   echo
$movie->plot, '<br />';
}

?>

Exemple 4. Utilisation des attributs

Jusque là, nous n'avons couvert que la lecture des noms d'éléments, et leurs valeurs. SimpleXML peut aussi atteindre leurs attributs. L'accès aux attributs d'un élément se fait de la même façon que l'accès aux éléments d'un tableau.

<?php
include 'example.php';

$xml = simplexml_load_string($xmlstr);

/* Accès au node <rating> du premier <movie>.
* Affichage des attributs de <rating> également. */
foreach ($xml->movie[0]->rating as $rating) {
    switch((string)
$rating['type']) { // Récupération des attributs comme indices d'éléments
    
case 'thumbs':
        echo
$rating, ' thumbs up';
        break;
    case
'stars':
        echo
$rating, ' stars';
        break;
    }
}
?>

Exemple 5. Comparaison des éléments et des attributs avec du texte

Pour comparer un élément ou un attribut avec une chaîne de caractères ou pour le passer à une fonction qui nécessite une chaîne de caractères, vous devez le transtiper en une chaîne en utilisant (string). Sinon, PHP traitera l'élément comme un objet.

<?php     
include 'example.php';

$xml = simplexml_load_string($xmlstr);

if ((string)
$xml->movie->title == 'PHP: Behind the Parser') {
    echo
'My favorite movie.';
}

htmlentities((string) $xml->movie->title);
?>

Exemple 6. Utilisation de Xpath

SimpleXML inclut le support embarqué de Xpath. Pour trouver tous les éléments <character> :

<?php
include 'example.php';
$xml = simplexml_load_string($xmlstr);

foreach (
$xml->xpath('//character') as $character) {
    echo
$character->name, 'played by ', $character->actor, '<br />';
}
?>

'//' sert de joker. Pour spécifier un chemin absolu, enlevez un slash.

Exemple 7. Attribuer des valeurs

Les données dans SimpleXML n'ont pas à être constantes. L'objet permet la manipulation de tous ces éléments.

<?php
include 'example.php';
$xml = simplexml_load_string($xmlstr);

$xml->movie[0]->characters->character[0]->name = 'Miss Coder';

echo
$xml->asXML();
?>

L'exemple précédent affichera un nouveau document XML, tout comme l'original mise à part que le nouveau document XML définie Ms. Coder a Miss Coder.

Exemple 8. Interopérabilité DOM

PHP possède un mécanisme pour convertir les nodes XML entre les formats SimpleXML et DOM. Cet exemple montre comment changer un élément DOM en SimpleXML.

<?php
$dom
= new domDocument;
$dom->loadXML('<books><book><title>blah</title></book></books>');
if (!
$dom) {
     echo
'Error while parsing the document';
     exit;
}

$s = simplexml_import_dom($dom);

echo
$s->book[0]->title;
?>

Constantes pré-définies

Ces constantes sont définies par cette extension, et ne sont disponibles que si cette extension a été compilée avec PHP, ou bien chargée au moment de l'exécution.

LIBXML_NOENT (entier)

Substitue les entités

LIBXML_DTDLOAD (entier)

Charge un sous-ensemble externe

LIBXML_DTDATTR (entier)

Attributs par défaut de la DTD

LIBXML_DTDVALID (entier)

Valide avec la DTD

LIBXML_NOERROR (entier)

Supprime les messages d'erreurs

LIBXML_NOWARNING (entier)

Supprime les alertes.

LIBXML_NOBLANKS (entier)

Supprime les noeuds vides

LIBXML_XINCLUDE (entier)

Implémente les substitutions XInclude

LIBXML_NSCLEAN (entier)

Supprime les déclaratons redondantes d'espaces de noms

LIBXML_NOCDATA (entier)

Fusionne les blocks CDATA en noeuds de texte

LIBXML_NONET (entier)

Désactive l'accès au réseau durant le chargement de documents

Note : Ces constantes ont été ajoutées en PHP 5.1.0.

Table des matières
SimpleXMLElement->asXML --  Retourne une chaîne XML basée sur un élément SimpleXML
SimpleXMLElement->attributes -- Identifie les attributs d'un élément
SimpleXMLElement->children -- Trouve les enfants d'une node
SimpleXMLElement->xpath -- Exécute une requête Xpath sur des données XML
simplexml_import_dom --  Construit un objet SimpleXMLElement à partir d'une node DOM
simplexml_load_file -- Convertit un fichier XML en objet
simplexml_load_string -- Convertit un chaîne XML en objet