Parser un document XML avec PHP Sites sur le même sujet Télécharger des documentations

Introduction à XML

PHP permet l'analyse syntaxique (parsage ou parsing en anglais) d'un document XML.
Le langage XML (eXtensible Markup Language, traduisez Langage à balises extensibles) est un métalangage, c'est-à-dire un langage permettant de définir votre propre langage. Ainsi contrairement au langage HTML, le langage XML permet d'aller définir vos propres balises, ce qui permet de séparer la présentation du document de son contenu.

Cette séparation entre le contenu et la présentation se fait à l'aide d'un analyseur syntaxique (parseur), c'est-à-dire un programme capable de vérifier la cohérence de la syntaxe du document et de l'interpréter afin de mettre en page son contenu. PHP propose une extension permettant de mettre au point facilement des analyseurs XML. Cette extension utilise la librairie expat disponible à http://www.jclark.com/xml/.

Installer l'extension XML

L'extension XML de PHP supporte la librairie expat disponible à http://www.jclark.com/xml/.
Sur les serveurs Apache récents (de version supérieure à la 1.3.7) la librairie expat est installée en standard. sur les serveurs apache de version antérieure à la 1.3.7 il suffit de télécharger cette librairie :

Pour activer le support de cette librairie lors de l'installation de PHP il suffit de lancer la configuration de PHP avec l'option --with-xml.

Pour vérifier que votre installation supporte bien la librairie expat, il vous suffit de créer un fichier phpinfo.php3 contenant uniquement les lignes suivantes

<?
phpinfo();
?>

Fonctionnement de l'extension XML

Les analyseurs XML sont également divisés selon l'approche qu'ils utilisent pour traiter le document. On distingue actuellement deux types d'approches :

Considérons le document XML suivant :

<debut>
	Bienvenue sur CCM - http://www.commentcamarche.net
</debut>

Avec un parseur XML utilisant une approche événementielle, les 3 événements suivants seraient générés :

L'extension XML fonctionne selon un mode événementiel, c'est-à-dire qu'elle définit des fonctions permettant de réagir aux divers événements :

Création de l'analyseur XML

La première étape consiste à créer un analyseur XML (ou plus exactement pour utiliser une instance de parseur XML) grâce à la fonction xml_create_parser() $xml_parseur = xml_parser_create(); Une fois le parseur créé, il s'agit de lui associer des événements, c'est-à-dire qu'il s'agit de créer des fonctions qui seront appelées par le parseur en cas de déclenchement d'un événement.
L'extension XML (expat) définit 7 types d'événements et leurs gestionnaires (handlers) associés :
Evénement Gestionnaire associé Description
Elements xml_set_element_handler() ce gestionnaire gère les ouvertures et fermetures de balises
Character Data xml_set_character_data_handler() Ce handler permet d'associer une fonction aux données textuelles (hors des balises)
External Entities xml_set_external_entity_ref_handler() Ce gestionnaire intercepte les appels à des entités externes
Unparsed external entities xml_set_unparsed_entity_decl_handler() Affecte les gestionnaires d'entités non déclarées de l'analyseur XML
Processing instructions xml_set_processing_instruction_handler() Permet d'intercepter l'occurence d'une instructrion de traitement (PI, processing instruction)
Notation declarations xml_set_notation_decl_handler() Gère les occurences de déclarations de notation
default xml_set_default_handler() Permet de gérer tous les événements pour lesquels aucun gestionnaire n'a été défini

Toutes ces fonctions de gestion des événements prennent comme premier argument l'instance du parseur qui a été renvoyée par la fonction xml_create_handler().

Prenons l'exemple de la fonction xml_set_element_handler(). Cette fonction nécessite trois arguments :

Les fonctions de gestion des événements définies par l'utilisateur doivent exister avant de commencer à parser le document. De plus leurs définitions doit concorder exactement avec le prototype défini dans le manuel PHP (http://www.php.net).

Par exemple la fonction chargée de gérer l'événement "balise ouvrante" doit comporter trois paramètres :


function ouverture ($parser, $name, $attrs){
 echo "$name<BR>"; 
}
Son nom et le nom de ses attributs peuvent être modifiés mais le nombre de ses arguments et leur ordre doit être conforme au manuel PHP. Dans le cas de la fonction associée à l'ouverture de balise, le premier argument est l'identifiant de l'instance du parseur, le second est le nom de la balise rencontrée (pour une balise <Debut> sa valeur sera "Debut") et le troisième est un tableau associatif contenant tous les noms des attributs de cet élément et leur valeur.

Voici certains gestionnaires d'événement que nous allons définir

Il suffit ensuite d'utiliser les fonctions XML fournies par PHP (appelés gestionnaires d'événement ou en anglais event handler) pour associer les fonctions que vous avez définies à des événements XML :

La fonction xml_parser_set_option() permet de définir des options de parsage. Le premier argument est bien évidemment l'instance du parseur. Le second argument peut prendre deux valeurs (0 ou 1, représenté par la constante XML_OPTION_CASE_FOLDING) : cette option est activée par défaut. Le fait de désactiver cette option force le gestionnaire d'événement à transformer les noms des balises en majuscule (il est essentiel de ne pas la désactiver car le XML est sensible à la casse, c'est-à-dire qu'il différencie minuscules et majuscules). Le troisième argument définit quel encodage utiliser dans le parseur XML (ISO-8859-1, US-ASCII ou UTF-8). Par défaut l'encodage est celui de xml_parser_create())

xml_parser_set_option($xml_parseur, XML_OPTION_CASE_FOLDING, true);

Pour parser un fichier XML, il suffit de l'ouvrir en lecture, puis de faire appel à la fonction xml_parse() :

$fp = fopen("essai.xml", "r") or die("
Fichier introuvable. L'analyse a ete suspendue"); while ($fdata = fread($fp, 2048)){ xml_parse($xml_parseur, $data, feof($fp)) or die( sprintf("Erreur XML : %s à la ligne %d\n", xml_error_string(xml_get_error_code($xml_parseur)), xml_get_current_line_number($xml_parseur)) ); }

Si le document XML n'est pas bien formé la fonction xml_parse() renvoie la valeur false

Les fonctions xml_error_string() et xml_get_current_line_number() permettent, en cas d'erreur, d'afficher l'erreur qui a été générée ainsi que le numéro de la ligne du fichier XML où elle se trouve !

Article écrit par Jean-François Pillou


© Copyright 2001 Jean-François Pillou
Ce document issu de CommentCaMarche.net est soumis à la licence GNU FDL.Permission vous est donnée de distribuer, modifier des copies de cette page tant que cette note apparaît clairement.