cvs: phpdoc /fr/functions xml.xml
| From: | Damien Seguy | Date: | Thu, 23 Nov 2000 14:26:51 +0000 |
| Subject: | cvs: phpdoc /fr/functions xml.xml | ||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969333047@lists.php.net to get a copy of this message | ||
dams Thu Nov 23 06:26:51 2000 EDT
Modified files:
/phpdoc/fr/functions xml.xml
Log:
Minors typos.Reshaped and synch.
Index: phpdoc/fr/functions/xml.xml diff -u phpdoc/fr/functions/xml.xml:1.1 phpdoc/fr/functions/xml.xml:1.2 --- phpdoc/fr/functions/xml.xml:1.1 Fri Jul 21 03:27:50 2000 +++ phpdoc/fr/functions/xml.xml Thu Nov 23 06:26:50 2000 @@ -1,1789 +1,2053 @@ - <reference id="ref.xml"> - <title>Analyseur syntaxique XML</title> - <titleabbrev>XML</titleabbrev> - - <partintro> - <sect1 id="xml.partintro"> - <title>Introduction</title> - <sect2 id="xml.intro"> - <title>A propos de XML</title> - <para> - Le langage XML (eXtensible Markup Language (Langage à Balises Etendu)) est - un format structuré de données pour les échanges sur le web. C'est un standard - défini par le consortium World Wide Web (W3C). Plus d'informations à propos - du XML et des technologies afférentes sont accessibles (en anglais) - <ulink url="&url.xml;">&url.xml;</ulink>. - </para> - </sect2> - <sect2 id="xml.install"> - <title>Installation</title> - <para> - Cette extension de PHP utilise <productname>expat</productname>, disponible - à <ulink url="&url.expat;">&url.expat;</ulink>. Le fichier Makefile livré avec - expat ne construit pas par défaut de librairie : il faut utiliser la ligne - suivante : - <programlisting role="makefile"> -libexpat.a: $(OBJS) - ar -rc $@ $(OBJS) - ranlib $@ - </programlisting> - Les sources de expat sont disponibles à -<ulink url="&url.expat.rpm;">&url.expat.rpm;</ulink>. - </para> - <para> - Notez que si vous utilisez Apache-1.3.7 ou plus récent, vous disposez déjà - de la librairie expat. Configurez simplement PHP avec <option role="configure">--with-xml</option> - (sans aucun autre information) et la librairie expat d'Apache sera - automatiquement utilisée. - </para> - <para> - Sous UNIX, lancez la configuration de PHP avec l'option - <option role="configure">--with-xml</option>, la librairie expat étant installée - là oú votre compilateur peut la trouver. - Si vous compilez PHP comme module de PHP 1.3.9 ou plus récent, PHP utilisera - automatiquement le module <productname>expat</productname> livré avec Apache. - Il vous faudra peut être fixer les valeurs des variables d'environnement - <envar>CPPFLAGS</envar> et <envar>LDFLAGS</envar>, si vous avez fait une - installation exotique. - </para> - <para> - Compilez PHP. <emphasis>Tada!</emphasis> C'est fait ! - </para> - </sect2> - - <sect2 id="xml.about"> - <title>A propos de cette extension :</title> - <para> - Cette extension PHP supporte la librairie <productname>expat</productname> de - James Clark sous PHP. Cela vous permettra d'analyser mais pas de valider les - documents XML. Il supporte trois types de codage différents, disponibles aussi - sous PHP: - <literal>US-ASCII</literal>, <literal>ISO-8859-1</literal> et <literal>UTF-8</literal>. - <literal>UTF-16</literal> n'est pas supporté. - </para> - <para> - Cette extension vous permet de créer des - <link linkend="function.xml-parser-create">analyseurs XML</link> - puis de définir des <emphasis>points d'entrée</emphasis> pour chaque événement - XML. Les analyseurs XML disposent de quelques - <link linkend="function.xml-parser-set-option">paramétrages</link>. - </para> - <para> - Les gestionnaires d'évènements XML sont: - <table> - <title>Les gestionnaires d'évènements XML</title> - <tgroup cols="2"> - <thead> - <row> - <entry>Fonction PHP de configuration du gestionnaire</entry> - <entry>Description de l'événement</entry> - </row> - </thead> - <tbody> - <row> - <entry><function>xml_set_element_handler</function></entry> - <entry> - Un événement est généré à chaque fois que l'analyseur XML rencontre une - balise de début ou de fin. Deux gestionnaires sont disponibles : un - pour le début, et un pour la fin. - </entry> - </row> - <row> - <entry> - <function>xml_set_character_data_handler</function> - </entry> - <entry> - "Character data" correspond grosso modo à tout ce qui n'est pas une - balise XML, y compris les espaces entre les balises. Notez bien que - l'analyseur XML n'ajoute ou n'efface aucun espace, et que c'est à - l'application (c'est à dire vous) de décider de la signification de ces - espaces. - </entry> - </row> - <row> - <entry> - <function>xml_set_processing_instruction_handler</function> - </entry> - <entry> - Les programmeurs PHP sont habitués aux instructions exécutables - (processing instructions ou PIs). <?php ?> est une instruction - exécutable oú php est appelé programme cible. Ces instructions sont - gérées de manière spécifiques, (sauf le programme cible, qui est - réservé à XML). - </entry> - </row> - <row> - <entry><function>xml_set_default_handler</function></entry> - <entry> - Tout ce qui n'a pas trouvé de gestionnaire est transmis au gestionnaire - par défaut. Vous retrouverez par exemple, les déclarations de type - de document dans ce gestionnaire. - </entry> - </row> - <row> - <entry> - <function>xml_set_unparsed_entity_decl_handler</function> - </entry> - <entry> - Ce gestionnaire est appelé pour gérer les déclaration des entités - non analysés. - </entry> - </row> - <row> - <entry> - <function>xml_set_notation_decl_handler</function> - </entry> - <entry> - Ce gestionnaire est appelé pour gérer les notations. - </entry> - </row> - <row> - <entry> - <function>xml_set_external_entity_ref_handler</function> - </entry> - <entry> - Ce gestionnaire est appelé lorsque l'analyseur XML trouve une référence - à un fichier externe. Cela peut être un fichier, ou une URL. Reportez - vous à <link linkend="example.xml-external-entity">entité externe</link> - pour un exemple. - </entry> - </row> - </tbody> - </tgroup> - </table> - </para> - </sect2> - - <sect2 id="xml.case-folding"> - <title>Problèmes de casse</title> - <para> - Les fonctions de gestion des balises peuvent rencontrer des balises en - minuscule, majuscule ou encore dans un mélange des deux. En XML, la procédure - standard est d' "identifier les séquences de caractère qui ne sont pas - reconnues comme majuscule, et de les remplacer par leur équivalent majuscule". - En d'autres termes, XML met toutes lettres en majuscules. - </para> - <para> - Par défaut, tous les noms des éléments qui sont transmis aux fonctions de - gestion sont mises en majuscule. Ce comportement est contrôlé par l'analyseur - XML, et peut être lu et modifié avec les fonctions respectives - <function>xml_parser_get_option</function> et <function>xml_parser_set_option</function>, - respectivement. - </para> - </sect2> - - <sect2 id="xml.error-codes"> - <title>Error Codes</title> - <para> - Les constantes suivantes sont définies comme des codes d'erreurs XML : - (retournée par <function>xml_parse</function>): - <simplelist> - <member>XML_ERROR_NONE</member> - <member>XML_ERROR_NO_MEMORY</member> - <member>XML_ERROR_SYNTAX</member> - <member>XML_ERROR_NO_ELEMENTS</member> - <member>XML_ERROR_INVALID_TOKEN</member> - <member>XML_ERROR_UNCLOSED_TOKEN</member> - <member>XML_ERROR_PARTIAL_CHAR</member> - <member>XML_ERROR_TAG_MISMATCH</member> - <member>XML_ERROR_DUPLICATE_ATTRIBUTE</member> - <member>XML_ERROR_JUNK_AFTER_DOC_ELEMENT</member> - <member>XML_ERROR_PARAM_ENTITY_REF</member> - <member>XML_ERROR_UNDEFINED_ENTITY</member> - <member>XML_ERROR_RECURSIVE_ENTITY_REF</member> - <member>XML_ERROR_ASYNC_ENTITY</member> - <member>XML_ERROR_BAD_CHAR_REF</member> - <member>XML_ERROR_BINARY_ENTITY_REF</member> - <member>XML_ERROR_ATTRIBUTE_EXTERNAL_ENTITY_REF</member> - <member>XML_ERROR_MISPLACED_XML_PI</member> - <member>XML_ERROR_UNKNOWN_ENCODING</member> - <member>XML_ERROR_INCORRECT_ENCODING</member> - <member>XML_ERROR_UNCLOSED_CDATA_SECTION</member> - <member>XML_ERROR_EXTERNAL_ENTITY_HANDLING</member> - </simplelist> - </para> - </sect2> - <sect2 id="xml.encoding"> - <title>Codage des caractères</title> - <para> - L'extension XML de PHP supporte les caractères - <ulink url="&url.unicode;">Unicode</ulink> grâce à différents codages. Il y - a deux types de codages de caractères : le codage à la source et le codage à la - cible. PHP utilise le <literal>UTF-8</literal> comme représentation interne. - </para> - <para> - L'encodage à la source est effectué lors de - <link linkend="function.xml-parse">l'analyse</link> du fichier par XML. - Lors de la <link linkend="function.xml-parser-create"> création d'un analyseur - XML</link>), un type de codage à la source doit être spécifié (et il ne pourra - plus être modifié jusqu'à la destruction de l'analyseur). Les codages supportés - sont : <literal>ISO-8859-1</literal>, <literal>US-ASCII</literal> et - <literal>UTF-8</literal>. Les deux derniers sont des codages à un seul octet, - c'est à dire que les caractères sont représentés sur un seul octet. - <literal>UTF-8</literal> peut représenter des caractères composés par un - nombre variable de bits (jusqu'à 21), allant de 1 à quatre octets. - Le codage par défaut utilisé par PHP <literal>ISO-8859-1</literal>. - </para> - <para> - Le codage à la cible est effectué lorsque PHP transfert les données aux - gestionnaires XML. Lorsqu'un analyseur est créé, le codage à la cible est - spécifié de la même façon que le codage à la source, mais il peut être modifié - à tout moment. Le codage à la cible affectera les balises, tout comme les - données brutes, et les noms des instructions exécutables. - </para> - <para> - Si l'analyseur XML rencontre un caractère qu'il ne connaît pas (hors limite, - par exemple), il retournera une erreur. - </para> - <para> - Si PHP rencontre un caractère dans le document XML analysé, qu'il ne peut pas - représenter dans le codage à la cible choisi, le caractère sera remplacé par un - point d'interrogation (cette attitude est suceptible de changer ultérieurement). - </para> - </sect2> - </sect1> - - <sect1 id="xml.examples"> - <title>Quelques exemples</title> - <para> - Voici une liste d'exemple de code PHP qui analyse un document XML. - </para> - <sect2 id="example.xml-structure"> - <title>Exemple de structure XML</title> - <para> - Ce premier exemple affiche la structure de l'élément de début dans un document - avec indentation/ - <example> - <title>Afficher une structure XML</title> - <programlisting role="php"> -$file = "data.xml"; -$depth = array(); - -function startElement($parser, $name, $attrs) { - global $depth; - for ($i = 0; $i < $depth[$parser]; $i++) { - print " "; - } - print "$name\n"; - $depth[$parser]++; -} - -function endElement($parser, $name) { - global $depth; - $depth[$parser]--; -} - -$xml_parser = xml_parser_create(); -xml_set_element_handler($xml_parser, "startElement", "endElement"); -if (!($fp = fopen($file, "r"))) { - die("could not open XML input"); -} - -while ($data = fread($fp, 4096)) { - if (!xml_parse($xml_parser, $data, feof($fp))) { - die(sprintf("XML error: %s at line %d", - xml_error_string(xml_get_error_code($xml_parser)), - xml_get_current_line_number($xml_parser))); - } -} -xml_parser_free($xml_parser); - </programlisting> - </example> - </para> - </sect2> - - <sect2 id="example.xml-map-tags"> - <title>XML Transtypage XML -> HTML</title> - <para> - <example> - <title>XML Transtypage XML -> HTML</title> - <para> - Cet exemple remplace les balises XML d'un document par des balises - HTML. Les éléments inconnus seront ignorés. Bien entendu, cet exemple - sera appliqué à un type précis de fichiers XML. - <programlisting role="php"> -$file = "data.xml"; -$map_array = array( - "BOLD" => "B", - "EMPHASIS" => "I", - "LITERAL" => "TT" -); - -function startElement($parser, $name, $attrs) { - global $map_array; - if ($htmltag = $map_array[$name]) { - print "<$htmltag>"; - } -} - -function endElement($parser, $name) { - global $map_array; - if ($htmltag = $map_array[$name]) { - print "</$htmltag>"; - } -} - -function characterData($parser, $data) { - print $data; -} - -$xml_parser = xml_parser_create(); -// use case-folding so we are sure to find the tag in $map_array -xml_parser_set_option($xml_parser, XML_OPTION_CASE_FOLDING, TRUE); -xml_set_element_handler($xml_parser, "startElement", "endElement"); -xml_set_character_data_handler($xml_parser, "characterData"); -if (!($fp = fopen($file, "r"))) { - die("could not open XML input"); -} - -while ($data = fread($fp, 4096)) { - if (!xml_parse($xml_parser, $data, feof($fp))) { - die(sprintf("XML error: %s at line %d", - xml_error_string(xml_get_error_code($xml_parser)), - xml_get_current_line_number($xml_parser))); - } -} -xml_parser_free($xml_parser); - </programlisting> - </para> - </example> - </para> - </sect2> - - <sect2 id="example.xml-external-entity"> - <title>XML Entitée externe</title> - <para> -Cet exemple exploite les références externes de XML : il est possible d'utiliser un gestionnaire d'entité externe pour inclure et analyser les documents, tous comme les instructions exécutables peuvent servir à inclure et analyser d'autres documents, et aussi fournir une indication de confiance (voir plus bas). - </para> - <para> - Le document XML qui est utilisé dans cet exemple est fourni plus loin dans - l'exemple (<filename>xmltest.xml</filename> et <filename>xmltest2.xml</filename>). - </para> - <para> - <example> - <title>Entitée externe</title> - <programlisting role="php"> -$file = "xmltest.xml"; - -function trustedFile($file) { - // only trust local files owned by ourselves - if (!eregi("^([a-z]+)://", $file) - && fileowner($file) == getmyuid()) { - return TRUE; - } - return FALSE; -} - -function startElement($parser, $name, $attribs) { - print "&lt;<font color=\"#0000cc\">$name</font>"; - if (sizeof($attribs)) { - while (list($k, $v) = each($attribs)) { - print " <font color=\"#009900\">$k</font>=\"<font - color=\"#990000\">$v</font>\""; - } - } - print "&gt;"; -} - -function endElement($parser, $name) { - print "&lt;/<font color=\"#0000cc\">$name</font>&gt;"; -} - -function characterData($parser, $data) { - print "<b>$data</b>"; -} - -function PIHandler($parser, $target, $data) { - switch (strtolower($target)) { - case "php": - global $parser_file; - // If the parsed document is "trusted", we say it is safe - // to execute PHP code inside it. If not, display the code - // instead. - if (trustedFile($parser_file[$parser])) { - eval($data); - } else { - printf("Untrusted PHP code: <i>%s</i>", - htmlspecialchars($data)); - } - break; - } -} - -function defaultHandler($parser, $data) { - if (substr($data, 0, 1) == "&" && substr($data, -1, 1) == ";") { - printf('<font color="#aa00aa">%s</font>', - htmlspecialchars($data)); - } else { - printf('<font size="-1">%s</font>', - htmlspecialchars($data)); - } -} - -function externalEntityRefHandler($parser, $openEntityNames, $base, $systemId, - $publicId) { - if ($systemId) { - if (!list($parser, $fp) = new_xml_parser($systemId)) { - printf("Could not open entity %s at %s\n", $openEntityNames, - $systemId); - return FALSE; - } - while ($data = fread($fp, 4096)) { - if (!xml_parse($parser, $data, feof($fp))) { - printf("XML error: %s at line %d while parsing entity %s\n", - xml_error_string(xml_get_error_code($parser)), - xml_get_current_line_number($parser), $openEntityNames); - xml_parser_free($parser); - return FALSE; - } - } - xml_parser_free($parser); - return TRUE; - } - return FALSE; -} - - -function new_xml_parser($file) { - global $parser_file; - - $xml_parser = xml_parser_create(); - xml_parser_set_option($xml_parser, XML_OPTION_CASE_FOLDING, 1); - xml_set_element_handler($xml_parser, "startElement", "endElement"); - xml_set_character_data_handler($xml_parser, "characterData"); - xml_set_processing_instruction_handler($xml_parser, "PIHandler"); - xml_set_default_handler($xml_parser, "defaultHandler"); - xml_set_external_entity_ref_handler($xml_parser, "externalEntityRefHandler"); - - if (!($fp = @fopen($file, "r"))) { - return FALSE; - } - if (!is_array($parser_file)) { - settype($parser_file, "array"); - } - $parser_file[$xml_parser] = $file; - return array($xml_parser, $fp); -} - -if (!(list($xml_parser, $fp) = new_xml_parser($file))) { - die("could not open XML input"); -} - -print "<pre>"; -while ($data = fread($fp, 4096)) { - if (!xml_parse($xml_parser, $data, feof($fp))) { - die(sprintf("XML error: %s at line %d\n", - xml_error_string(xml_get_error_code($xml_parser)), - xml_get_current_line_number($xml_parser))); - } -} -print "</pre>"; -print "parse complete\n"; -xml_parser_free($xml_parser); - -?> - </programlisting> - </example> - </para> - <para id="example.xml-xmltest.xml"> - <example> - <title>xmltest.xml</title> - <programlisting role="xml"> -<?xml version='1.0'?> -<!DOCTYPE chapter SYSTEM "/just/a/test.dtd" [ -<!ENTITY plainEntity "FOO entity"> -<!ENTITY systemEntity SYSTEM "xmltest2.xml"> -]> -<chapter> - <TITLE>Title &plainEntity;</TITLE> - <para> - <informaltable> - <tgroup cols="3"> - <tbody> - <row><entry>a1</entry><entry morerows="1">b1</entry><entry>c1</entry></row> - <row><entry>a2</entry><entry>c2</entry></row> - <row><entry>a3</entry><entry>b3</entry><entry>c3</entry></row> - </tbody> - </tgroup> - </informaltable> - </para> - &systemEntity; - <sect1 id="about"> - <title>About this Document</title> - <para> - <!-- this is a comment --> - <?php print 'Hi! This is PHP version '.phpversion(); ?> - </para> - </sect1> -</chapter> - </programlisting> - </example> - </para> - <para id="example.xml-xmltest2.xml"> - This file is included from <filename>xmltest.xml</filename>: - <example> - <title>xmltest2.xml</title> - <programlisting role="xml"> -<?xml version="1.0"?> -<!DOCTYPE foo [ -<!ENTITY testEnt "test entity"> -]> -<foo> - <element attrib="value"/> - &testEnt; - <?php print "This is some more PHP code being executed."; ?> -</foo> - </programlisting> - </example> - </para> - </sect2> - </sect1> - </partintro> - - <refentry id="function.xml-parser-create"> - <refnamediv> - <refname>xml_parser_create</refname> - <refpurpose>Création d'un analyseur XML.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>xml_parser_create</function></funcdef> - <paramdef>string - <parameter><optional>encoding</optional></parameter> - </paramdef> - </funcsynopsis> - <para> - <variablelist> - <varlistentry> - <term><parameter>encoding</parameter> (optional)</term> - <listitem> - <para> - Le codage de caractère de l'analyseur : les codages suivants sont supportés : - <simplelist> - <member><literal>ISO-8859-1</literal> (par défaut)</member> - <member><literal>US-ASCII</literal></member> - <member><literal>UTF-8</literal></member> - </simplelist> - </para> - </listitem> - </varlistentry> - </variablelist> - Cette fonction crée un analyseur XML et retourne une référence sur cet - analyseur pour qu'il puisse être utilisé ultérieurement par d'autres fonctions - XML. Retourne TRUE ou FALSE. - </para> - </refsect1> - </refentry> - - <refentry id="function.xml-set-object"> - <refnamediv> - <refname>xml_set_object</refname> - <refpurpose>Utilise un analyseur XML à l'intérieur d'un objet.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>void <function>xml_set_object</function></funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>object <parameter>&object</parameter></paramdef> - </funcsynopsis> - <para> - Cette fonction rend l'analyseur <parameter>parser</parameter> - utilisable depuis un objet. Toutes les méthodes de callback, affectées par - <function>xml_set_element_handler</function>, seront les méthodes de cet objet. - </para> - <programlisting role="php"> -<?php -class xml { -var $parser; - -function xml() { - $this->parser = xml_parser_create(); - xml_set_object($this->parser,&$this); - xml_set_element_handler($this->parser,"tag_open","tag_close"); - xml_set_character_data_handler($this->parser,"cdata"); -} - -function parse($data) { - xml_parse($this->parser,$data); -} - -function tag_open($parser,$tag,$attributes) { - var_dump($parser,$tag,$attributes); -} - -function cdata($parser,$cdata) { - var_dump($parser,$cdata); -} - -function tag_close($parser,$tag) { - var_dump($parser,$tag); -} - -} // fin de la classe xml - -$xml_parser = new xml(); -$xml_parser->parse("<A ID=\"hallo\">PHP</A>"); -?> - </programlisting> - <para> - <note> - <para> - <function>xml_set_object</function> a été ajouté dans PHP 4.0. - </para> - </note> - </para> - </refsect1> - </refentry> - - <refentry id="function.xml-set-element-handler"> - <refnamediv> - <refname>xml_set_element_handler</refname> - <refpurpose>Affecte les gestionnaires de début et de fin.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int - <function>xml_set_element_handler</function> - </funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string - <parameter>startElementHandler</parameter> - </paramdef> - <paramdef>string - <parameter>endElementHandler</parameter> - </paramdef> - </funcsynopsis> - <para> - Affecte les gestionnaires de début et de fin de l'analyseur XML - <parameter>parser</parameter>. <parameter>startElementHandler</parameter> et - <parameter>endElementHandler</parameter> sont des chaînes qui contiennent les - noms de fonctions qui existent lorsque <function>xml_parse</function> est appelé - pour créer <parameter>parser</parameter>. - </para> - <para> - La fonction <parameter>startElementHandler</parameter> doit - accepter trois paramètres: - <funcsynopsis> - <funcdef><replaceable>startElementHandler</replaceable></funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string <parameter>name</parameter></paramdef> - <paramdef>string <parameter>attribs</parameter></paramdef> - </funcsynopsis> - <variablelist> - <varlistentry> - <term><parameter>parser</parameter></term> - <listitem> - <simpara> - Le premier paramètre, <replaceable>parser</replaceable>, est une référence - sur l'analyseur XML qui appelle cette fonction. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>name</parameter></term> - <listitem> - <simpara> - Le deuxième paramètre, <parameter>name</parameter>, contiens le nom de - l'élément qui a provoqué l'appel du gestionnaire. Si l'analyseur gère la - <link linkend="xml.case-folding">casse</link>, cet élément sera en - majuscule. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>attribs</parameter></term> - <listitem> - <simpara> - Le troisième paramètre, <parameter>attribs</parameter>, contient un tableau - associatif avec les attributs de l'éléments (si il en existe). Les clés de - ce tableau seront les noms des attributs, et les valeurs seront les valeurs - correspondantes des attributs. Les noms des attributs seront mis en - majuscule si l'analyseur gère la <link linkend="xml.case-folding">casse</link>. - Les valeurs des attributs seront intouchées. - </simpara> - <simpara> - L'ordre original des attributs peut être retrouvé en passant en revue le - tableau <parameter>attribs</parameter>, avec la fonction - <function>each</function>. La première clé sera la première clé du - tableau. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - <para> - La fonction <parameter>endElementHandler</parameter> doit accepter deux paramètres: - <funcsynopsis> - <funcdef><replaceable>endElementHandler</replaceable></funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string <parameter>name</parameter></paramdef> - </funcsynopsis> - <variablelist> - <varlistentry> - <term><parameter>parser</parameter></term> - <listitem> - <simpara> - Le premier paramètre, <replaceable>parser</replaceable>, est une référence - sur l'analyseur XML qui appelle cette fonction. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>name</parameter></term> - <listitem> - <simpara> - Le second paramètre, <parameter>name</parameter>, contient le nom de - l'élément qui a provoqué l'appel du gestionnaire. Si l'analyseur gère la - <link linkend="xml.case-folding">casse</link>, cet élément sera en - majuscule. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - <para> - Si un gestionnaire recoit une chaîne vide, ou FALSE, c'est qu'il est en - train d'être désactivé. - </para> - <para> - Retourne TRUE si le gestionnaire est actif, et FALSE sinon, ou si - <parameter>parser</parameter> n'est pas un analyseur. - </para> - <para> - Il n'est pas pour l'instant possible d'utiliser des objets pour servir de - gestionnaire. - </para> - </refsect1> - </refentry> - - <refentry id="function.xml-set-character-data-handler"> - <refnamediv> - <refname>xml_set_character_data_handler</refname> - <refpurpose>Affecte les gestionnaires de caractère bruts.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int - <function>xml_set_character_data_handler</function> - </funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string <parameter>handler</parameter></paramdef> - </funcsynopsis> - <para> - Affecte les gestionnaires de début et de fin de l'analyseur XML - <parameter>parser</parameter>. <parameter>handler</parameter> est une chaîne qui - contient le nom d'une fonction qui existe lorsque <function>xml_parse</function> - est appelé pour créer <parameter>parser</parameter>. - </para> - <para> - La fonction <parameter>handler</parameter> doit accepter deux paramètres: - <funcsynopsis> - <funcdef><replaceable>handler</replaceable></funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string <parameter>data</parameter></paramdef> - </funcsynopsis> - <variablelist> - <varlistentry> - <term><parameter>parser</parameter></term> - <listitem> - <simpara> - Le premier paramètre, <replaceable>parser</replaceable>, est une référence - sur l'analyseur XML qui appelle cette fonction. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>data</parameter></term> - <listitem> - <simpara> - Le second paramètre, <parameter>data</parameter>, contient les caractères - sous la forme d'une chaîne. - </simpara> - </listitem> - </varlistentry> - </variablelist></para> - <para> - Si un gestionnaire reçoit une chaîne vide ou FALSE, c'est qu'il est en train - d'être désactivé. - </para> - <para> - Retourne TRUE si le gestionnaire est actif, et FALSE sinon, ou si - <parameter>parser</parameter> n'est pas un analyseur. - </para> - <para> - Il n'est pas pour l'instant possible d'utiliser des objets pour servir de - gestionnaire. - </para> - </refsect1> - </refentry> - - <refentry id="function.xml-set-processing-instruction-handler"> - <refnamediv> - <refname>xml_set_processing_instruction_handler</refname> - <refpurpose> - Affecte les gestionnaires d'instructions exécutables. - .</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int - <function>xml_set_processing_instruction_handler</function> - </funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string <parameter>handler</parameter></paramdef> - </funcsynopsis> - <para> - Affecte les gestionnaires d'instructions exécutables de l'analyseur XML - <parameter>parser</parameter>. <parameter>handler</parameter> est une chaîne - qui contient le nom d'une fonction qui existe lorsque <function>xml_parse</function> - est appelé pour créer <parameter>parser</parameter>. - </para> - <para> - Une instruction exécutable a la forme suivante :: - <informalexample> - <programlisting><? - <replaceable>target</replaceable> - <replaceable>data</replaceable>?> - </programlisting> - </informalexample> - Vous pouvez mettre du code PHP entre ces balises, mais soyez conscient d'une - des limitations des instructions exécutables de XML : la balise de fin - d'instruction éxécutable (<literal>?></literal>) ne peut être échappée, ce - qui fait que cette séquence NE DOIT JAMAIS apparaître dans le code PHP placé - dans le document PHP. Si un tel texte apparaît, la balise de fin d'instruction - exécutable sera reconnue, et le reste du code sera considéré comme des données - brutes (et donc, pas exécutées). - </para> - <para> - La fonction <parameter>handler</parameter> doit accepter trois paramètres: - <funcsynopsis> - <funcdef><replaceable>handler</replaceable></funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string <parameter>target</parameter></paramdef> - <paramdef>string <parameter>data</parameter></paramdef> - </funcsynopsis> - <variablelist> - <varlistentry> - <term><parameter>parser</parameter></term> - <listitem><simpara> - Le premier paramètre, <replaceable>parser</replaceable>, est une référence - sur l'analyseur XML qui appelle cette fonction. - </simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>target</parameter></term> - <listitem><simpara> - Le second paramètre, <parameter>target</parameter>, contient l'application - cible. - </simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>data</parameter></term> - <listitem><simpara> - Le troisième paramètre, <parameter>data</parameter>, contient le code sous la - forme d'une chaîne. - </simpara></listitem> - </varlistentry> - </variablelist></para> - <para> - Si un gestionnaire reçoit une chaîne vide, ou FALSE, c'est qu'il est en train - d'être désactivé. - </para> - <para> - Retourne TRUE si le gestionnaire est actif, et FALSE sinon, ou si - <parameter>parser</parameter> n'est pas un analyseur. - </para> - <para> - Il n'est pas pour l'instant possible d'utiliser des objets pour servir de - gestionnaire. - </para> - </refsect1> - </refentry> - - <refentry id="function.xml-set-default-handler"> - <refnamediv> - <refname>xml_set_default_handler</refname> - <refpurpose>Affecte le gestionnaire par défaut.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int - <function>xml_set_default_handler</function> - </funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string <parameter>handler</parameter></paramdef> - </funcsynopsis> - <para> - Affecte le gestionnaire par défaut de l'analyseur XML - <parameter>parser</parameter>. <parameter>handler</parameter> est une chaîne qui - contient le nom d'une fonction qui existe lorsque <function>xml_parse</function> - est appelé pour créer <parameter>parser</parameter>. - </para> - <para> - La fonction <parameter>handler</parameter> doit accepter deux paramètres: - <funcsynopsis> - <funcdef><replaceable>handler</replaceable></funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string <parameter>data</parameter></paramdef> - </funcsynopsis> - <variablelist> - <varlistentry> - <term> - <parameter>parser</parameter> - </term> - <listitem> - <simpara> - Le premier paramètre, <replaceable>parser</replaceable>, est une référence sur - l'analyseur XML qui appelle cette fonction. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>data</parameter> - </term> - <listitem> - <simpara> - Le second paramètre, <parameter>data</parameter>, contient les caractères - sous la forme d'une chaîne. Cela peut être une déclaration XML, un type de - document, une entité ou d'autre données pour qui aucun gestionnaire n'est - prévu. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - <para> - Si un gestionnaire reçoit une chaîne vide ou FALSE, c'est qu'il est en train - d'être désactivé. - </para> - <para> - Retourne TRUE si le gestionnaire est actif, et FALSE sinon, ou si - <parameter>parser</parameter> n'est pas un analyseur. - </para> - <para> - Il n'est pas pour l'instant possible d'utiliser des objets pour servir de - gestionnaire. - </para> - </refsect1> - </refentry> - - <refentry id="function.xml-set-unparsed-entity-decl-handler"> - <refnamediv> - <refname>xml_set_unparsed_entity_decl_handler</refname> - <refpurpose> - Affecte les gestionnaires d'entité non déclaré. - .</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int - <function>xml_set_unparsed_entity_decl_handler</function> - </funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string <parameter>handler</parameter></paramdef> - </funcsynopsis> - <para> - Affecte les gestionnaires d'entité non déclaré de l'analyseur XML - <parameter>parser</parameter>. <parameter>handler</parameter> est une chaîne qui - contient le nom d'une fonction qui existe lorsque <function>xml_parse</function> - est appelé pour créer <parameter>parser</parameter>. - </para> - <para> - Ce gestionnaire sera appelé si l'analyseur XML rencontre une déclaration - d'entité externe avec une déclaration de NDATA, comme suit : - <programlisting role="xml"> -<!ENTITY <parameter>name</parameter> {<parameter>publicId</parameter> | <parameter>systemId</parameter>} - NDATA <parameter>notationName</parameter>> - </programlisting> - </para> - <para> - Reportez vous à la - <ulink url="&url.rec-xml;#sec-external-ent">section 4.2.2 des spécifications XML 1.0</ulink> - pour connaître les notations des entités externes. - </para> - <para> - La fonction <parameter>handler</parameter> doit accepter six paramètres: - <funcsynopsis> - <funcdef><replaceable>handler</replaceable></funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string <parameter>entityName</parameter></paramdef> - <paramdef>string <parameter>base</parameter></paramdef> - <paramdef>string <parameter>systemId</parameter></paramdef> - <paramdef>string <parameter>publicId</parameter></paramdef> - <paramdef>string <parameter>notationName</parameter></paramdef> - </funcsynopsis> - <variablelist> - <varlistentry> - <term><parameter>parser</parameter></term> - <listitem> - <simpara> - Le premier paramètre, <replaceable>parser</replaceable>, est une référence - sur l'analyseur XML qui appelle cette fonction. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>entityName</parameter></term> - <listitem> - <simpara> - Le nom de l'entitée qui va être définie - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>base</parameter></term> - <listitem><simpara> - La meilleure base de résolution de l'identifiant système de cette entité - externe. Actuellement, ce paramètre est toujours une chaîne vide. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>systemId</parameter></term> - <listitem> - <simpara> - Identifiant système pour cet entité externe. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>publicId</parameter></term> - <listitem> - <simpara> - Identifiant public pour cet entité externe. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>notationName</parameter></term> - <listitem> - <simpara> - Nom de la notation de cette entité. (Voir <function>xml_set_notation_decl_handler</function>). - </simpara> - </listitem> - </varlistentry> - </variablelist></para> - <para> - Si un gestionnaire reçoit une chaîne vide ou FALSE, c'est qu'il est en train - d'être désactivé. - </para> - <para> - Retourne TRUE si le gestionnaire est actif, et FALSE sinon, ou si - <parameter>parser</parameter> n'est pas un analyseur. - </para> - <para> - Il n'est pas pour l'instant possible d'utiliser des objets pour servir de - gestionnaire. - </para> - </refsect1> - </refentry> - - <refentry id="function.xml-set-notation-decl-handler"> - <refnamediv> - <refname>xml_set_notation_decl_handler</refname> - <refpurpose>Affecte les gestionnaires de notation.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int - <function>xml_set_notation_decl_handler</function> - </funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string <parameter>handler</parameter></paramdef> - </funcsynopsis> - <para> - Affecte les gestionnaires de début et de fin de l'analyseur XML - <parameter>parser</parameter>. <parameter>handler</parameter> est une chaîne qui - contient le nom d'une fonction qui existe lorsque <function>xml_parse</function> - est appelé pour créer <parameter>parser</parameter>. - </para> - <para> - Une notation est une partie du DTD du document, qui a le format suivant : - - <programlisting role="xml"><!NOTATION - <parameter>name</parameter> {<parameter>systemId</parameter> | - <parameter>publicId</parameter>}></programlisting> - Reportez vous à la <ulink url="&url.rec-xml;#sec-external-ent">section 4.2.2 des - spécifications XML 1.0</ulink> pour connaître les notations des entités externes. - </para> - <para> - La fonction <parameter>handler</parameter> doit accepter cinq paramètres: - <funcsynopsis> - <funcdef><replaceable>handler</replaceable></funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string <parameter>notationName</parameter></paramdef> - <paramdef>string <parameter>base</parameter></paramdef> - <paramdef>string <parameter>systemId</parameter></paramdef> - <paramdef>string <parameter>publicId</parameter></paramdef> - </funcsynopsis> - <variablelist> - <varlistentry> - <term> - <parameter>parser</parameter> - </term> - <listitem> - <simpara> - Le premier paramètre, <replaceable>parser</replaceable>, est une référence - sur l'analyseur XML qui appelle cette fonction. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>notationName</parameter></term> - <listitem> - <simpara> - Le nom de la notation,<parameter>name</parameter>, comme précisé dans le - format de notation ci dessus. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>base</parameter> - </term> - <listitem> - <simpara> - La meilleure base de résolution de l'identifiant système de cette entité - externe. Actuellement, ce paramètre est toujours une chaîne vide. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>systemId</parameter></term> - <listitem> - <simpara> - Identifiant système pour cette entitée externe. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>publicId</parameter> - </term> - <listitem> - <simpara> - Identifiant public pour cet entité externe. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <para> - Si un gestionnaire reçoit une chaîne vide ou FALSE, c'est qu'il est en train - d'être désactivé. - </para> - <para> - Retourne TRUE si le gestionnaire est actif, et FALSE sinon ou si - <parameter>parser</parameter> n'est pas un analyseur. - </para> - <para> - Il n'est pas pour l'instant possible d'utiliser des objets pour servir de - gestionnaires. - </para> - </refsect1> - </refentry> - - <refentry id="function.xml-set-external-entity-ref-handler"> - <refnamediv> - <refname>xml_set_external_entity_ref_handler</refname> - <refpurpose>Fixe le gestionnaire de référence externes.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int - <function>xml_set_external_entity_ref_handler</function> - </funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string <parameter>handler</parameter></paramdef> - </funcsynopsis> - <para> - Fixe le gestionnaire d'entité externe de l'analyseur XML - <parameter>parser</parameter>. <parameter>handler</parameter> et - <parameter>endElementHandler</parameter> sont des chaînes qui contiennent les - noms de fonction qui existent lorsque <function>xml_parse</function> est appelé - pour créer le <parameter>parser</parameter>. - </para> - <para> - La fonction <parameter>handler</parameter> doit accepter 5 paramètres, et - retourner un entier. Si la valeur retourné par le gestionnaire est - FALSE (comme par exemple si aucune valeur n'est retournée), l'analyseur XML - s'arrêtera, et la fonction <function>xml_get_error_code</function> retournera - <systemitem class="constant">XML_ERROR_EXTERNAL_ENTITY_HANDLING</systemitem>. - - <funcsynopsis> - <funcdef>int <replaceable>handler</replaceable></funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string - <parameter>openEntityNames</parameter> - </paramdef> - <paramdef>string <parameter>base</parameter></paramdef> - <paramdef>string <parameter>systemId</parameter></paramdef> - <paramdef>string <parameter>publicId</parameter></paramdef> - </funcsynopsis> - <variablelist> - <varlistentry> - <term><parameter>parser</parameter></term> - <listitem> - <simpara> - Le premier paramètre,<replaceable>parser</replaceable>, est une référence sur - l'analyseur XML qui appelle cette fonction. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>openEntityNames</parameter></term> - <listitem> - <simpara> - Le deuxième paramètre, <parameter>openEntityNames</parameter>, est i.e. - liste de noms d'entité, séparés par des espaces. Ces entités sont - accessibles à l'analyse par cet entité (y compris le nom de l'entité - reférencé). - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>base</parameter></term> - <listitem> - <simpara> - La meilleure base de résolution de l'identifiant système de cet entité - externe. Actuellement, ce paramètre est toujours une chaîne vide. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>systemId</parameter></term> - <listitem> - <simpara> - Identifiant système pour cet entité externe. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>publicId</parameter></term> - <listitem> - <simpara> - Le cinquième paramètre, <parameter>publicId</parameter>, est l'identifiant - public, comme spécifié dans la déclaration d'entité, ou un chaîne vide, si - aucune déclaration n'a été spécifiée. L'espace dans l'identifiant public - sera normalisé comme spécifié dans les spécifications XML. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - <para> - Si un gestionnaire reçoit une chaîne vide, ou FALSE, c'est qu'il est en train - d'être désactivé. - </para> - <para> - Retourne TRUE si le gestionnaire est actif, et FALSE sinon ou si - <parameter>parser</parameter> n'est pas un analyseur. - </para> - <para> - Il n'est pas pour l'instant possible d'utiliser des objets pour servir de - gestionnaire. - </para> - </refsect1> - </refentry> - - <refentry id="function.xml-parse"> - <refnamediv> - <refname>xml_parse</refname> - <refpurpose>Commence l'analyse d'un fichier XML.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>xml_parse</function></funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string <parameter>data</parameter></paramdef> - <paramdef>int - <parameter><optional>isFinal</optional></parameter> - </paramdef> - </funcsynopsis> - <para> - <variablelist> - <varlistentry> - <term><parameter>parser</parameter></term> - <listitem> - <simpara> - une référence sur l'analyseur XML à utiliser. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>data</parameter></term> - <listitem> - <simpara> - Une partie des données à analyser. Un document peut être analysé morceau - par morceau, en appelant <function>xml_parse</function> plusieurs fois, - tant que le paramètre <parameter>isFinal</parameter> est mis à TRUE pour - le dernier morceau. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>isFinal</parameter> (optional)</term> - <listitem> - <simpara> - Si il vaut TRUE, <parameter>data</parameter> est la dernière partie - à analyser. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - <para> - Lorsqu'un document XML est analysé, les gestionnaires d'événements sont appelés - aussi souvent que nécessaire, et retourne TRUE ou FALSE. - </para> - <para> - TRUE est retourné lorsque l'analyse a été concluante, et FALSE en cas d'échec, - ou si <parameter>parser</parameter> n'est pas un analyseur valide. - Lors d'un échec d'analyse, la cause de l'erreur peut être obtenue grâce aux - fonctions <function>xml_get_error_code</function>, <function>xml_error_string</function>, - <function>xml_get_current_line_number</function>, <function>xml_get_current_column_number</function> - et <function>xml_get_current_byte_index</function>. - </para> - </refsect1> - </refentry> - - <refentry id="function.xml-get-error-code"> - <refnamediv> - <refname>xml_get_error_code</refname> - <refpurpose>Retourne le nombre courant de colonne d'un analyseur XML.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>xml_get_error_code</function></funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - </funcsynopsis> - <para> - <variablelist> - <varlistentry> - <term><parameter>parser</parameter></term> - <listitem> - <simpara> - Cette fonction retourne FALSE si <parameter>parser</parameter> n'est pas - valide, ou sinon, retourne le numéro de colonne courante de la ligne courante - de l'analyseur, qui correspond à la position d'analyse courante de l'analyseur - XML. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - <para> - Cette fonction retourne FALSE si <parameter>parser</parameter> n'est pas valide, - ou sinon, retourne le numéro de colonne courante de la ligne courante de - l'analyseur, qui correspond à la position d'analyse courante de l'analyseur XML. - </para> - </refsect1> - </refentry> - - <refentry id="function.xml-error-string"> - <refnamediv> - <refname>xml_error_string</refname> - <refpurpose>Lit le message d'erreur de l'analyseur XML.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>string <function>xml_error_string</function></funcdef> - <paramdef>int <parameter>code</parameter></paramdef> - </funcsynopsis> - <para> - <variablelist> - <varlistentry> - <term><parameter>code</parameter></term> - <listitem> - <simpara> - Un message d'erreur, issu de <function>xml_get_error_code</function>. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - <para> - Retourne la chaîne avec un message textuel, décrivant l'erreur - <parameter>code</parameter>, ou FALSE si aucune description n'a été trouvée. - </para> - </refsect1> - </refentry> - - <refentry id="function.xml-get-current-line-number"> - <refnamediv> - <refname>xml_get_current_line_number</refname> - <refpurpose>Retourne le numéro de ligne courant d'un analyseur XML.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int - <function>xml_get_current_line_number</function> - </funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - </funcsynopsis> - <para> - <variablelist> - <varlistentry> - <term><parameter>parser</parameter></term> - <listitem> - <simpara> - Une référence sur un analyseur XML valide. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - <para> - Cette fonction retourne FALSE si <parameter>parser</parameter> n'est pas valide, - ou sinon, retourne le numéro de la ligne en cours d'analyse. - </para> - </refsect1> - </refentry> - - <refentry id="function.xml-get-current-column-number"> - <refnamediv> - <refname>xml_get_current_column_number</refname> - <refpurpose> - Retourne le nombre courant de colonne d'un analyseur XML. - .</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int - <function>xml_get_current_column_number</function> - </funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - </funcsynopsis> - <para> - <variablelist> - <varlistentry> - <term><parameter>parser</parameter></term> - <listitem> - <simpara> - Une référence sur un analyseur XML valide. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - <para> - Cette fonction retourne FALSE si <parameter>parser</parameter> n'est pas valide, - ou sinon, retourne le numéro de colonne courante de la ligne courante de - l'analyseur, qui correspond à la position d'analyse courante de l'analyseur XML. - </para> - </refsect1> - </refentry> - - <refentry id="function.xml-get-current-byte-index"> - <refnamediv> - <refname>xml_get_current_byte_index</refname> - <refpurpose>Retourne l'index de l'octet courant d'un analyseur XML.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int - <function>xml_get_current_byte_index</function> - </funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - </funcsynopsis> - <para> - <variablelist> - <varlistentry> - <term><parameter>parser</parameter></term> - <listitem> - <simpara> - Une référence sur un analyseur XML valide. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - <para> - Cette fonction retourne FALSE si <parameter>parser</parameter> n'est pas valide, - ou sinon, retourne l'index de l'octet d'analyse courante de l'analyseur XML. - </para> - </refsect1> - </refentry> - - <refentry id="function.xml-parser-free"> - <refnamediv> - <refname>xml_parser_free</refname> - <refpurpose> Détruit un analyseur XML.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>string <function>xml_parser_free</function></funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - </funcsynopsis> - <para> - <variablelist> - <varlistentry> - <term><parameter>parser</parameter></term> - <listitem> - <simpara> - Une référence sur un analyseur XML. - </simpara> - </listitem> - </varlistentry> - </variablelist></para> - <para> - Cette fonction retourne FALSE si <parameter>parser</parameter> n'est pas une - référence valide, ou sinon, détruit l'analyseur et retourne TRUE. - </para> - </refsect1> - </refentry> - - <refentry id="function.xml-parser-set-option"> - <refnamediv> - <refname>xml_parser_set_option</refname> - <refpurpose>Affecte les options d'un analyseur XML.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>xml_parser_set_option</function></funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>int <parameter>option</parameter></paramdef> - <paramdef>mixed <parameter>value</parameter></paramdef> - </funcsynopsis> - <para> - <variablelist> - <varlistentry> - <term><parameter>parser</parameter></term> - <listitem> - <simpara> - Une référence vers un analyseur XML. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>option</parameter></term> - <listitem> - <simpara> - L'option à modifier. Voir ci dessous : - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>value</parameter></term> - <listitem> - <simpara> - La nouvelle valeur de l'option. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - <para> - Cette fonction retourne FALSE si <parameter>parser</parameter> n'est pas une - référence valide sur un analyseur XML, ou si l'option n'a pas pu être modifiée. - Sinon, l'option est effectivement modifiée, et la fonction retourne TRUE. - </para> - <para> - Les options suivantes sont disponibles : - <table> - <title>options d'analyseur XML </title> - <tgroup cols="3"> - <thead> - <row> - <entry>Option</entry> - <entry>Type de données</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>XML_OPTION_CASE_FOLDING</entry> - <entry>entier</entry> - <entry> - Contrôle la gestion de la <link linkend="xml.case-folding">casse</link> - des balises de cet analyseur XML. Par défaut, activé. - </entry> - </row> - <row> - <entry>XML_OPTION_TARGET_ENCODING</entry> - <entry>string</entry> - <entry> - Modifie le <link linkend="xml.encoding">codage à la cible</link> - utilisé par cet analyseur XML. Par défaut, c'est celui qui a été spécifié - lors de l'appel de <function>xml_parser_create</function>. - Les codages supportés sont <literal>ISO-8859-1</literal>, <literal>US-ASCII</literal> - et <literal>UTF-8</literal>. - </entry> - </row> - </tbody> - </tgroup> - </table> - </para> - </refsect1> - </refentry> - - <refentry id="function.xml-parser-get-option"> - <refnamediv> - <refname>xml_parser_get_option</refname> - <refpurpose>Lit les options d'un analyseur XML.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>mixed - <function>xml_parser_get_option</function> - </funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>int <parameter>option</parameter></paramdef> - </funcsynopsis> - <para> - <variablelist> - <varlistentry> - <term><parameter>parser</parameter></term> - <listitem> - <simpara> - Une référence sur un analyseur XML valide. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>option</parameter></term> - <listitem> - <simpara> - L'option demandée. Reportez vous à <function>xml_parser_set_option</function> - pour avoir la liste des options disponibles - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - <para> - Cette fonction retourne FALSE si <parameter>parser</parameter> n'est pas valide, - ou sinon, retourne la valeur de l'option demandée. - </para> - <para> - Reportez vous à <function>xml_parser_set_option</function> pour avoir la - liste des options disponibles - </para> - </refsect1> - </refentry> - - <refentry id="function.utf8-decode"> - <refnamediv> - <refname>utf8_decode</refname> - <refpurpose> - Converti un une chaîne UTF-8 en ISO-8859 - .</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>string <function>utf8_decode</function></funcdef> - <paramdef>string <parameter>data</parameter></paramdef> - </funcsynopsis> - <para> - Cette fonction décode la chaîne <parameter>data</parameter>, en supposant qu'elle - est au format <literal>UTF-8</literal>, et la convertit au format - <literal>ISO-8859-1</literal>. - </para> - <para> - Voir aussi <function>utf8_encode</function>pour plus de détails sur le codage - <literal>UTF-8</literal>. - </para> - </refsect1> - </refentry> - - <refentry id="function.utf8-encode"> - <refnamediv> - <refname>utf8_encode</refname> - <refpurpose>Convertit un une chaîne ISO-8859-1 en UTF-8.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>string <function>utf8_encode</function></funcdef> - <paramdef>string <parameter>data</parameter></paramdef> - </funcsynopsis> - <para> - Cette fonction code la chaîne data au format <literal>UTF-8</literal>, - et retourne la version codée. <literal>UTF-8</literal> est un mécanisme - standardisé utilisé par Unicode pour coder les caractère de grande taille dans - des flots d'octets. <literal>UTF-8</literal> est transparent pour les caractères - <abbrev>ASCII</abbrev>, il est auto-synchronisé (c'est à dire qu'un programme - peut toujours savoir dans un flot d'octet oú un caractère commence), et peut être - utilisé pour faire des comparaisons de chaînes standard, comme pour le tri. PHP - utilise l'<literal>UTF-8</literal> pour coder les caractères jusqu'à 4 octets - comme ceci : - - <table> - <title>UTF-8 encoding</title> - <tgroup cols="3"> - <thead> - <row> - <entry>octets</entry> - <entry>bits</entry> - <entry>représentation</entry> - </row> - </thead> - <tbody> - <row> - <entry>1</entry> - <entry>7</entry> - <entry>0bbbbbbb</entry> - </row> - <row> - <entry>2</entry> - <entry>11</entry> - <entry>110bbbbb 10bbbbbb</entry> - </row> - <row> - <entry>3</entry> - <entry>16</entry> - <entry>1110bbbb 10bbbbbb 10bbbbbb</entry> - </row> - <row> - <entry>4</entry> - <entry>21</entry> - <entry>11110bbb 10bbbbbb 10bbbbbb 10bbbbbb</entry> - </row> - </tbody> - </tgroup> - </table> - Chaque <replaceable>b</replaceable> représente un bit qui peut être utilisé pour - enregistrer un caractère. - </para> - </refsect1> - </refentry> - - </reference> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -sgml-parent-document:nil -sgml-default-dtd-file:"../../manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: ---> + <reference id="ref.xml"> + <title>Analyseur syntaxique XML</title> + <titleabbrev>XML</titleabbrev> + <partintro> + <sect1 id="xml.partintro"> + <title>Introduction</title> + <sect2 id="xml.intro"> + <title>A propos de XML</title> + <para> + Le langage XML (eXtensible Markup Language (Langage à Balises + Etendu)) est un format structuré de données pour les + échanges sur le web. C'est un standard défini par le + consortium World Wide Web (W3C). Plus d'informations à propos + du XML et des technologies afférentes sont accessibles (en anglais) + <ulink url="&url.xml;">&url.xml;</ulink>. + </para> + </sect2> + <sect2 id="xml.install"> + <title>Installation</title> + <para> + Cette extension de PHP utilise <productname>expat</productname>, + disponible à <ulink url="&url.expat;">&url.expat;</ulink>. + Le fichier Makefile livré avec <productname>expat</productname> + ne construit pas par défaut de librairie : il faut utiliser + la ligne suivante : + <programlisting role="makefile"> +libexpat.a: $(OBJS) + ar -rc $@ $(OBJS) + ranlib $@ + </programlisting> + Les sources RPM de expat sont disponibles à + <ulink url="&url.expat.rpm;">&url.expat.rpm;</ulink>. + </para> + <para> + Notez que si vous utilisez Apache-1.3.7 ou plus récent, vous disposez déjà + de la librairie expat. Configurez simplement PHP avec <option role="configure">--with-xml</option> + (sans aucun autre information) et la librairie expat d'Apache sera + automatiquement utilisée. + </para> + <para> + Sous UNIX, lancez la configuration de PHP avec l'option + <option role="configure">--with-xml</option>, la librairie + <productname>expat</productname> étant installée + là oú votre compilateur peut la trouver. + Si vous compilez PHP comme module de PHP 1.3.9 ou plus récent, + PHP utilisera automatiquement le module <productname>expat</productname> + livré avec Apache. Il vous faudra peut être fixer + les valeurs des variables d'environnement <envar>CPPFLAGS</envar> + et <envar>LDFLAGS</envar>, si vous avez fait une installation exotique. + </para> + <para> + Compilez PHP. <emphasis>Tada!</emphasis> C'est fait ! + </para> + </sect2> + <sect2 id="xml.about"> + <title>A propos de cette extension :</title> + <para> + Cette extension PHP supporte la librairie <productname>expat</productname> + de James Clark sous PHP. Cela vous permettra d'analyser mais + pas de valider les documents XML. Il supporte trois types de + codage différents, disponibles aussi sous PHP: + <literal>US-ASCII</literal>, <literal>ISO-8859-1</literal> et + <literal>UTF-8</literal>. <literal>UTF-16</literal> n'est pas supporté. + </para> + <para> + Cette extension vous permet de créer des + <link linkend="function.xml-parser-create">analyseurs XML</link> + puis de définir des <emphasis>points d'entrée</emphasis> + pour chaque événement XML. Les analyseurs XML disposent + de quelques + <link linkend="function.xml-parser-set-option">paramétrages</link>. + </para> + <para> + Les gestionnaires d'évènements XML sont: + <table> + <title>Les gestionnaires d'évènements XML</title> + <tgroup cols="2"> + <thead> + <row> + <entry>Fonction PHP de configuration du gestionnaire</entry> + <entry>Description de l'événement</entry> + </row> + </thead> + <tbody> + <row> + <entry><function>xml_set_element_handler</function></entry> + <entry> + Un événement est généré + à chaque fois que l'analyseur XML rencontre une balise de + début ou de fin. Deux gestionnaires sont disponibles : un + pour le début, et un pour la fin. + </entry> + </row> + <row> + <entry> + <function>xml_set_character_data_handler</function> + </entry> + <entry> + "Character data" correspond grosso modo à tout ce qui n'est + pas une balise XML, y compris les espaces entre les balises. Notez + bien que l'analyseur XML n'ajoute ou n'efface aucun espace, et que + c'est à l'application (c'est à dire vous) de + décider de la signification de ces espaces. + </entry> + </row> + <row> + <entry> + <function>xml_set_processing_instruction_handler</function> + </entry> + <entry> + Les programmeurs PHP sont habitués aux instructions + exécutables (processing instructions ou PIs). + <?php ?> est une instruction exécutable oú + php est appelé programme cible. Ces instructions sont + gérées de manière spécifiques, + (sauf le programme cible, qui est réservé à XML). + </entry> + </row> + <row> + <entry><function>xml_set_default_handler</function></entry> + <entry> + Tout ce qui n'a pas trouvé de gestionnaire est transmis + au gestionnaire par défaut. Vous retrouverez par exemple, + les déclarations de type de document dans ce gestionnaire. + </entry> + </row> + <row> + <entry> + <function>xml_set_unparsed_entity_decl_handler</function> + </entry> + <entry> + Ce gestionnaire est appelé pour gérer les + déclaration des entités non analysés. + </entry> + </row> + <row> + <entry> + <function>xml_set_notation_decl_handler</function> + </entry> + <entry> + Ce gestionnaire est appelé pour gérer les notations. + </entry> + </row> + <row> + <entry> + <function>xml_set_external_entity_ref_handler</function> + </entry> + <entry> + Ce gestionnaire est appelé lorsque l'analyseur XML trouve une + référence à un fichier externe. Cela peut + être un fichier, ou une URL. Reportez vous à + <link linkend="example.xml-external-entity">entité externe</link> + pour un exemple. + </entry> + </row> + </tbody> + </tgroup> + </table> + </para> + </sect2> + <sect2 id="xml.case-folding"> + <title>Problèmes de casse</title> + <para> + Les fonctions de gestion des balises peuvent rencontrer des balises en + minuscule, majuscule ou encore dans un mélange des deux. En XML, + la procédure standard est d' "identifier les séquences de + caractère qui ne sont pas reconnues comme majuscule, et de les + remplacer par leur équivalent majuscule". En d'autres termes, + XML met toutes lettres en majuscules. + </para> + <para> + Par défaut, tous les noms des éléments qui sont + transmis aux fonctions de gestion sont mises en majuscule. Ce + comportement est contrôlé par l'analyseur XML, et + peut être lu et modifié avec les fonctions respectives + <function>xml_parser_get_option</function> et + <function>xml_parser_set_option</function>, respectivement. + </para> + </sect2> + <sect2 id="xml.error-codes"> + <title>Error Codes</title> + <para> + Les constantes suivantes sont définies comme des codes + d'erreurs XML : (retournée par <function>xml_parse</function>) + <simplelist> + <member>XML_ERROR_NONE</member> + <member>XML_ERROR_NO_MEMORY</member> + <member>XML_ERROR_SYNTAX</member> + <member>XML_ERROR_NO_ELEMENTS</member> + <member>XML_ERROR_INVALID_TOKEN</member> + <member>XML_ERROR_UNCLOSED_TOKEN</member> + <member>XML_ERROR_PARTIAL_CHAR</member> + <member>XML_ERROR_TAG_MISMATCH</member> + <member>XML_ERROR_DUPLICATE_ATTRIBUTE</member> + <member>XML_ERROR_JUNK_AFTER_DOC_ELEMENT</member> + <member>XML_ERROR_PARAM_ENTITY_REF</member> + <member>XML_ERROR_UNDEFINED_ENTITY</member> + <member>XML_ERROR_RECURSIVE_ENTITY_REF</member> + <member>XML_ERROR_ASYNC_ENTITY</member> + <member>XML_ERROR_BAD_CHAR_REF</member> + <member>XML_ERROR_BINARY_ENTITY_REF</member> + <member>XML_ERROR_ATTRIBUTE_EXTERNAL_ENTITY_REF</member> + <member>XML_ERROR_MISPLACED_XML_PI</member> + <member>XML_ERROR_UNKNOWN_ENCODING</member> + <member>XML_ERROR_INCORRECT_ENCODING</member> + <member>XML_ERROR_UNCLOSED_CDATA_SECTION</member> + <member>XML_ERROR_EXTERNAL_ENTITY_HANDLING</member> + </simplelist> + </para> + </sect2> + <sect2 id="xml.encoding"> + <title>Codage des caractères</title> + <para> + L'extension XML de PHP supporte les caractères + <ulink url="&url.unicode;">Unicode</ulink> grâce à + différents codages. Il y a deux types de codages de + caractères : le codage à la source et le codage à + la cible. PHP utilise le <literal>UTF-8</literal> comme + représentation interne. + </para> + <para> + L'encodage à la source est effectué lors de + <link linkend="function.xml-parse">l'analyse</link> du fichier par XML. + Lors de la <link linkend="function.xml-parser-create"> création + d'un analyseur XML</link>), un type de codage à la + source doit être spécifié (et il ne pourra plus + être modifié jusqu'à la destruction de + l'analyseur). Les codages supportés sont : + <literal>ISO-8859-1</literal>, <literal>US-ASCII</literal> et + <literal>UTF-8</literal>. Les deux derniers sont des codages + à un seul octet, c'est à dire que les caractères + sont représentés sur un seul octet. <literal>UTF-8</literal> + peut représenter des caractères composés par un + nombre variable de bits (jusqu'à 21), allant de 1 à + quatre octets. Le codage par défaut utilisé par PHP + <literal>ISO-8859-1</literal>. + </para> + <para> + Le codage à la cible est effectué lorsque PHP transfert + les données aux gestionnaires XML. Lorsqu'un analyseur est + créé, le codage à la cible est spécifié + de la même façon que le codage à la source, mais + il peut être modifié à tout moment. Le codage + à la cible affectera les balises, tout comme les + données brutes, et les noms des instructions exécutables. + </para> + <para> + Si l'analyseur XML rencontre un caractère qu'il ne + connaît pas (hors limite, par exemple), il retournera une erreur. + </para> + <para> + Si PHP rencontre un caractère dans le document XML analysé, + qu'il ne peut pas représenter dans le codage à la cible + choisi, le caractère sera remplacé par un point + d'interrogation (cette attitude est suceptible de changer + ultérieurement). + </para> + </sect2> + </sect1> + <sect1 id="xml.examples"> + <title>Quelques exemples</title> + <para> + Voici une liste d'exemple de code PHP qui analyse un document XML. + </para> + <sect2 id="example.xml-structure"> + <title>Exemple de structure XML</title> + <para> + Ce premier exemple affiche la structure de l'élément + de début dans un document avec indentation. + <example> + <title>Afficher une structure XML</title> + <programlisting role="php"> +$file = "data.xml"; +$depth = array(); +function startElement($parser, $name, $attrs) { + global $depth; + for ($i = 0; $i < $depth[$parser]; $i++) { + print " "; + } + print "$name\n"; + $depth[$parser]++; +} +function endElement($parser, $name) { + global $depth; + $depth[$parser]--; +} +$xml_parser = xml_parser_create(); +xml_set_element_handler($xml_parser, "startElement", "endElement"); +if (!($fp = fopen($file, "r"))) { + die("could not open XML input"); +} +while ($data = fread($fp, 4096)) { + if (!xml_parse($xml_parser, $data, feof($fp))) { + die(sprintf("XML error: %s at line %d", + xml_error_string(xml_get_error_code($xml_parser)), + xml_get_current_line_number($xml_parser))); + } +} +xml_parser_free($xml_parser); + </programlisting> + </example> + </para> + </sect2> + <sect2 id="example.xml-map-tags"> + <title>XML Transtypage XML -> HTML</title> + <para> + <example> + <title>XML Transtypage XML -> HTML</title> + <para> + Cet exemple remplace les balises XML d'un document par des balises + HTML. Les éléments inconnus seront ignorés. + Bien entendu, cet exemple sera appliqué à un type + précis de fichiers XML. + <programlisting role="php"> +$file = "data.xml"; +$map_array = array( + "BOLD" => "B", + "EMPHASIS" => "I", + "LITERAL" => "TT" +); +function startElement($parser, $name, $attrs) { + global $map_array; + if ($htmltag = $map_array[$name]) { + print "<$htmltag>"; + } +} +function endElement($parser, $name) { + global $map_array; + if ($htmltag = $map_array[$name]) { + print "</$htmltag>"; + } +} +function characterData($parser, $data) { + print $data; +} +$xml_parser = xml_parser_create(); +// use case-folding so we are sure to find the tag in $map_array +xml_parser_set_option($xml_parser, XML_OPTION_CASE_FOLDING, true); +xml_set_element_handler($xml_parser, "startElement", "endElement"); +xml_set_character_data_handler($xml_parser, "characterData"); +if (!($fp = fopen($file, "r"))) { + die("could not open XML input"); +} +while ($data = fread($fp, 4096)) { + if (!xml_parse($xml_parser, $data, feof($fp))) { + die(sprintf("XML error: %s at line %d", + xml_error_string(xml_get_error_code($xml_parser)), + xml_get_current_line_number($xml_parser))); + } +} +xml_parser_free($xml_parser); + </programlisting> + </para> + </example> + </para> + </sect2> + <sect2 id="example.xml-external-entity"> + <title>XML Entitée externe</title> + <para> + Cet exemple exploite les références externes de XML : + il est possible d'utiliser un gestionnaire d'entité externe + pour inclure et analyser les documents, tous comme les instructions + exécutables peuvent servir à inclure et analyser + d'autres documents, et aussi fournir une indication de confiance + (voir plus bas). + </para> + <para> + Le document XML qui est utilisé dans cet exemple est fourni plus + loin dans l'exemple (<filename>xmltest.xml</filename> et + <filename>xmltest2.xml</filename>). + </para> + <para> + <example> + <title>Entitée externe</title> + <programlisting role="php"> +$file = "xmltest.xml"; +function trustedFile($file) { + // only trust local files owned by ourselves + if (!eregi("^([a-z]+)://", $file) + && fileowner($file) == getmyuid()) { + return true; + } + return false; +} +function startElement($parser, $name, $attribs) { + print "&lt;<font color=\"#0000cc\">$name</font>"; + if (sizeof($attribs)) { + while (list($k, $v) = each($attribs)) { + print " <font color=\"#009900\">$k</font>=\"<font + color=\"#990000\">$v</font>\""; + } + } + print "&gt;"; +} +function endElement($parser, $name) { + print "&lt;/<font color=\"#0000cc\">$name</font>&gt;"; +} +function characterData($parser, $data) { + print "<b>$data</b>"; +} +function PIHandler($parser, $target, $data) { + switch (strtolower($target)) { + case "php": + global $parser_file; + // If the parsed document is "trusted", we say it is safe + // to execute PHP code inside it. If not, display the code + // instead. + if (trustedFile($parser_file[$parser])) { + eval($data); + } else { + printf("Untrusted PHP code: <i>%s</i>", + htmlspecialchars($data)); + } + break; + } +} +function defaultHandler($parser, $data) { + if (substr($data, 0, 1) == "&" && substr($data, -1, 1) == ";") { + printf('<font color="#aa00aa">%s</font>', + htmlspecialchars($data)); + } else { + printf('<font size="-1">%s</font>', + htmlspecialchars($data)); + } +} +function externalEntityRefHandler($parser, $openEntityNames, $base, $systemId, + $publicId) { + if ($systemId) { + if (!list($parser, $fp) = new_xml_parser($systemId)) { + printf("Could not open entity %s at %s\n", $openEntityNames, + $systemId); + return false; + } + while ($data = fread($fp, 4096)) { + if (!xml_parse($parser, $data, feof($fp))) { + printf("XML error: %s at line %d while parsing entity %s\n", + xml_error_string(xml_get_error_code($parser)), + xml_get_current_line_number($parser), $openEntityNames); + xml_parser_free($parser); + return false; + } + } + xml_parser_free($parser); + return true; + } + return false; +} +function new_xml_parser($file) { + global $parser_file; + $xml_parser = xml_parser_create(); + xml_parser_set_option($xml_parser, XML_OPTION_CASE_FOLDING, 1); + xml_set_element_handler($xml_parser, "startElement", "endElement"); + xml_set_character_data_handler($xml_parser, "characterData"); + xml_set_processing_instruction_handler($xml_parser, "PIHandler"); + xml_set_default_handler($xml_parser, "defaultHandler"); + xml_set_external_entity_ref_handler($xml_parser, "externalEntityRefHandler"); + if (!($fp = @fopen($file, "r"))) { + return false; + } + if (!is_array($parser_file)) { + settype($parser_file, "array"); + } + $parser_file[$xml_parser] = $file; + return array($xml_parser, $fp); +} +if (!(list($xml_parser, $fp) = new_xml_parser($file))) { + die("could not open XML input"); +} +print "<pre>"; +while ($data = fread($fp, 4096)) { + if (!xml_parse($xml_parser, $data, feof($fp))) { + die(sprintf("XML error: %s at line %d\n", + xml_error_string(xml_get_error_code($xml_parser)), + xml_get_current_line_number($xml_parser))); + } +} +print "</pre>"; +print "parse complete\n"; +xml_parser_free($xml_parser); +?> + </programlisting> + </example> + </para> + <para id="example.xml-xmltest.xml"> + <example> + <title>xmltest.xml</title> + <programlisting role="xml"> +<?xml version='1.0'?> +<!DOCTYPE chapter SYSTEM "/just/a/test.dtd" [ +<!ENTITY plainEntity "FOO entity"> +<!ENTITY systemEntity SYSTEM "xmltest2.xml"> +]> +<chapter> + <TITLE>Title &plainEntity;</TITLE> + <para> + <informaltable> + <tgroup cols="3"> + <tbody> + <row><entry>a1</entry><entry morerows="1">b1</entry><entry>c1</entry></row> + <row><entry>a2</entry><entry>c2</entry></row> + <row><entry>a3</entry><entry>b3</entry><entry>c3</entry></row> + </tbody> + </tgroup> + </informaltable> + </para> + &systemEntity; + <sect1 id="about"> + <title>About this Document</title> + <para> + <!-- this is a comment --> + <?php print 'Hi! This is PHP version '.phpversion(); ?> + </para> + </sect1> +</chapter> + </programlisting> + </example> + </para> + <para id="example.xml-xmltest2.xml"> + This file is included from <filename>xmltest.xml</filename>: + <example> + <title>xmltest2.xml</title> + <programlisting role="xml"> +<?xml version="1.0"?> +<!DOCTYPE foo [ +<!ENTITY testEnt "test entity"> +]> +<foo> + <element attrib="value"/> + &testEnt; + <?php print "This is some more PHP code being executed."; ?> +</foo> + </programlisting> + </example> + </para> + </sect2> + </sect1> + </partintro> + <refentry id="function.xml-parser-create"> + <refnamediv> + <refname>xml_parser_create</refname> + <refpurpose>Création d'un analyseur XML.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>xml_parser_create</function></funcdef> + <paramdef>string + <parameter><optional>encoding</optional></parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + <para> + <variablelist> + <varlistentry> + <term><parameter>encoding</parameter> (optional)</term> + <listitem> + <para> + Le codage de caractère de l'analyseur : les codages suivants + sont supportés : + <simplelist> + <member><literal>ISO-8859-1</literal> (par défaut)</member> + <member><literal>US-ASCII</literal></member> + <member><literal>UTF-8</literal></member> + </simplelist> + </para> + </listitem> + </varlistentry> + </variablelist> + Cette fonction crée un analyseur XML et retourne une + référence sur cet analyseur pour qu'il puisse + être utilisé ultérieurement par d'autres + fonctions XML. Retourne FALSE en cas d'erreur. + </para> + </refsect1> + </refentry> + <refentry id="function.xml-set-object"> + <refnamediv> + <refname>xml_set_object</refname> + <refpurpose> + Utilise un analyseur XML à l'intérieur d'un objet. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>void <function>xml_set_object</function></funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + <paramdef>object <parameter>&object</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + Cette fonction rend l'analyseur <parameter>parser</parameter> utilisable + depuis un objet. Toutes les méthodes de callback, affectées + par <function>xml_set_element_handler</function>, seront les méthodes + de cet objet. + </para> + <programlisting role="php"> +<?php +class xml { +var $parser; +function xml() { + $this->parser = xml_parser_create(); + xml_set_object($this->parser,&$this); + xml_set_element_handler($this->parser,"tag_open","tag_close"); + xml_set_character_data_handler($this->parser,"cdata"); +} +function parse($data) { + xml_parse($this->parser,$data); +} +function tag_open($parser,$tag,$attributes) { + var_dump($parser,$tag,$attributes); +} +function cdata($parser,$cdata) { + var_dump($parser,$cdata); +} +function tag_close($parser,$tag) { + var_dump($parser,$tag); +} +} // end of class xml +$xml_parser = new xml(); +$xml_parser->parse("<A ID=\"hallo\">PHP</A>"); +?> + </programlisting> + </refsect1> + </refentry> + <refentry id="function.xml-set-element-handler"> + <refnamediv> + <refname>xml_set_element_handler</refname> + <refpurpose>Affecte les gestionnaires de début et de fin.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int + <function>xml_set_element_handler</function> + </funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + <paramdef>string + <parameter>startElementHandler</parameter> + </paramdef> + <paramdef>string + <parameter>endElementHandler</parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + <para> + Affecte les gestionnaires de début et de fin de l'analyseur XML + <parameter>parser</parameter>. <parameter>startElementHandler</parameter> + et <parameter>endElementHandler</parameter> sont des chaînes qui + contiennent les noms de fonctions qui existent lorsque + <function>xml_parse</function> est appelé pour créer + <parameter>parser</parameter>. + </para> + <para> + La fonction <parameter>startElementHandler</parameter> doit + accepter trois paramètres: + <funcsynopsis> + <funcprototype> + <funcdef><replaceable>startElementHandler</replaceable></funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + <paramdef>string <parameter>name</parameter></paramdef> + <paramdef>array <parameter>attribs</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem> + <simpara> + Le premier paramètre, <replaceable>parser</replaceable>, est une + référence sur l'analyseur XML qui appelle cette fonction. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>name</parameter></term> + <listitem> + <simpara> + Le deuxième paramètre, <parameter>name</parameter>, contient + le nom de l'élément qui a provoqué l'appel du + gestionnaire. Si l'analyseur gère la + <link linkend="xml.case-folding">casse</link>, cet élément + sera en majuscule. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>attribs</parameter></term> + <listitem> + <simpara> + Le troisième paramètre, <parameter>attribs</parameter>, + contient un tableau associatif avec les attributs de + l'éléments (si il en existe). Les clés de ce tableau + seront les noms des attributs, et les valeurs seront les valeurs + correspondantes des attributs. Les noms des attributs seront mis en + majuscule si l'analyseur gère la + <link linkend="xml.case-folding">casse</link>. Les valeurs des attributs + seront intouchées. + </simpara> + <simpara> + L'ordre original des attributs peut être retrouvé en + passant en revue le tableau <parameter>attribs</parameter>, avec + la fonction <function>each</function>. La première clé + sera la première clé du tableau. + </simpara> + </listitem> + </varlistentry> + </variablelist> + </para> + <para> + La fonction <parameter>endElementHandler</parameter> doit accepter deux + paramètres: + <funcsynopsis> + <funcprototype> + <funcdef><replaceable>endElementHandler</replaceable></funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + <paramdef>string <parameter>name</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem> + <simpara> + Le premier paramètre, <replaceable>parser</replaceable>, est une + référence sur l'analyseur XML qui appelle cette fonction. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>name</parameter></term> + <listitem> + <simpara> + Le second paramètre, <parameter>name</parameter>, contient le + nom de l'élément qui a provoqué l'appel du + gestionnaire. Si l'analyseur gère la + <link linkend="xml.case-folding">casse</link>, cet + élément sera en majuscule. + </simpara> + </listitem> + </varlistentry> + </variablelist> + </para> + <para> + Si un gestionnaire recoit une chaîne vide, ou FALSE, c'est qu'il est en + train d'être désactivé. + </para> + <para> + Retourne TRUE si le gestionnaire est actif, et FALSE sinon, ou si + <parameter>parser</parameter> n'est pas un analyseur. + </para> + <para> + Il n'est pas pour l'instant possible d'utiliser des objets pour servir de + gestionnaire. Reportez vous à <function>xml_set_object</function> pour + utiliser l'analyseur XML depuis un objet. + </para> + </refsect1> + </refentry> + <refentry id="function.xml-set-character-data-handler"> + <refnamediv> + <refname>xml_set_character_data_handler</refname> + <refpurpose>Affecte les gestionnaires de caractère bruts.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int + <function>xml_set_character_data_handler</function> + </funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + <paramdef>string <parameter>handler</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + Affecte les gestionnaires de début et de fin de l'analyseur XML + <parameter>parser</parameter>. <parameter>handler</parameter> est une + chaîne qui contient le nom d'une fonction qui existe lorsque + <function>xml_parse</function> est appelé pour créer + <parameter>parser</parameter>. + </para> + <para> + La fonction <parameter>handler</parameter> doit accepter deux paramètres: + <funcsynopsis> + <funcprototype> + <funcdef><replaceable>handler</replaceable></funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + <paramdef>string <parameter>data</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem> + <simpara> + Le premier paramètre, <replaceable>parser</replaceable>, est + une référence sur l'analyseur XML qui appelle cette fonction. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>data</parameter></term> + <listitem> + <simpara> + Le second paramètre, <parameter>data</parameter>, contient + les caractères sous la forme d'une chaîne. + </simpara> + </listitem> + </varlistentry> + </variablelist></para> + <para> + Si un gestionnaire reçoit une chaîne vide ou FALSE, c'est + qu'il est en train d'être désactivé. + </para> + <para> + Retourne TRUE si le gestionnaire est actif, et FALSE sinon, ou si + <parameter>parser</parameter> n'est pas un analyseur. + </para> + <para> + Il n'est pas pour l'instant possible d'utiliser des objets pour servir de + gestionnaire. Reportez vous à <function>xml_set_object</function> pour + utiliser l'analyseur XML depuis un objet. + </para> + </refsect1> + </refentry> + <refentry id="function.xml-set-processing-instruction-handler"> + <refnamediv> + <refname>xml_set_processing_instruction_handler</refname> + <refpurpose> + Affecte les gestionnaires d'instructions exécutables. + .</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int + <function>xml_set_processing_instruction_handler</function> + </funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + <paramdef>string <parameter>handler</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + Affecte les gestionnaires d'instructions exécutables de l'analyseur + XML <parameter>parser</parameter>. <parameter>handler</parameter> est une + chaîne qui contient le nom d'une fonction qui existe lorsque + <function>xml_parse</function> est appelé pour créer + <parameter>parser</parameter>. + </para> + <para> + Une instruction exécutable a la forme suivante :: + <informalexample> + <programlisting><? + <replaceable>target</replaceable> + <replaceable>data</replaceable>?> + </programlisting> + </informalexample> + Vous pouvez mettre du code PHP entre ces balises, mais soyez conscient d'une + des limitations des instructions exécutables de XML : la balise + de fin d'instruction éxécutable (<literal>?></literal>) + ne peut être échappée, ce qui fait que cette + séquence NE DOIT JAMAIS apparaître dans le code PHP + placé dans le document PHP. Si un tel texte apparaît, + la balise de fin d'instruction exécutable sera reconnue, et + le reste du code sera considéré comme des données + brutes (et donc, pas exécutées). + </para> + <para> + La fonction <parameter>handler</parameter> doit accepter trois paramètres: + <funcsynopsis> + <funcprototype> + <funcdef><replaceable>handler</replaceable></funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + <paramdef>string <parameter>target</parameter></paramdef> + <paramdef>string <parameter>data</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem> + <simpara> + Le premier paramètre, <replaceable>parser</replaceable>, est une + référence sur l'analyseur XML qui appelle cette fonction. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>target</parameter></term> + <listitem> + <simpara> + Le second paramètre, <parameter>target</parameter>, + contient l'application cible. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>data</parameter></term> + <listitem><simpara> + Le troisième paramètre, <parameter>data</parameter>, contient + le code sous la forme d'une chaîne. + </simpara></listitem> + </varlistentry> + </variablelist></para> + <para> + Si un gestionnaire reçoit une chaîne vide, ou FALSE, + c'est qu'il est en train d'être désactivé. + </para> + <para> + Retourne TRUE si le gestionnaire est actif, et FALSE sinon, ou si + <parameter>parser</parameter> n'est pas un analyseur. + </para> + <para> + Il n'est pas pour l'instant possible d'utiliser des objets pour servir de + gestionnaire. Reportez vous à <function>xml_set_object</function> pour + utiliser l'analyseur XML depuis un objet. + </para> + </refsect1> + </refentry> + <refentry id="function.xml-set-default-handler"> + <refnamediv> + <refname>xml_set_default_handler</refname> + <refpurpose>Affecte le gestionnaire par défaut.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int + <function>xml_set_default_handler</function> + </funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + <paramdef>string <parameter>handler</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + Affecte le gestionnaire par défaut de l'analyseur XML + <parameter>parser</parameter>. <parameter>handler</parameter> est + une chaîne qui contient le nom d'une fonction qui existe lorsque + <function>xml_parse</function> est appelé pour créer + <parameter>parser</parameter>. + </para> + <para> + La fonction <parameter>handler</parameter> doit accepter deux paramètres: + <funcsynopsis> + <funcprototype> + <funcdef><replaceable>handler</replaceable></funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + <paramdef>string <parameter>data</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <variablelist> + <varlistentry> + <term> + <parameter>parser</parameter> + </term> + <listitem> + <simpara> + Le premier paramètre, <replaceable>parser</replaceable>, est une + référence sur l'analyseur XML qui appelle cette fonction. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>data</parameter> + </term> + <listitem> + <simpara> + Le second paramètre, <parameter>data</parameter>, contient les + caractères sous la forme d'une chaîne. Cela peut être + une déclaration XML, un type de document, une entité ou + d'autre données pour qui aucun gestionnaire n'est prévu. + </simpara> + </listitem> + </varlistentry> + </variablelist> + </para> + <para> + Si un gestionnaire reçoit une chaîne vide ou FALSE, c'est + qu'il est en train d'être désactivé. + </para> + <para> + Retourne TRUE si le gestionnaire est actif, et FALSE sinon, ou si + <parameter>parser</parameter> n'est pas un analyseur. + </para> + <para> + Il n'est pas pour l'instant possible d'utiliser des objets pour servir de + gestionnaire. Reportez vous à <function>xml_set_object</function> pour + utiliser l'analyseur XML depuis un objet. + </para> + </refsect1> + </refentry> + <refentry id="function.xml-set-unparsed-entity-decl-handler"> + <refnamediv> + <refname>xml_set_unparsed_entity_decl_handler</refname> + <refpurpose> + Affecte les gestionnaires d'entité non déclaré. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int + <function>xml_set_unparsed_entity_decl_handler</function> + </funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + <paramdef>string <parameter>handler</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + Affecte les gestionnaires d'entité non déclaré de + l'analyseur XML <parameter>parser</parameter>. <parameter>handler</parameter> + est une chaîne qui contient le nom d'une fonction qui existe lorsque + <function>xml_parse</function> est appelé pour créer + <parameter>parser</parameter>. + </para> + <para> + Ce gestionnaire sera appelé si l'analyseur XML rencontre une + déclaration d'entité externe avec une déclaration + de NDATA, comme suit : + <programlisting role="xml"> +<!ENTITY <parameter>name</parameter> {<parameter>publicId</parameter> | <parameter>systemId</parameter>} + NDATA <parameter>notationName</parameter>> + </programlisting> + </para> + <para> + Reportez vous à la section + <ulink url="&url.rec-xml;#sec-external-ent">des spécifications XML 1.0</ulink> + pour connaître les notations des entités externes. + </para> + <para> + La fonction <parameter>handler</parameter> doit accepter six paramètres: + <funcsynopsis> + <funcprototype> + <funcdef><replaceable>handler</replaceable></funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + <paramdef>string <parameter>entityName</parameter></paramdef> + <paramdef>string <parameter>base</parameter></paramdef> + <paramdef>string <parameter>systemId</parameter></paramdef> + <paramdef>string <parameter>publicId</parameter></paramdef> + <paramdef>string <parameter>notationName</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem> + <simpara> + Le premier paramètre, <replaceable>parser</replaceable>, est une + référence sur l'analyseur XML qui appelle cette fonction. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>entityName</parameter></term> + <listitem> + <simpara> + Le nom de l'entitée qui va être définie + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>base</parameter></term> + <listitem> + <simpara> + La meilleure base de résolution de l'identifiant système + de cette entité externe. Actuellement, ce paramètre est + toujours une chaîne vide. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>systemId</parameter></term> + <listitem> + <simpara> + Identifiant système pour cet entité externe. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>publicId</parameter></term> + <listitem> + <simpara> + Identifiant public pour cet entité externe. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>notationName</parameter></term> + <listitem> + <simpara> + Nom de la notation de cette entité. (Voir + <function>xml_set_notation_decl_handler</function>). + </simpara> + </listitem> + </varlistentry> + </variablelist></para> + <para> + Si un gestionnaire reçoit une chaîne vide ou FALSE, + c'est qu'il est en train d'être désactivé. + </para> + <para> + Retourne TRUE si le gestionnaire est actif, et FALSE sinon, ou si + <parameter>parser</parameter> n'est pas un analyseur. + </para> + <para> + Il n'est pas pour l'instant possible d'utiliser des objets pour servir de + gestionnaire. Reportez vous à <function>xml_set_object</function> pour + utiliser l'analyseur XML depuis un objet. + </para> + </refsect1> + </refentry> + <refentry id="function.xml-set-notation-decl-handler"> + <refnamediv> + <refname>xml_set_notation_decl_handler</refname> + <refpurpose>Affecte les gestionnaires de notation.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int + <function>xml_set_notation_decl_handler</function> + </funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + <paramdef>string <parameter>handler</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + Affecte les gestionnaires de début et de fin de l'analyseur XML + <parameter>parser</parameter>. <parameter>handler</parameter> est une + chaîne qui contient le nom d'une fonction qui existe lorsque + <function>xml_parse</function> est appelé pour créer + <parameter>parser</parameter>. + </para> + <para> + Une notation est une partie du DTD du document, qui a le format suivant : + <programlisting role="xml"><!NOTATION <parameter>name</parameter> {<parameter>systemId</parameter> | + <parameter>publicId</parameter>}></programlisting> + Reportez vous à la section + <ulink url="&url.rec-xml;#sec-external-ent">des spécifications XML 1.0</ulink> + pour connaître les notations des entités externes. + </para> + <para> + La fonction <parameter>handler</parameter> doit accepter cinq + paramètres: + <funcsynopsis> + <funcprototype> + <funcdef><replaceable>handler</replaceable></funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + <paramdef>string <parameter>notationName</parameter></paramdef> + <paramdef>string <parameter>base</parameter></paramdef> + <paramdef>string <parameter>systemId</parameter></paramdef> + <paramdef>string <parameter>publicId</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <variablelist> + <varlistentry> + <term> + <parameter>parser</parameter> + </term> + <listitem> + <simpara> + Le premier paramètre, <replaceable>parser</replaceable>, est une + référence sur l'analyseur XML qui appelle cette fonction. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>notationName</parameter></term> + <listitem> + <simpara> + Le nom de la notation,<parameter>name</parameter>, comme + précisé dans le format de notation ci dessus. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>base</parameter> + </term> + <listitem> + <simpara> + La meilleure base de résolution de l'identifiant système + de cette entité externe. Actuellement, ce paramètre + est toujours une chaîne vide. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>systemId</parameter></term> + <listitem> + <simpara> + Identifiant système pour cette entitée externe. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>publicId</parameter> + </term> + <listitem> + <simpara> + Identifiant public pour cet entité externe. + </simpara> + </listitem> + </varlistentry> + </variablelist> + </para> + <para> + Si un gestionnaire reçoit une chaîne vide ou FALSE, + c'est qu'il est en train d'être désactivé. + </para> + <para> + Retourne TRUE si le gestionnaire est actif, et FALSE sinon ou si + <parameter>parser</parameter> n'est pas un analyseur. + </para> + <para> + Il n'est pas pour l'instant possible d'utiliser des objets pour servir de + gestionnaires. Reportez vous à <function>xml_set_object</function> pour + utiliser l'analyseur XML depuis un objet. + </para> + </refsect1> + </refentry> + <refentry id="function.xml-set-external-entity-ref-handler"> + <refnamediv> + <refname>xml_set_external_entity_ref_handler</refname> + <refpurpose>Fixe le gestionnaire de référence externes.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int + <function>xml_set_external_entity_ref_handler</function> + </funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + <paramdef>string <parameter>handler</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + Fixe le gestionnaire d'entité externe de l'analyseur XML + <parameter>parser</parameter>. <parameter>handler</parameter> et + <parameter>endElementHandler</parameter> sont des chaînes qui + contiennent les noms de fonction qui existent lorsque + <function>xml_parse</function> est appelé + pour créer le <parameter>parser</parameter>. + </para> + <para> + La fonction <parameter>handler</parameter> doit accepter 5 + paramètres, et retourner un entier. Si la valeur retourné par + le gestionnaire est FALSE (comme par exemple si aucune valeur n'est + retournée), l'analyseur XML s'arrêtera, et la fonction + <function>xml_get_error_code</function> retournera + <systemitem class="constant">XML_ERROR_EXTERNAL_ENTITY_HANDLING</systemitem>. + <funcsynopsis> + <funcprototype> + <funcdef>int <replaceable>handler</replaceable></funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + <paramdef>string + <parameter>openEntityNames</parameter> + </paramdef> + <paramdef>string <parameter>base</parameter></paramdef> + <paramdef>string <parameter>systemId</parameter></paramdef> + <paramdef>string <parameter>publicId</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem> + <simpara> + Le premier paramètre,<replaceable>parser</replaceable>, est une + référence sur l'analyseur XML qui appelle cette fonction. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>openEntityNames</parameter></term> + <listitem> + <simpara> + Le deuxième paramètre, <parameter>openEntityNames</parameter>, + est i.e. liste de noms d'entité, séparés par des + espaces. Ces entités sont accessibles à l'analyse par cet + entité (y compris le nom de l'entité reférencé). + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>base</parameter></term> + <listitem> + <simpara> + La meilleure base de résolution de l'identifiant système + de cet entité externe. Actuellement, ce paramètre est + toujours une chaîne vide. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>systemId</parameter></term> + <listitem> + <simpara> + Identifiant système pour cet entité externe. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>publicId</parameter></term> + <listitem> + <simpara> + Le cinquième paramètre, <parameter>publicId</parameter>, + est l'identifiant public, comme spécifié dans la + déclaration d'entité, ou un chaîne vide, si + aucune déclaration n'a été spécifiée. + L'espace dans l'identifiant public sera normalisé comme + spécifié dans les spécifications XML. + </simpara> + </listitem> + </varlistentry> + </variablelist> + </para> + <para> + Si un gestionnaire reçoit une chaîne vide, ou FALSE, c'est qu'il est en train + d'être désactivé. + </para> + <para> + Retourne TRUE si le gestionnaire est actif, et FALSE sinon ou si + <parameter>parser</parameter> n'est pas un analyseur. + </para> + <para> + Il n'est pas pour l'instant possible d'utiliser des objets pour servir de + gestionnaire. Reportez vous à <function>xml_set_object</function> pour + utiliser l'analyseur XML depuis un objet. + </para> + </refsect1> + </refentry> + <refentry id="function.xml-parse"> + <refnamediv> + <refname>xml_parse</refname> + <refpurpose>Commence l'analyse d'un fichier XML.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>xml_parse</function></funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + <paramdef>string <parameter>data</parameter></paramdef> + <paramdef>int + <parameter><optional>isFinal</optional></parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + <para> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem> + <simpara> + une référence sur l'analyseur XML à utiliser. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>data</parameter></term> + <listitem> + <simpara> + Une partie des données à analyser. Un document peut + être analysé morceau par morceau, en appelant + <function>xml_parse</function> plusieurs fois, tant que le + paramètre <parameter>isFinal</parameter> est mis à + TRUE pour le dernier morceau. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>isFinal</parameter> (optional)</term> + <listitem> + <simpara> + Si il vaut TRUE, <parameter>data</parameter> est la dernière partie + à analyser. + </simpara> + </listitem> + </varlistentry> + </variablelist> + </para> + <para> + Lorsqu'un document XML est analysé, les gestionnaires + d'événements sont appelés aussi souvent que + nécessaire, et retournent TRUE ou FALSE. + </para> + <para> + TRUE est retourné lorsque l'analyse a été concluante, + et FALSE en cas d'échec, ou si <parameter>parser</parameter> n'est pas + un analyseur valide. Lors d'un échec d'analyse, la cause de l'erreur + peut être obtenue grâce aux fonctions + <function>xml_get_error_code</function>, <function>xml_error_string</function>, + <function>xml_get_current_line_number</function>, + <function>xml_get_current_column_number</function> et + <function>xml_get_current_byte_index</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.xml-get-error-code"> + <refnamediv> + <refname>xml_get_error_code</refname> + <refpurpose>Retourne le nombre courant de colonne d'un analyseur XML.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>xml_get_error_code</function></funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem> + <simpara> + Cette fonction retourne FALSE si <parameter>parser</parameter> n'est pas + valide, ou sinon, retourne le numéro de colonne courante de la + ligne courante de l'analyseur, qui correspond à la position + d'analyse courante de l'analyseur XML. + </simpara> + </listitem> + </varlistentry> + </variablelist> + </para> + <para> + Cette fonction retourne FALSE si <parameter>parser</parameter> n'est pas valide, + ou sinon, retourne le numéro de colonne courante de la ligne courante de + l'analyseur, qui correspond à la position d'analyse courante de + l'analyseur XML. + </para> + </refsect1> + </refentry> + <refentry id="function.xml-error-string"> + <refnamediv> + <refname>xml_error_string</refname> + <refpurpose>Lit le message d'erreur de l'analyseur XML.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>xml_error_string</function></funcdef> + <paramdef>int <parameter>code</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <variablelist> + <varlistentry> + <term><parameter>code</parameter></term> + <listitem> + <simpara> + Un message d'erreur, issu de <function>xml_get_error_code</function>. + </simpara> + </listitem> + </varlistentry> + </variablelist> + </para> + <para> + Retourne la chaîne avec un message textuel, décrivant l'erreur + <parameter>code</parameter>, ou FALSE si aucune description n'a + été trouvée. + </para> + </refsect1> + </refentry> + <refentry id="function.xml-get-current-line-number"> + <refnamediv> + <refname>xml_get_current_line_number</refname> + <refpurpose> + Retourne le numéro de ligne courant d'un analyseur XML. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int + <function>xml_get_current_line_number</function> + </funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem> + <simpara> + Une référence sur un analyseur XML valide. + </simpara> + </listitem> + </varlistentry> + </variablelist> + </para> + <para> + Cette fonction retourne FALSE si <parameter>parser</parameter> n'est + pas valide, ou sinon, retourne le numéro de la ligne en cours + d'analyse. + </para> + </refsect1> + </refentry> + <refentry id="function.xml-get-current-column-number"> + <refnamediv> + <refname>xml_get_current_column_number</refname> + <refpurpose> + Retourne le nombre courant de colonne d'un analyseur XML. + .</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int + <function>xml_get_current_column_number</function> + </funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem> + <simpara> + Une référence sur un analyseur XML valide. + </simpara> + </listitem> + </varlistentry> + </variablelist> + </para> + <para> + Cette fonction retourne FALSE si <parameter>parser</parameter> n'est + pas valide, ou sinon, retourne le numéro de colonne courante + de la ligne courante de l'analyseur, qui correspond à la + position d'analyse courante de l'analyseur XML. + </para> + </refsect1> + </refentry> + <refentry id="function.xml-get-current-byte-index"> + <refnamediv> + <refname>xml_get_current_byte_index</refname> + <refpurpose>Retourne l'index de l'octet courant d'un analyseur XML.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int + <function>xml_get_current_byte_index</function> + </funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem> + <simpara> + Une référence sur un analyseur XML valide. + </simpara> + </listitem> + </varlistentry> + </variablelist> + </para> + <para> + Cette fonction retourne FALSE si <parameter>parser</parameter> n'est pas + valide, ou sinon, retourne l'index de l'octet d'analyse courante de + l'analyseur XML. + </para> + </refsect1> + </refentry> + <refentry id="function.xml-parse-into-struct"> + <refnamediv> + <refname>xml_parse_into_struct</refname> + <refpurpose>Analyse une structure XML</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>xml_parse_into_struct</function></funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + <paramdef>string <parameter>data</parameter></paramdef> + <paramdef>array <parameter>&values</parameter></paramdef> + <paramdef>array <parameter>&index</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>xml_parse_into_struct</function> analyse le fichier + XML <parameter>data</parameter>, et le place dans deux tableaux : + le premier <parameter>index</parameter> contient des pointeurs + sur la position des valeurs correspondantes dans le tableau + <parameter>values</parameter> array. Ces deux paramètres sont + passés par références. + </para> + <para> + Ci dessous, vous trouverez un exemple qui illustre la structure + des deux tableaux générés par la fonction. On utilise une balise + simple <literal>note</literal>, placée dans une autre balise + <literal>para</literal>. On analyse le tout, et on + affiche la structure générée : + <informalexample> + <programlisting> +$simple = "<para><note>simple note</note></para>"; +$p = xml_parser_create(); +xml_parse_into_struct($p,$simple,&$vals,&$index); +xml_parser_free($p); +echo "Index array\n"; +print_r($index); +echo "\nVals array\n"; +print_r($vals); + </programlisting> + </informalexample> + Lors de l'éxécution du code, l'affichage sera : + <informalexample> + <programlisting> +Index array +Array +( + [PARA] => Array + ( + [0] => 0 + [1] => 2 + ) + [NOTE] => Array + ( + [0] => 1 + ) +) +Vals array +Array +( + [0] => Array + ( + [tag] => PARA + [type] => open + [level] => 1 + ) + [1] => Array + ( + [tag] => NOTE + [type] => complete + [level] => 2 + [value] => simple note + ) + [2] => Array + ( + [tag] => PARA + [type] => close + [level] => 1 + ) +) + </programlisting> + </informalexample> + </para> + <para> + L'analyse événementielle (comme celle de expat), peut se révéler + complexe lorsque le document XML est complexe. Cette fonction ne + génère pas d'objet de type DOM, mais il génère plutôt des + structures qui peuvent être parcourues à la façon d'un arbre. + Considérons le fichier suivant, qui représente une petite base + de données XML : + <example> + <title>moldb.xml - Petite base de données moléculaire</title> + <programlisting> +<?xml version="1.0"?> +<moldb> + <molecule> + <name>Alanine</name> + <symbol>ala</symbol> + <code>A</code> + <type>hydrophobic</type> + </molecule> + <molecule> + <name>Lysine</name> + <symbol>lys</symbol> + <code>K</code> + <type>charged</type> + </molecule> +</moldb> + </programlisting> + </example> + Et maitenant, un code qui analyse le document, et génère les + objet ad hoc : + <example> + <title> + parsemoldb.php - analyse moldb.xml et crée un tableau + d'objet moléculaires + </title> + <programlisting role="php"> +<?php +class AminoAcid { + var $name; // nom de l'amino acide + var $symbol; // symbole en trois lettres + var $code; // code en une lettre + var $type; // hydrophobe, chargé ou neutre + function AminoAcid ($aa) { + foreach ($aa as $k=>$v) + $this->$k = $aa[$k]; + } +} +function readDatabase($filename) { + // read the xml database of aminoacids + $data = implode("",file($filename)); + $parser = xml_parser_create(); + xml_parser_set_option($parser,XML_OPTION_CASE_FOLDING,0); + xml_parser_set_option($parser,XML_OPTION_SKIP_WHITE,1); + xml_parse_into_struct($parser,$data,&$values,&$tags); + xml_parser_free($parser); + // parcourt les structures + foreach ($tags as $key=>$val) { + if ($key == "molecule") { + $molranges = $val; + // chaque paire contigue sont les définitions supérieures + // et inférieures de la molécule + for ($i=0; $i < count($molranges); $i+=2) { + $offset = $molranges[$i] + 1; + $len = $molranges[$i + 1] - $offset; + $tdb[] = parseMol(array_slice($values, $offset, $len)); + } + } else { + continue; + } + } + return $tdb; +} +function parseMol($mvalues) { + for ($i=0; $i < count($mvalues); $i++) + $mol[$mvalues[$i]["tag"]] = $mvalues[$i]["value"]; + return new AminoAcid($mol); +} +$db = readDatabase("moldb.xml"); +echo "** Database of AminoAcid objects:\n"; +print_r($db); +?> + </programlisting> + </example> + Après exécution de <filename>parsemoldb.php</filename>, la variable + <varname>$db</varname> contient un tableau d'objets + <classname>AminoAcid</classname>, et l'affichage le confirme : + <informalexample> + <programlisting> +** Database of AminoAcid objects: +Array +( + [0] => aminoacid Object + ( + [name] => Alanine + [symbol] => ala + [code] => A + [type] => hydrophobic + ) + [1] => aminoacid Object + ( + [name] => Lysine + [symbol] => lys + [code] => K + [type] => charged + ) +) + </programlisting> + </informalexample> + </para> + </refsect1> + </refentry> + <refentry id="function.xml-parser-free"> + <refnamediv> + <refname>xml_parser_free</refname> + <refpurpose> Détruit un analyseur XML.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>xml_parser_free</function></funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem> + <simpara> + Une référence sur un analyseur XML. + </simpara> + </listitem> + </varlistentry> + </variablelist></para> + <para> + Cette fonction retourne FALSE si <parameter>parser</parameter> + n'est pas une référence valide, ou sinon, détruit + l'analyseur et retourne TRUE. + </para> + </refsect1> + </refentry> + <refentry id="function.xml-parser-set-option"> + <refnamediv> + <refname>xml_parser_set_option</refname> + <refpurpose>Affecte les options d'un analyseur XML.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>xml_parser_set_option</function></funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + <paramdef>int <parameter>option</parameter></paramdef> + <paramdef>mixed <parameter>value</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem> + <simpara> + Une référence vers un analyseur XML. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>option</parameter></term> + <listitem> + <simpara> + L'option à modifier. Voir ci dessous : + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>value</parameter></term> + <listitem> + <simpara> + La nouvelle valeur de l'option. + </simpara> + </listitem> + </varlistentry> + </variablelist> + </para> + <para> + Cette fonction retourne FALSE si <parameter>parser</parameter> n'est pas une + référence valide sur un analyseur XML, ou si l'option + n'a pas pu être modifiée. Sinon, l'option est effectivement + modifiée, et la fonction retourne TRUE. + </para> + <para> + Les options suivantes sont disponibles : + <table> + <title>options d'analyseur XML </title> + <tgroup cols="3"> + <thead> + <row> + <entry>Option</entry> + <entry>Type de données</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>XML_OPTION_CASE_FOLDING</entry> + <entry>entier</entry> + <entry> + Contrôle la gestion de la <link linkend="xml.case-folding">casse</link> + des balises de cet analyseur XML. Par défaut, activé. + </entry> + </row> + <row> + <entry>XML_OPTION_TARGET_ENCODING</entry> + <entry>string</entry> + <entry> + Modifie le <link linkend="xml.encoding">codage à la cible</link> + utilisé par cet analyseur XML. Par défaut, c'est celui + qui a été spécifié lors de l'appel de + <function>xml_parser_create</function>. Les codages supportés + sont <literal>ISO-8859-1</literal>, <literal>US-ASCII</literal> + et <literal>UTF-8</literal>. + </entry> + </row> + </tbody> + </tgroup> + </table> + </para> + </refsect1> + </refentry> + <refentry id="function.xml-parser-get-option"> + <refnamediv> + <refname>xml_parser_get_option</refname> + <refpurpose>Lit les options d'un analyseur XML.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>mixed + <function>xml_parser_get_option</function> + </funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + <paramdef>int <parameter>option</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem> + <simpara> + Une référence sur un analyseur XML valide. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>option</parameter></term> + <listitem> + <simpara> + L'option demandée. Reportez vous à + <function>xml_parser_set_option</function> pour avoir la liste des + options disponibles. + </simpara> + </listitem> + </varlistentry> + </variablelist> + </para> + <para> + Cette fonction retourne FALSE si <parameter>parser</parameter> + n'est pas valide, ou sinon, retourne la valeur de l'option demandée. + </para> + <para> + Reportez vous à <function>xml_parser_set_option</function> pour avoir la + liste des options disponibles. + </para> + </refsect1> + </refentry> + <refentry id="function.utf8-decode"> + <refnamediv> + <refname>utf8_decode</refname> + <refpurpose> + Converti un une chaîne UTF-8 en ISO-8859 + .</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>utf8_decode</function></funcdef> + <paramdef>string <parameter>data</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>utf8_decode</function> décode la chaîne + <parameter>data</parameter>, en supposant qu'elle est au format + <literal>UTF-8</literal>, et la convertit au format + <literal>ISO-8859-1</literal>. + </para> + <para> + Voir aussi <function>utf8_encode</function>pour plus de + détails sur le codage <literal>UTF-8</literal>. + </para> + </refsect1> + </refentry> + <refentry id="function.utf8-encode"> + <refnamediv> + <refname>utf8_encode</refname> + <refpurpose>Convertit un une chaîne ISO-8859-1 en UTF-8.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>utf8_encode</function></funcdef> + <paramdef>string <parameter>data</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + Cette fonction code la chaîne data au format <literal>UTF-8</literal>, + et retourne la version codée. <literal>UTF-8</literal> est un + mécanisme standardisé utilisé par Unicode pour + coder les caractère de grande taille dans des flots d'octets. + <literal>UTF-8</literal> est transparent pour les caractères + <abbrev>ASCII</abbrev>, il est auto-synchronisé (c'est à + dire qu'un programme peut toujours savoir dans un flot d'octet oú + un caractère commence), et peut être utilisé pour + faire des comparaisons de chaînes standard, comme pour le tri. PHP + utilise l'<literal>UTF-8</literal> pour coder les caractères + jusqu'à 4 octets comme ceci : + <table> + <title>UTF-8 encoding</title> + <tgroup cols="3"> + <thead> + <row> + <entry>octets</entry> + <entry>bits</entry> + <entry>représentation</entry> + </row> + </thead> + <tbody> + <row> + <entry>1</entry> + <entry>7</entry> + <entry>0bbbbbbb</entry> + </row> + <row> + <entry>2</entry> + <entry>11</entry> + <entry>110bbbbb 10bbbbbb</entry> + </row> + <row> + <entry>3</entry> + <entry>16</entry> + <entry>1110bbbb 10bbbbbb 10bbbbbb</entry> + </row> + <row> + <entry>4</entry> + <entry>21</entry> + <entry>11110bbb 10bbbbbb 10bbbbbb 10bbbbbb</entry> + </row> + </tbody> + </tgroup> + </table> + Chaque <replaceable>b</replaceable> représente un bit qui peut + être utilisé pour enregistrer un caractère. + </para> + </refsect1> + </refentry> + </reference> +<!-- Keep this comment at the end of the file +Local variables: +mode: sgml +sgml-omittag:t +sgml-shorttag:t +sgml-minimize-attributes:nil +sgml-always-quote-attributes:t +sgml-indent-step:1 +sgml-indent-data:t +sgml-parent-document:nil +sgml-default-dtd-file:"../../manual.ced" +sgml-exposed-tags:nil +sgml-local-catalogs:nil +sgml-local-ecat-files:nil +End: +-->
Index: phpdoc/fr/functions/xml.xml diff -u phpdoc/fr/functions/xml.xml:1.1 phpdoc/fr/functions/xml.xml:1.2 --- phpdoc/fr/functions/xml.xml:1.1 Fri Jul 21 03:27:50 2000 +++ phpdoc/fr/functions/xml.xml Thu Nov 23 06:26:50 2000 @@ -1,1789 +1,2053 @@ - <reference id="ref.xml"> - <title>Analyseur syntaxique XML</title> - <titleabbrev>XML</titleabbrev> - - <partintro> - <sect1 id="xml.partintro"> - <title>Introduction</title> - <sect2 id="xml.intro"> - <title>A propos de XML</title> - <para> - Le langage XML (eXtensible Markup Language (Langage à Balises Etendu)) est - un format structuré de données pour les échanges sur le web. C'est un standard - défini par le consortium World Wide Web (W3C). Plus d'informations à propos - du XML et des technologies afférentes sont accessibles (en anglais) - <ulink url="&url.xml;">&url.xml;</ulink>. - </para> - </sect2> - <sect2 id="xml.install"> - <title>Installation</title> - <para> - Cette extension de PHP utilise <productname>expat</productname>, disponible - à <ulink url="&url.expat;">&url.expat;</ulink>. Le fichier Makefile livré avec - expat ne construit pas par défaut de librairie : il faut utiliser la ligne - suivante : - <programlisting role="makefile"> -libexpat.a: $(OBJS) - ar -rc $@ $(OBJS) - ranlib $@ - </programlisting> - Les sources de expat sont disponibles à -<ulink url="&url.expat.rpm;">&url.expat.rpm;</ulink>. - </para> - <para> - Notez que si vous utilisez Apache-1.3.7 ou plus récent, vous disposez déjà - de la librairie expat. Configurez simplement PHP avec <option role="configure">--with-xml</option> - (sans aucun autre information) et la librairie expat d'Apache sera - automatiquement utilisée. - </para> - <para> - Sous UNIX, lancez la configuration de PHP avec l'option - <option role="configure">--with-xml</option>, la librairie expat étant installée - là oú votre compilateur peut la trouver. - Si vous compilez PHP comme module de PHP 1.3.9 ou plus récent, PHP utilisera - automatiquement le module <productname>expat</productname> livré avec Apache. - Il vous faudra peut être fixer les valeurs des variables d'environnement - <envar>CPPFLAGS</envar> et <envar>LDFLAGS</envar>, si vous avez fait une - installation exotique. - </para> - <para> - Compilez PHP. <emphasis>Tada!</emphasis> C'est fait ! - </para> - </sect2> - - <sect2 id="xml.about"> - <title>A propos de cette extension :</title> - <para> - Cette extension PHP supporte la librairie <productname>expat</productname> de - James Clark sous PHP. Cela vous permettra d'analyser mais pas de valider les - documents XML. Il supporte trois types de codage différents, disponibles aussi - sous PHP: - <literal>US-ASCII</literal>, <literal>ISO-8859-1</literal> et <literal>UTF-8</literal>. - <literal>UTF-16</literal> n'est pas supporté. - </para> - <para> - Cette extension vous permet de créer des - <link linkend="function.xml-parser-create">analyseurs XML</link> - puis de définir des <emphasis>points d'entrée</emphasis> pour chaque événement - XML. Les analyseurs XML disposent de quelques - <link linkend="function.xml-parser-set-option">paramétrages</link>. - </para> - <para> - Les gestionnaires d'évènements XML sont: - <table> - <title>Les gestionnaires d'évènements XML</title> - <tgroup cols="2"> - <thead> - <row> - <entry>Fonction PHP de configuration du gestionnaire</entry> - <entry>Description de l'événement</entry> - </row> - </thead> - <tbody> - <row> - <entry><function>xml_set_element_handler</function></entry> - <entry> - Un événement est généré à chaque fois que l'analyseur XML rencontre une - balise de début ou de fin. Deux gestionnaires sont disponibles : un - pour le début, et un pour la fin. - </entry> - </row> - <row> - <entry> - <function>xml_set_character_data_handler</function> - </entry> - <entry> - "Character data" correspond grosso modo à tout ce qui n'est pas une - balise XML, y compris les espaces entre les balises. Notez bien que - l'analyseur XML n'ajoute ou n'efface aucun espace, et que c'est à - l'application (c'est à dire vous) de décider de la signification de ces - espaces. - </entry> - </row> - <row> - <entry> - <function>xml_set_processing_instruction_handler</function> - </entry> - <entry> - Les programmeurs PHP sont habitués aux instructions exécutables - (processing instructions ou PIs). <?php ?> est une instruction - exécutable oú php est appelé programme cible. Ces instructions sont - gérées de manière spécifiques, (sauf le programme cible, qui est - réservé à XML). - </entry> - </row> - <row> - <entry><function>xml_set_default_handler</function></entry> - <entry> - Tout ce qui n'a pas trouvé de gestionnaire est transmis au gestionnaire - par défaut. Vous retrouverez par exemple, les déclarations de type - de document dans ce gestionnaire. - </entry> - </row> - <row> - <entry> - <function>xml_set_unparsed_entity_decl_handler</function> - </entry> - <entry> - Ce gestionnaire est appelé pour gérer les déclaration des entités - non analysés. - </entry> - </row> - <row> - <entry> - <function>xml_set_notation_decl_handler</function> - </entry> - <entry> - Ce gestionnaire est appelé pour gérer les notations. - </entry> - </row> - <row> - <entry> - <function>xml_set_external_entity_ref_handler</function> - </entry> - <entry> - Ce gestionnaire est appelé lorsque l'analyseur XML trouve une référence - à un fichier externe. Cela peut être un fichier, ou une URL. Reportez - vous à <link linkend="example.xml-external-entity">entité externe</link> - pour un exemple. - </entry> - </row> - </tbody> - </tgroup> - </table> - </para> - </sect2> - - <sect2 id="xml.case-folding"> - <title>Problèmes de casse</title> - <para> - Les fonctions de gestion des balises peuvent rencontrer des balises en - minuscule, majuscule ou encore dans un mélange des deux. En XML, la procédure - standard est d' "identifier les séquences de caractère qui ne sont pas - reconnues comme majuscule, et de les remplacer par leur équivalent majuscule". - En d'autres termes, XML met toutes lettres en majuscules. - </para> - <para> - Par défaut, tous les noms des éléments qui sont transmis aux fonctions de - gestion sont mises en majuscule. Ce comportement est contrôlé par l'analyseur - XML, et peut être lu et modifié avec les fonctions respectives - <function>xml_parser_get_option</function> et <function>xml_parser_set_option</function>, - respectivement. - </para> - </sect2> - - <sect2 id="xml.error-codes"> - <title>Error Codes</title> - <para> - Les constantes suivantes sont définies comme des codes d'erreurs XML : - (retournée par <function>xml_parse</function>): - <simplelist> - <member>XML_ERROR_NONE</member> - <member>XML_ERROR_NO_MEMORY</member> - <member>XML_ERROR_SYNTAX</member> - <member>XML_ERROR_NO_ELEMENTS</member> - <member>XML_ERROR_INVALID_TOKEN</member> - <member>XML_ERROR_UNCLOSED_TOKEN</member> - <member>XML_ERROR_PARTIAL_CHAR</member> - <member>XML_ERROR_TAG_MISMATCH</member> - <member>XML_ERROR_DUPLICATE_ATTRIBUTE</member> - <member>XML_ERROR_JUNK_AFTER_DOC_ELEMENT</member> - <member>XML_ERROR_PARAM_ENTITY_REF</member> - <member>XML_ERROR_UNDEFINED_ENTITY</member> - <member>XML_ERROR_RECURSIVE_ENTITY_REF</member> - <member>XML_ERROR_ASYNC_ENTITY</member> - <member>XML_ERROR_BAD_CHAR_REF</member> - <member>XML_ERROR_BINARY_ENTITY_REF</member> - <member>XML_ERROR_ATTRIBUTE_EXTERNAL_ENTITY_REF</member> - <member>XML_ERROR_MISPLACED_XML_PI</member> - <member>XML_ERROR_UNKNOWN_ENCODING</member> - <member>XML_ERROR_INCORRECT_ENCODING</member> - <member>XML_ERROR_UNCLOSED_CDATA_SECTION</member> - <member>XML_ERROR_EXTERNAL_ENTITY_HANDLING</member> - </simplelist> - </para> - </sect2> - <sect2 id="xml.encoding"> - <title>Codage des caractères</title> - <para> - L'extension XML de PHP supporte les caractères - <ulink url="&url.unicode;">Unicode</ulink> grâce à différents codages. Il y - a deux types de codages de caractères : le codage à la source et le codage à la - cible. PHP utilise le <literal>UTF-8</literal> comme représentation interne. - </para> - <para> - L'encodage à la source est effectué lors de - <link linkend="function.xml-parse">l'analyse</link> du fichier par XML. - Lors de la <link linkend="function.xml-parser-create"> création d'un analyseur - XML</link>), un type de codage à la source doit être spécifié (et il ne pourra - plus être modifié jusqu'à la destruction de l'analyseur). Les codages supportés - sont : <literal>ISO-8859-1</literal>, <literal>US-ASCII</literal> et - <literal>UTF-8</literal>. Les deux derniers sont des codages à un seul octet, - c'est à dire que les caractères sont représentés sur un seul octet. - <literal>UTF-8</literal> peut représenter des caractères composés par un - nombre variable de bits (jusqu'à 21), allant de 1 à quatre octets. - Le codage par défaut utilisé par PHP <literal>ISO-8859-1</literal>. - </para> - <para> - Le codage à la cible est effectué lorsque PHP transfert les données aux - gestionnaires XML. Lorsqu'un analyseur est créé, le codage à la cible est - spécifié de la même façon que le codage à la source, mais il peut être modifié - à tout moment. Le codage à la cible affectera les balises, tout comme les - données brutes, et les noms des instructions exécutables. - </para> - <para> - Si l'analyseur XML rencontre un caractère qu'il ne connaît pas (hors limite, - par exemple), il retournera une erreur. - </para> - <para> - Si PHP rencontre un caractère dans le document XML analysé, qu'il ne peut pas - représenter dans le codage à la cible choisi, le caractère sera remplacé par un - point d'interrogation (cette attitude est suceptible de changer ultérieurement). - </para> - </sect2> - </sect1> - - <sect1 id="xml.examples"> - <title>Quelques exemples</title> - <para> - Voici une liste d'exemple de code PHP qui analyse un document XML. - </para> - <sect2 id="example.xml-structure"> - <title>Exemple de structure XML</title> - <para> - Ce premier exemple affiche la structure de l'élément de début dans un document - avec indentation/ - <example> - <title>Afficher une structure XML</title> - <programlisting role="php"> -$file = "data.xml"; -$depth = array(); - -function startElement($parser, $name, $attrs) { - global $depth; - for ($i = 0; $i < $depth[$parser]; $i++) { - print " "; - } - print "$name\n"; - $depth[$parser]++; -} - -function endElement($parser, $name) { - global $depth; - $depth[$parser]--; -} - -$xml_parser = xml_parser_create(); -xml_set_element_handler($xml_parser, "startElement", "endElement"); -if (!($fp = fopen($file, "r"))) { - die("could not open XML input"); -} - -while ($data = fread($fp, 4096)) { - if (!xml_parse($xml_parser, $data, feof($fp))) { - die(sprintf("XML error: %s at line %d", - xml_error_string(xml_get_error_code($xml_parser)), - xml_get_current_line_number($xml_parser))); - } -} -xml_parser_free($xml_parser); - </programlisting> - </example> - </para> - </sect2> - - <sect2 id="example.xml-map-tags"> - <title>XML Transtypage XML -> HTML</title> - <para> - <example> - <title>XML Transtypage XML -> HTML</title> - <para> - Cet exemple remplace les balises XML d'un document par des balises - HTML. Les éléments inconnus seront ignorés. Bien entendu, cet exemple - sera appliqué à un type précis de fichiers XML. - <programlisting role="php"> -$file = "data.xml"; -$map_array = array( - "BOLD" => "B", - "EMPHASIS" => "I", - "LITERAL" => "TT" -); - -function startElement($parser, $name, $attrs) { - global $map_array; - if ($htmltag = $map_array[$name]) { - print "<$htmltag>"; - } -} - -function endElement($parser, $name) { - global $map_array; - if ($htmltag = $map_array[$name]) { - print "</$htmltag>"; - } -} - -function characterData($parser, $data) { - print $data; -} - -$xml_parser = xml_parser_create(); -// use case-folding so we are sure to find the tag in $map_array -xml_parser_set_option($xml_parser, XML_OPTION_CASE_FOLDING, TRUE); -xml_set_element_handler($xml_parser, "startElement", "endElement"); -xml_set_character_data_handler($xml_parser, "characterData"); -if (!($fp = fopen($file, "r"))) { - die("could not open XML input"); -} - -while ($data = fread($fp, 4096)) { - if (!xml_parse($xml_parser, $data, feof($fp))) { - die(sprintf("XML error: %s at line %d", - xml_error_string(xml_get_error_code($xml_parser)), - xml_get_current_line_number($xml_parser))); - } -} -xml_parser_free($xml_parser); - </programlisting> - </para> - </example> - </para> - </sect2> - - <sect2 id="example.xml-external-entity"> - <title>XML Entitée externe</title> - <para> -Cet exemple exploite les références externes de XML : il est possible d'utiliser un gestionnaire d'entité externe pour inclure et analyser les documents, tous comme les instructions exécutables peuvent servir à inclure et analyser d'autres documents, et aussi fournir une indication de confiance (voir plus bas). - </para> - <para> - Le document XML qui est utilisé dans cet exemple est fourni plus loin dans - l'exemple (<filename>xmltest.xml</filename> et <filename>xmltest2.xml</filename>). - </para> - <para> - <example> - <title>Entitée externe</title> - <programlisting role="php"> -$file = "xmltest.xml"; - -function trustedFile($file) { - // only trust local files owned by ourselves - if (!eregi("^([a-z]+)://", $file) - && fileowner($file) == getmyuid()) { - return TRUE; - } - return FALSE; -} - -function startElement($parser, $name, $attribs) { - print "&lt;<font color=\"#0000cc\">$name</font>"; - if (sizeof($attribs)) { - while (list($k, $v) = each($attribs)) { - print " <font color=\"#009900\">$k</font>=\"<font - color=\"#990000\">$v</font>\""; - } - } - print "&gt;"; -} - -function endElement($parser, $name) { - print "&lt;/<font color=\"#0000cc\">$name</font>&gt;"; -} - -function characterData($parser, $data) { - print "<b>$data</b>"; -} - -function PIHandler($parser, $target, $data) { - switch (strtolower($target)) { - case "php": - global $parser_file; - // If the parsed document is "trusted", we say it is safe - // to execute PHP code inside it. If not, display the code - // instead. - if (trustedFile($parser_file[$parser])) { - eval($data); - } else { - printf("Untrusted PHP code: <i>%s</i>", - htmlspecialchars($data)); - } - break; - } -} - -function defaultHandler($parser, $data) { - if (substr($data, 0, 1) == "&" && substr($data, -1, 1) == ";") { - printf('<font color="#aa00aa">%s</font>', - htmlspecialchars($data)); - } else { - printf('<font size="-1">%s</font>', - htmlspecialchars($data)); - } -} - -function externalEntityRefHandler($parser, $openEntityNames, $base, $systemId, - $publicId) { - if ($systemId) { - if (!list($parser, $fp) = new_xml_parser($systemId)) { - printf("Could not open entity %s at %s\n", $openEntityNames, - $systemId); - return FALSE; - } - while ($data = fread($fp, 4096)) { - if (!xml_parse($parser, $data, feof($fp))) { - printf("XML error: %s at line %d while parsing entity %s\n", - xml_error_string(xml_get_error_code($parser)), - xml_get_current_line_number($parser), $openEntityNames); - xml_parser_free($parser); - return FALSE; - } - } - xml_parser_free($parser); - return TRUE; - } - return FALSE; -} - - -function new_xml_parser($file) { - global $parser_file; - - $xml_parser = xml_parser_create(); - xml_parser_set_option($xml_parser, XML_OPTION_CASE_FOLDING, 1); - xml_set_element_handler($xml_parser, "startElement", "endElement"); - xml_set_character_data_handler($xml_parser, "characterData"); - xml_set_processing_instruction_handler($xml_parser, "PIHandler"); - xml_set_default_handler($xml_parser, "defaultHandler"); - xml_set_external_entity_ref_handler($xml_parser, "externalEntityRefHandler"); - - if (!($fp = @fopen($file, "r"))) { - return FALSE; - } - if (!is_array($parser_file)) { - settype($parser_file, "array"); - } - $parser_file[$xml_parser] = $file; - return array($xml_parser, $fp); -} - -if (!(list($xml_parser, $fp) = new_xml_parser($file))) { - die("could not open XML input"); -} - -print "<pre>"; -while ($data = fread($fp, 4096)) { - if (!xml_parse($xml_parser, $data, feof($fp))) { - die(sprintf("XML error: %s at line %d\n", - xml_error_string(xml_get_error_code($xml_parser)), - xml_get_current_line_number($xml_parser))); - } -} -print "</pre>"; -print "parse complete\n"; -xml_parser_free($xml_parser); - -?> - </programlisting> - </example> - </para> - <para id="example.xml-xmltest.xml"> - <example> - <title>xmltest.xml</title> - <programlisting role="xml"> -<?xml version='1.0'?> -<!DOCTYPE chapter SYSTEM "/just/a/test.dtd" [ -<!ENTITY plainEntity "FOO entity"> -<!ENTITY systemEntity SYSTEM "xmltest2.xml"> -]> -<chapter> - <TITLE>Title &plainEntity;</TITLE> - <para> - <informaltable> - <tgroup cols="3"> - <tbody> - <row><entry>a1</entry><entry morerows="1">b1</entry><entry>c1</entry></row> - <row><entry>a2</entry><entry>c2</entry></row> - <row><entry>a3</entry><entry>b3</entry><entry>c3</entry></row> - </tbody> - </tgroup> - </informaltable> - </para> - &systemEntity; - <sect1 id="about"> - <title>About this Document</title> - <para> - <!-- this is a comment --> - <?php print 'Hi! This is PHP version '.phpversion(); ?> - </para> - </sect1> -</chapter> - </programlisting> - </example> - </para> - <para id="example.xml-xmltest2.xml"> - This file is included from <filename>xmltest.xml</filename>: - <example> - <title>xmltest2.xml</title> - <programlisting role="xml"> -<?xml version="1.0"?> -<!DOCTYPE foo [ -<!ENTITY testEnt "test entity"> -]> -<foo> - <element attrib="value"/> - &testEnt; - <?php print "This is some more PHP code being executed."; ?> -</foo> - </programlisting> - </example> - </para> - </sect2> - </sect1> - </partintro> - - <refentry id="function.xml-parser-create"> - <refnamediv> - <refname>xml_parser_create</refname> - <refpurpose>Création d'un analyseur XML.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>xml_parser_create</function></funcdef> - <paramdef>string - <parameter><optional>encoding</optional></parameter> - </paramdef> - </funcsynopsis> - <para> - <variablelist> - <varlistentry> - <term><parameter>encoding</parameter> (optional)</term> - <listitem> - <para> - Le codage de caractère de l'analyseur : les codages suivants sont supportés : - <simplelist> - <member><literal>ISO-8859-1</literal> (par défaut)</member> - <member><literal>US-ASCII</literal></member> - <member><literal>UTF-8</literal></member> - </simplelist> - </para> - </listitem> - </varlistentry> - </variablelist> - Cette fonction crée un analyseur XML et retourne une référence sur cet - analyseur pour qu'il puisse être utilisé ultérieurement par d'autres fonctions - XML. Retourne TRUE ou FALSE. - </para> - </refsect1> - </refentry> - - <refentry id="function.xml-set-object"> - <refnamediv> - <refname>xml_set_object</refname> - <refpurpose>Utilise un analyseur XML à l'intérieur d'un objet.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>void <function>xml_set_object</function></funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>object <parameter>&object</parameter></paramdef> - </funcsynopsis> - <para> - Cette fonction rend l'analyseur <parameter>parser</parameter> - utilisable depuis un objet. Toutes les méthodes de callback, affectées par - <function>xml_set_element_handler</function>, seront les méthodes de cet objet. - </para> - <programlisting role="php"> -<?php -class xml { -var $parser; - -function xml() { - $this->parser = xml_parser_create(); - xml_set_object($this->parser,&$this); - xml_set_element_handler($this->parser,"tag_open","tag_close"); - xml_set_character_data_handler($this->parser,"cdata"); -} - -function parse($data) { - xml_parse($this->parser,$data); -} - -function tag_open($parser,$tag,$attributes) { - var_dump($parser,$tag,$attributes); -} - -function cdata($parser,$cdata) { - var_dump($parser,$cdata); -} - -function tag_close($parser,$tag) { - var_dump($parser,$tag); -} - -} // fin de la classe xml - -$xml_parser = new xml(); -$xml_parser->parse("<A ID=\"hallo\">PHP</A>"); -?> - </programlisting> - <para> - <note> - <para> - <function>xml_set_object</function> a été ajouté dans PHP 4.0. - </para> - </note> - </para> - </refsect1> - </refentry> - - <refentry id="function.xml-set-element-handler"> - <refnamediv> - <refname>xml_set_element_handler</refname> - <refpurpose>Affecte les gestionnaires de début et de fin.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int - <function>xml_set_element_handler</function> - </funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string - <parameter>startElementHandler</parameter> - </paramdef> - <paramdef>string - <parameter>endElementHandler</parameter> - </paramdef> - </funcsynopsis> - <para> - Affecte les gestionnaires de début et de fin de l'analyseur XML - <parameter>parser</parameter>. <parameter>startElementHandler</parameter> et - <parameter>endElementHandler</parameter> sont des chaînes qui contiennent les - noms de fonctions qui existent lorsque <function>xml_parse</function> est appelé - pour créer <parameter>parser</parameter>. - </para> - <para> - La fonction <parameter>startElementHandler</parameter> doit - accepter trois paramètres: - <funcsynopsis> - <funcdef><replaceable>startElementHandler</replaceable></funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string <parameter>name</parameter></paramdef> - <paramdef>string <parameter>attribs</parameter></paramdef> - </funcsynopsis> - <variablelist> - <varlistentry> - <term><parameter>parser</parameter></term> - <listitem> - <simpara> - Le premier paramètre, <replaceable>parser</replaceable>, est une référence - sur l'analyseur XML qui appelle cette fonction. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>name</parameter></term> - <listitem> - <simpara> - Le deuxième paramètre, <parameter>name</parameter>, contiens le nom de - l'élément qui a provoqué l'appel du gestionnaire. Si l'analyseur gère la - <link linkend="xml.case-folding">casse</link>, cet élément sera en - majuscule. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>attribs</parameter></term> - <listitem> - <simpara> - Le troisième paramètre, <parameter>attribs</parameter>, contient un tableau - associatif avec les attributs de l'éléments (si il en existe). Les clés de - ce tableau seront les noms des attributs, et les valeurs seront les valeurs - correspondantes des attributs. Les noms des attributs seront mis en - majuscule si l'analyseur gère la <link linkend="xml.case-folding">casse</link>. - Les valeurs des attributs seront intouchées. - </simpara> - <simpara> - L'ordre original des attributs peut être retrouvé en passant en revue le - tableau <parameter>attribs</parameter>, avec la fonction - <function>each</function>. La première clé sera la première clé du - tableau. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - <para> - La fonction <parameter>endElementHandler</parameter> doit accepter deux paramètres: - <funcsynopsis> - <funcdef><replaceable>endElementHandler</replaceable></funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string <parameter>name</parameter></paramdef> - </funcsynopsis> - <variablelist> - <varlistentry> - <term><parameter>parser</parameter></term> - <listitem> - <simpara> - Le premier paramètre, <replaceable>parser</replaceable>, est une référence - sur l'analyseur XML qui appelle cette fonction. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>name</parameter></term> - <listitem> - <simpara> - Le second paramètre, <parameter>name</parameter>, contient le nom de - l'élément qui a provoqué l'appel du gestionnaire. Si l'analyseur gère la - <link linkend="xml.case-folding">casse</link>, cet élément sera en - majuscule. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - <para> - Si un gestionnaire recoit une chaîne vide, ou FALSE, c'est qu'il est en - train d'être désactivé. - </para> - <para> - Retourne TRUE si le gestionnaire est actif, et FALSE sinon, ou si - <parameter>parser</parameter> n'est pas un analyseur. - </para> - <para> - Il n'est pas pour l'instant possible d'utiliser des objets pour servir de - gestionnaire. - </para> - </refsect1> - </refentry> - - <refentry id="function.xml-set-character-data-handler"> - <refnamediv> - <refname>xml_set_character_data_handler</refname> - <refpurpose>Affecte les gestionnaires de caractère bruts.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int - <function>xml_set_character_data_handler</function> - </funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string <parameter>handler</parameter></paramdef> - </funcsynopsis> - <para> - Affecte les gestionnaires de début et de fin de l'analyseur XML - <parameter>parser</parameter>. <parameter>handler</parameter> est une chaîne qui - contient le nom d'une fonction qui existe lorsque <function>xml_parse</function> - est appelé pour créer <parameter>parser</parameter>. - </para> - <para> - La fonction <parameter>handler</parameter> doit accepter deux paramètres: - <funcsynopsis> - <funcdef><replaceable>handler</replaceable></funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string <parameter>data</parameter></paramdef> - </funcsynopsis> - <variablelist> - <varlistentry> - <term><parameter>parser</parameter></term> - <listitem> - <simpara> - Le premier paramètre, <replaceable>parser</replaceable>, est une référence - sur l'analyseur XML qui appelle cette fonction. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>data</parameter></term> - <listitem> - <simpara> - Le second paramètre, <parameter>data</parameter>, contient les caractères - sous la forme d'une chaîne. - </simpara> - </listitem> - </varlistentry> - </variablelist></para> - <para> - Si un gestionnaire reçoit une chaîne vide ou FALSE, c'est qu'il est en train - d'être désactivé. - </para> - <para> - Retourne TRUE si le gestionnaire est actif, et FALSE sinon, ou si - <parameter>parser</parameter> n'est pas un analyseur. - </para> - <para> - Il n'est pas pour l'instant possible d'utiliser des objets pour servir de - gestionnaire. - </para> - </refsect1> - </refentry> - - <refentry id="function.xml-set-processing-instruction-handler"> - <refnamediv> - <refname>xml_set_processing_instruction_handler</refname> - <refpurpose> - Affecte les gestionnaires d'instructions exécutables. - .</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int - <function>xml_set_processing_instruction_handler</function> - </funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string <parameter>handler</parameter></paramdef> - </funcsynopsis> - <para> - Affecte les gestionnaires d'instructions exécutables de l'analyseur XML - <parameter>parser</parameter>. <parameter>handler</parameter> est une chaîne - qui contient le nom d'une fonction qui existe lorsque <function>xml_parse</function> - est appelé pour créer <parameter>parser</parameter>. - </para> - <para> - Une instruction exécutable a la forme suivante :: - <informalexample> - <programlisting><? - <replaceable>target</replaceable> - <replaceable>data</replaceable>?> - </programlisting> - </informalexample> - Vous pouvez mettre du code PHP entre ces balises, mais soyez conscient d'une - des limitations des instructions exécutables de XML : la balise de fin - d'instruction éxécutable (<literal>?></literal>) ne peut être échappée, ce - qui fait que cette séquence NE DOIT JAMAIS apparaître dans le code PHP placé - dans le document PHP. Si un tel texte apparaît, la balise de fin d'instruction - exécutable sera reconnue, et le reste du code sera considéré comme des données - brutes (et donc, pas exécutées). - </para> - <para> - La fonction <parameter>handler</parameter> doit accepter trois paramètres: - <funcsynopsis> - <funcdef><replaceable>handler</replaceable></funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string <parameter>target</parameter></paramdef> - <paramdef>string <parameter>data</parameter></paramdef> - </funcsynopsis> - <variablelist> - <varlistentry> - <term><parameter>parser</parameter></term> - <listitem><simpara> - Le premier paramètre, <replaceable>parser</replaceable>, est une référence - sur l'analyseur XML qui appelle cette fonction. - </simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>target</parameter></term> - <listitem><simpara> - Le second paramètre, <parameter>target</parameter>, contient l'application - cible. - </simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>data</parameter></term> - <listitem><simpara> - Le troisième paramètre, <parameter>data</parameter>, contient le code sous la - forme d'une chaîne. - </simpara></listitem> - </varlistentry> - </variablelist></para> - <para> - Si un gestionnaire reçoit une chaîne vide, ou FALSE, c'est qu'il est en train - d'être désactivé. - </para> - <para> - Retourne TRUE si le gestionnaire est actif, et FALSE sinon, ou si - <parameter>parser</parameter> n'est pas un analyseur. - </para> - <para> - Il n'est pas pour l'instant possible d'utiliser des objets pour servir de - gestionnaire. - </para> - </refsect1> - </refentry> - - <refentry id="function.xml-set-default-handler"> - <refnamediv> - <refname>xml_set_default_handler</refname> - <refpurpose>Affecte le gestionnaire par défaut.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int - <function>xml_set_default_handler</function> - </funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string <parameter>handler</parameter></paramdef> - </funcsynopsis> - <para> - Affecte le gestionnaire par défaut de l'analyseur XML - <parameter>parser</parameter>. <parameter>handler</parameter> est une chaîne qui - contient le nom d'une fonction qui existe lorsque <function>xml_parse</function> - est appelé pour créer <parameter>parser</parameter>. - </para> - <para> - La fonction <parameter>handler</parameter> doit accepter deux paramètres: - <funcsynopsis> - <funcdef><replaceable>handler</replaceable></funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string <parameter>data</parameter></paramdef> - </funcsynopsis> - <variablelist> - <varlistentry> - <term> - <parameter>parser</parameter> - </term> - <listitem> - <simpara> - Le premier paramètre, <replaceable>parser</replaceable>, est une référence sur - l'analyseur XML qui appelle cette fonction. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>data</parameter> - </term> - <listitem> - <simpara> - Le second paramètre, <parameter>data</parameter>, contient les caractères - sous la forme d'une chaîne. Cela peut être une déclaration XML, un type de - document, une entité ou d'autre données pour qui aucun gestionnaire n'est - prévu. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - <para> - Si un gestionnaire reçoit une chaîne vide ou FALSE, c'est qu'il est en train - d'être désactivé. - </para> - <para> - Retourne TRUE si le gestionnaire est actif, et FALSE sinon, ou si - <parameter>parser</parameter> n'est pas un analyseur. - </para> - <para> - Il n'est pas pour l'instant possible d'utiliser des objets pour servir de - gestionnaire. - </para> - </refsect1> - </refentry> - - <refentry id="function.xml-set-unparsed-entity-decl-handler"> - <refnamediv> - <refname>xml_set_unparsed_entity_decl_handler</refname> - <refpurpose> - Affecte les gestionnaires d'entité non déclaré. - .</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int - <function>xml_set_unparsed_entity_decl_handler</function> - </funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string <parameter>handler</parameter></paramdef> - </funcsynopsis> - <para> - Affecte les gestionnaires d'entité non déclaré de l'analyseur XML - <parameter>parser</parameter>. <parameter>handler</parameter> est une chaîne qui - contient le nom d'une fonction qui existe lorsque <function>xml_parse</function> - est appelé pour créer <parameter>parser</parameter>. - </para> - <para> - Ce gestionnaire sera appelé si l'analyseur XML rencontre une déclaration - d'entité externe avec une déclaration de NDATA, comme suit : - <programlisting role="xml"> -<!ENTITY <parameter>name</parameter> {<parameter>publicId</parameter> | <parameter>systemId</parameter>} - NDATA <parameter>notationName</parameter>> - </programlisting> - </para> - <para> - Reportez vous à la - <ulink url="&url.rec-xml;#sec-external-ent">section 4.2.2 des spécifications XML 1.0</ulink> - pour connaître les notations des entités externes. - </para> - <para> - La fonction <parameter>handler</parameter> doit accepter six paramètres: - <funcsynopsis> - <funcdef><replaceable>handler</replaceable></funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string <parameter>entityName</parameter></paramdef> - <paramdef>string <parameter>base</parameter></paramdef> - <paramdef>string <parameter>systemId</parameter></paramdef> - <paramdef>string <parameter>publicId</parameter></paramdef> - <paramdef>string <parameter>notationName</parameter></paramdef> - </funcsynopsis> - <variablelist> - <varlistentry> - <term><parameter>parser</parameter></term> - <listitem> - <simpara> - Le premier paramètre, <replaceable>parser</replaceable>, est une référence - sur l'analyseur XML qui appelle cette fonction. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>entityName</parameter></term> - <listitem> - <simpara> - Le nom de l'entitée qui va être définie - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>base</parameter></term> - <listitem><simpara> - La meilleure base de résolution de l'identifiant système de cette entité - externe. Actuellement, ce paramètre est toujours une chaîne vide. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>systemId</parameter></term> - <listitem> - <simpara> - Identifiant système pour cet entité externe. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>publicId</parameter></term> - <listitem> - <simpara> - Identifiant public pour cet entité externe. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>notationName</parameter></term> - <listitem> - <simpara> - Nom de la notation de cette entité. (Voir <function>xml_set_notation_decl_handler</function>). - </simpara> - </listitem> - </varlistentry> - </variablelist></para> - <para> - Si un gestionnaire reçoit une chaîne vide ou FALSE, c'est qu'il est en train - d'être désactivé. - </para> - <para> - Retourne TRUE si le gestionnaire est actif, et FALSE sinon, ou si - <parameter>parser</parameter> n'est pas un analyseur. - </para> - <para> - Il n'est pas pour l'instant possible d'utiliser des objets pour servir de - gestionnaire. - </para> - </refsect1> - </refentry> - - <refentry id="function.xml-set-notation-decl-handler"> - <refnamediv> - <refname>xml_set_notation_decl_handler</refname> - <refpurpose>Affecte les gestionnaires de notation.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int - <function>xml_set_notation_decl_handler</function> - </funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string <parameter>handler</parameter></paramdef> - </funcsynopsis> - <para> - Affecte les gestionnaires de début et de fin de l'analyseur XML - <parameter>parser</parameter>. <parameter>handler</parameter> est une chaîne qui - contient le nom d'une fonction qui existe lorsque <function>xml_parse</function> - est appelé pour créer <parameter>parser</parameter>. - </para> - <para> - Une notation est une partie du DTD du document, qui a le format suivant : - - <programlisting role="xml"><!NOTATION - <parameter>name</parameter> {<parameter>systemId</parameter> | - <parameter>publicId</parameter>}></programlisting> - Reportez vous à la <ulink url="&url.rec-xml;#sec-external-ent">section 4.2.2 des - spécifications XML 1.0</ulink> pour connaître les notations des entités externes. - </para> - <para> - La fonction <parameter>handler</parameter> doit accepter cinq paramètres: - <funcsynopsis> - <funcdef><replaceable>handler</replaceable></funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string <parameter>notationName</parameter></paramdef> - <paramdef>string <parameter>base</parameter></paramdef> - <paramdef>string <parameter>systemId</parameter></paramdef> - <paramdef>string <parameter>publicId</parameter></paramdef> - </funcsynopsis> - <variablelist> - <varlistentry> - <term> - <parameter>parser</parameter> - </term> - <listitem> - <simpara> - Le premier paramètre, <replaceable>parser</replaceable>, est une référence - sur l'analyseur XML qui appelle cette fonction. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>notationName</parameter></term> - <listitem> - <simpara> - Le nom de la notation,<parameter>name</parameter>, comme précisé dans le - format de notation ci dessus. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>base</parameter> - </term> - <listitem> - <simpara> - La meilleure base de résolution de l'identifiant système de cette entité - externe. Actuellement, ce paramètre est toujours une chaîne vide. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>systemId</parameter></term> - <listitem> - <simpara> - Identifiant système pour cette entitée externe. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>publicId</parameter> - </term> - <listitem> - <simpara> - Identifiant public pour cet entité externe. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - - <para> - Si un gestionnaire reçoit une chaîne vide ou FALSE, c'est qu'il est en train - d'être désactivé. - </para> - <para> - Retourne TRUE si le gestionnaire est actif, et FALSE sinon ou si - <parameter>parser</parameter> n'est pas un analyseur. - </para> - <para> - Il n'est pas pour l'instant possible d'utiliser des objets pour servir de - gestionnaires. - </para> - </refsect1> - </refentry> - - <refentry id="function.xml-set-external-entity-ref-handler"> - <refnamediv> - <refname>xml_set_external_entity_ref_handler</refname> - <refpurpose>Fixe le gestionnaire de référence externes.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int - <function>xml_set_external_entity_ref_handler</function> - </funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string <parameter>handler</parameter></paramdef> - </funcsynopsis> - <para> - Fixe le gestionnaire d'entité externe de l'analyseur XML - <parameter>parser</parameter>. <parameter>handler</parameter> et - <parameter>endElementHandler</parameter> sont des chaînes qui contiennent les - noms de fonction qui existent lorsque <function>xml_parse</function> est appelé - pour créer le <parameter>parser</parameter>. - </para> - <para> - La fonction <parameter>handler</parameter> doit accepter 5 paramètres, et - retourner un entier. Si la valeur retourné par le gestionnaire est - FALSE (comme par exemple si aucune valeur n'est retournée), l'analyseur XML - s'arrêtera, et la fonction <function>xml_get_error_code</function> retournera - <systemitem class="constant">XML_ERROR_EXTERNAL_ENTITY_HANDLING</systemitem>. - - <funcsynopsis> - <funcdef>int <replaceable>handler</replaceable></funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string - <parameter>openEntityNames</parameter> - </paramdef> - <paramdef>string <parameter>base</parameter></paramdef> - <paramdef>string <parameter>systemId</parameter></paramdef> - <paramdef>string <parameter>publicId</parameter></paramdef> - </funcsynopsis> - <variablelist> - <varlistentry> - <term><parameter>parser</parameter></term> - <listitem> - <simpara> - Le premier paramètre,<replaceable>parser</replaceable>, est une référence sur - l'analyseur XML qui appelle cette fonction. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>openEntityNames</parameter></term> - <listitem> - <simpara> - Le deuxième paramètre, <parameter>openEntityNames</parameter>, est i.e. - liste de noms d'entité, séparés par des espaces. Ces entités sont - accessibles à l'analyse par cet entité (y compris le nom de l'entité - reférencé). - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>base</parameter></term> - <listitem> - <simpara> - La meilleure base de résolution de l'identifiant système de cet entité - externe. Actuellement, ce paramètre est toujours une chaîne vide. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>systemId</parameter></term> - <listitem> - <simpara> - Identifiant système pour cet entité externe. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>publicId</parameter></term> - <listitem> - <simpara> - Le cinquième paramètre, <parameter>publicId</parameter>, est l'identifiant - public, comme spécifié dans la déclaration d'entité, ou un chaîne vide, si - aucune déclaration n'a été spécifiée. L'espace dans l'identifiant public - sera normalisé comme spécifié dans les spécifications XML. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - <para> - Si un gestionnaire reçoit une chaîne vide, ou FALSE, c'est qu'il est en train - d'être désactivé. - </para> - <para> - Retourne TRUE si le gestionnaire est actif, et FALSE sinon ou si - <parameter>parser</parameter> n'est pas un analyseur. - </para> - <para> - Il n'est pas pour l'instant possible d'utiliser des objets pour servir de - gestionnaire. - </para> - </refsect1> - </refentry> - - <refentry id="function.xml-parse"> - <refnamediv> - <refname>xml_parse</refname> - <refpurpose>Commence l'analyse d'un fichier XML.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>xml_parse</function></funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>string <parameter>data</parameter></paramdef> - <paramdef>int - <parameter><optional>isFinal</optional></parameter> - </paramdef> - </funcsynopsis> - <para> - <variablelist> - <varlistentry> - <term><parameter>parser</parameter></term> - <listitem> - <simpara> - une référence sur l'analyseur XML à utiliser. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>data</parameter></term> - <listitem> - <simpara> - Une partie des données à analyser. Un document peut être analysé morceau - par morceau, en appelant <function>xml_parse</function> plusieurs fois, - tant que le paramètre <parameter>isFinal</parameter> est mis à TRUE pour - le dernier morceau. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>isFinal</parameter> (optional)</term> - <listitem> - <simpara> - Si il vaut TRUE, <parameter>data</parameter> est la dernière partie - à analyser. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - <para> - Lorsqu'un document XML est analysé, les gestionnaires d'événements sont appelés - aussi souvent que nécessaire, et retourne TRUE ou FALSE. - </para> - <para> - TRUE est retourné lorsque l'analyse a été concluante, et FALSE en cas d'échec, - ou si <parameter>parser</parameter> n'est pas un analyseur valide. - Lors d'un échec d'analyse, la cause de l'erreur peut être obtenue grâce aux - fonctions <function>xml_get_error_code</function>, <function>xml_error_string</function>, - <function>xml_get_current_line_number</function>, <function>xml_get_current_column_number</function> - et <function>xml_get_current_byte_index</function>. - </para> - </refsect1> - </refentry> - - <refentry id="function.xml-get-error-code"> - <refnamediv> - <refname>xml_get_error_code</refname> - <refpurpose>Retourne le nombre courant de colonne d'un analyseur XML.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>xml_get_error_code</function></funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - </funcsynopsis> - <para> - <variablelist> - <varlistentry> - <term><parameter>parser</parameter></term> - <listitem> - <simpara> - Cette fonction retourne FALSE si <parameter>parser</parameter> n'est pas - valide, ou sinon, retourne le numéro de colonne courante de la ligne courante - de l'analyseur, qui correspond à la position d'analyse courante de l'analyseur - XML. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - <para> - Cette fonction retourne FALSE si <parameter>parser</parameter> n'est pas valide, - ou sinon, retourne le numéro de colonne courante de la ligne courante de - l'analyseur, qui correspond à la position d'analyse courante de l'analyseur XML. - </para> - </refsect1> - </refentry> - - <refentry id="function.xml-error-string"> - <refnamediv> - <refname>xml_error_string</refname> - <refpurpose>Lit le message d'erreur de l'analyseur XML.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>string <function>xml_error_string</function></funcdef> - <paramdef>int <parameter>code</parameter></paramdef> - </funcsynopsis> - <para> - <variablelist> - <varlistentry> - <term><parameter>code</parameter></term> - <listitem> - <simpara> - Un message d'erreur, issu de <function>xml_get_error_code</function>. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - <para> - Retourne la chaîne avec un message textuel, décrivant l'erreur - <parameter>code</parameter>, ou FALSE si aucune description n'a été trouvée. - </para> - </refsect1> - </refentry> - - <refentry id="function.xml-get-current-line-number"> - <refnamediv> - <refname>xml_get_current_line_number</refname> - <refpurpose>Retourne le numéro de ligne courant d'un analyseur XML.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int - <function>xml_get_current_line_number</function> - </funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - </funcsynopsis> - <para> - <variablelist> - <varlistentry> - <term><parameter>parser</parameter></term> - <listitem> - <simpara> - Une référence sur un analyseur XML valide. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - <para> - Cette fonction retourne FALSE si <parameter>parser</parameter> n'est pas valide, - ou sinon, retourne le numéro de la ligne en cours d'analyse. - </para> - </refsect1> - </refentry> - - <refentry id="function.xml-get-current-column-number"> - <refnamediv> - <refname>xml_get_current_column_number</refname> - <refpurpose> - Retourne le nombre courant de colonne d'un analyseur XML. - .</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int - <function>xml_get_current_column_number</function> - </funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - </funcsynopsis> - <para> - <variablelist> - <varlistentry> - <term><parameter>parser</parameter></term> - <listitem> - <simpara> - Une référence sur un analyseur XML valide. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - <para> - Cette fonction retourne FALSE si <parameter>parser</parameter> n'est pas valide, - ou sinon, retourne le numéro de colonne courante de la ligne courante de - l'analyseur, qui correspond à la position d'analyse courante de l'analyseur XML. - </para> - </refsect1> - </refentry> - - <refentry id="function.xml-get-current-byte-index"> - <refnamediv> - <refname>xml_get_current_byte_index</refname> - <refpurpose>Retourne l'index de l'octet courant d'un analyseur XML.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int - <function>xml_get_current_byte_index</function> - </funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - </funcsynopsis> - <para> - <variablelist> - <varlistentry> - <term><parameter>parser</parameter></term> - <listitem> - <simpara> - Une référence sur un analyseur XML valide. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - <para> - Cette fonction retourne FALSE si <parameter>parser</parameter> n'est pas valide, - ou sinon, retourne l'index de l'octet d'analyse courante de l'analyseur XML. - </para> - </refsect1> - </refentry> - - <refentry id="function.xml-parser-free"> - <refnamediv> - <refname>xml_parser_free</refname> - <refpurpose> Détruit un analyseur XML.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>string <function>xml_parser_free</function></funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - </funcsynopsis> - <para> - <variablelist> - <varlistentry> - <term><parameter>parser</parameter></term> - <listitem> - <simpara> - Une référence sur un analyseur XML. - </simpara> - </listitem> - </varlistentry> - </variablelist></para> - <para> - Cette fonction retourne FALSE si <parameter>parser</parameter> n'est pas une - référence valide, ou sinon, détruit l'analyseur et retourne TRUE. - </para> - </refsect1> - </refentry> - - <refentry id="function.xml-parser-set-option"> - <refnamediv> - <refname>xml_parser_set_option</refname> - <refpurpose>Affecte les options d'un analyseur XML.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>xml_parser_set_option</function></funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>int <parameter>option</parameter></paramdef> - <paramdef>mixed <parameter>value</parameter></paramdef> - </funcsynopsis> - <para> - <variablelist> - <varlistentry> - <term><parameter>parser</parameter></term> - <listitem> - <simpara> - Une référence vers un analyseur XML. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>option</parameter></term> - <listitem> - <simpara> - L'option à modifier. Voir ci dessous : - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>value</parameter></term> - <listitem> - <simpara> - La nouvelle valeur de l'option. - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - <para> - Cette fonction retourne FALSE si <parameter>parser</parameter> n'est pas une - référence valide sur un analyseur XML, ou si l'option n'a pas pu être modifiée. - Sinon, l'option est effectivement modifiée, et la fonction retourne TRUE. - </para> - <para> - Les options suivantes sont disponibles : - <table> - <title>options d'analyseur XML </title> - <tgroup cols="3"> - <thead> - <row> - <entry>Option</entry> - <entry>Type de données</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>XML_OPTION_CASE_FOLDING</entry> - <entry>entier</entry> - <entry> - Contrôle la gestion de la <link linkend="xml.case-folding">casse</link> - des balises de cet analyseur XML. Par défaut, activé. - </entry> - </row> - <row> - <entry>XML_OPTION_TARGET_ENCODING</entry> - <entry>string</entry> - <entry> - Modifie le <link linkend="xml.encoding">codage à la cible</link> - utilisé par cet analyseur XML. Par défaut, c'est celui qui a été spécifié - lors de l'appel de <function>xml_parser_create</function>. - Les codages supportés sont <literal>ISO-8859-1</literal>, <literal>US-ASCII</literal> - et <literal>UTF-8</literal>. - </entry> - </row> - </tbody> - </tgroup> - </table> - </para> - </refsect1> - </refentry> - - <refentry id="function.xml-parser-get-option"> - <refnamediv> - <refname>xml_parser_get_option</refname> - <refpurpose>Lit les options d'un analyseur XML.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>mixed - <function>xml_parser_get_option</function> - </funcdef> - <paramdef>int <parameter>parser</parameter></paramdef> - <paramdef>int <parameter>option</parameter></paramdef> - </funcsynopsis> - <para> - <variablelist> - <varlistentry> - <term><parameter>parser</parameter></term> - <listitem> - <simpara> - Une référence sur un analyseur XML valide. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>option</parameter></term> - <listitem> - <simpara> - L'option demandée. Reportez vous à <function>xml_parser_set_option</function> - pour avoir la liste des options disponibles - </simpara> - </listitem> - </varlistentry> - </variablelist> - </para> - <para> - Cette fonction retourne FALSE si <parameter>parser</parameter> n'est pas valide, - ou sinon, retourne la valeur de l'option demandée. - </para> - <para> - Reportez vous à <function>xml_parser_set_option</function> pour avoir la - liste des options disponibles - </para> - </refsect1> - </refentry> - - <refentry id="function.utf8-decode"> - <refnamediv> - <refname>utf8_decode</refname> - <refpurpose> - Converti un une chaîne UTF-8 en ISO-8859 - .</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>string <function>utf8_decode</function></funcdef> - <paramdef>string <parameter>data</parameter></paramdef> - </funcsynopsis> - <para> - Cette fonction décode la chaîne <parameter>data</parameter>, en supposant qu'elle - est au format <literal>UTF-8</literal>, et la convertit au format - <literal>ISO-8859-1</literal>. - </para> - <para> - Voir aussi <function>utf8_encode</function>pour plus de détails sur le codage - <literal>UTF-8</literal>. - </para> - </refsect1> - </refentry> - - <refentry id="function.utf8-encode"> - <refnamediv> - <refname>utf8_encode</refname> - <refpurpose>Convertit un une chaîne ISO-8859-1 en UTF-8.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>string <function>utf8_encode</function></funcdef> - <paramdef>string <parameter>data</parameter></paramdef> - </funcsynopsis> - <para> - Cette fonction code la chaîne data au format <literal>UTF-8</literal>, - et retourne la version codée. <literal>UTF-8</literal> est un mécanisme - standardisé utilisé par Unicode pour coder les caractère de grande taille dans - des flots d'octets. <literal>UTF-8</literal> est transparent pour les caractères - <abbrev>ASCII</abbrev>, il est auto-synchronisé (c'est à dire qu'un programme - peut toujours savoir dans un flot d'octet oú un caractère commence), et peut être - utilisé pour faire des comparaisons de chaînes standard, comme pour le tri. PHP - utilise l'<literal>UTF-8</literal> pour coder les caractères jusqu'à 4 octets - comme ceci : - - <table> - <title>UTF-8 encoding</title> - <tgroup cols="3"> - <thead> - <row> - <entry>octets</entry> - <entry>bits</entry> - <entry>représentation</entry> - </row> - </thead> - <tbody> - <row> - <entry>1</entry> - <entry>7</entry> - <entry>0bbbbbbb</entry> - </row> - <row> - <entry>2</entry> - <entry>11</entry> - <entry>110bbbbb 10bbbbbb</entry> - </row> - <row> - <entry>3</entry> - <entry>16</entry> - <entry>1110bbbb 10bbbbbb 10bbbbbb</entry> - </row> - <row> - <entry>4</entry> - <entry>21</entry> - <entry>11110bbb 10bbbbbb 10bbbbbb 10bbbbbb</entry> - </row> - </tbody> - </tgroup> - </table> - Chaque <replaceable>b</replaceable> représente un bit qui peut être utilisé pour - enregistrer un caractère. - </para> - </refsect1> - </refentry> - - </reference> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -sgml-parent-document:nil -sgml-default-dtd-file:"../../manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: ---> + <reference id="ref.xml"> + <title>Analyseur syntaxique XML</title> + <titleabbrev>XML</titleabbrev> + <partintro> + <sect1 id="xml.partintro"> + <title>Introduction</title> + <sect2 id="xml.intro"> + <title>A propos de XML</title> + <para> + Le langage XML (eXtensible Markup Language (Langage à Balises + Etendu)) est un format structuré de données pour les + échanges sur le web. C'est un standard défini par le + consortium World Wide Web (W3C). Plus d'informations à propos + du XML et des technologies afférentes sont accessibles (en anglais) + <ulink url="&url.xml;">&url.xml;</ulink>. + </para> + </sect2> + <sect2 id="xml.install"> + <title>Installation</title> + <para> + Cette extension de PHP utilise <productname>expat</productname>, + disponible à <ulink url="&url.expat;">&url.expat;</ulink>. + Le fichier Makefile livré avec <productname>expat</productname> + ne construit pas par défaut de librairie : il faut utiliser + la ligne suivante : + <programlisting role="makefile"> +libexpat.a: $(OBJS) + ar -rc $@ $(OBJS) + ranlib $@ + </programlisting> + Les sources RPM de expat sont disponibles à + <ulink url="&url.expat.rpm;">&url.expat.rpm;</ulink>. + </para> + <para> + Notez que si vous utilisez Apache-1.3.7 ou plus récent, vous disposez déjà + de la librairie expat. Configurez simplement PHP avec <option role="configure">--with-xml</option> + (sans aucun autre information) et la librairie expat d'Apache sera + automatiquement utilisée. + </para> + <para> + Sous UNIX, lancez la configuration de PHP avec l'option + <option role="configure">--with-xml</option>, la librairie + <productname>expat</productname> étant installée + là oú votre compilateur peut la trouver. + Si vous compilez PHP comme module de PHP 1.3.9 ou plus récent, + PHP utilisera automatiquement le module <productname>expat</productname> + livré avec Apache. Il vous faudra peut être fixer + les valeurs des variables d'environnement <envar>CPPFLAGS</envar> + et <envar>LDFLAGS</envar>, si vous avez fait une installation exotique. + </para> + <para> + Compilez PHP. <emphasis>Tada!</emphasis> C'est fait ! + </para> + </sect2> + <sect2 id="xml.about"> + <title>A propos de cette extension :</title> + <para> + Cette extension PHP supporte la librairie <productname>expat</productname> + de James Clark sous PHP. Cela vous permettra d'analyser mais + pas de valider les documents XML. Il supporte trois types de + codage différents, disponibles aussi sous PHP: + <literal>US-ASCII</literal>, <literal>ISO-8859-1</literal> et + <literal>UTF-8</literal>. <literal>UTF-16</literal> n'est pas supporté. + </para> + <para> + Cette extension vous permet de créer des + <link linkend="function.xml-parser-create">analyseurs XML</link> + puis de définir des <emphasis>points d'entrée</emphasis> + pour chaque événement XML. Les analyseurs XML disposent + de quelques + <link linkend="function.xml-parser-set-option">paramétrages</link>. + </para> + <para> + Les gestionnaires d'évènements XML sont: + <table> + <title>Les gestionnaires d'évènements XML</title> + <tgroup cols="2"> + <thead> + <row> + <entry>Fonction PHP de configuration du gestionnaire</entry> + <entry>Description de l'événement</entry> + </row> + </thead> + <tbody> + <row> + <entry><function>xml_set_element_handler</function></entry> + <entry> + Un événement est généré + à chaque fois que l'analyseur XML rencontre une balise de + début ou de fin. Deux gestionnaires sont disponibles : un + pour le début, et un pour la fin. + </entry> + </row> + <row> + <entry> + <function>xml_set_character_data_handler</function> + </entry> + <entry> + "Character data" correspond grosso modo à tout ce qui n'est + pas une balise XML, y compris les espaces entre les balises. Notez + bien que l'analyseur XML n'ajoute ou n'efface aucun espace, et que + c'est à l'application (c'est à dire vous) de + décider de la signification de ces espaces. + </entry> + </row> + <row> + <entry> + <function>xml_set_processing_instruction_handler</function> + </entry> + <entry> + Les programmeurs PHP sont habitués aux instructions + exécutables (processing instructions ou PIs). + <?php ?> est une instruction exécutable oú + php est appelé programme cible. Ces instructions sont + gérées de manière spécifiques, + (sauf le programme cible, qui est réservé à XML). + </entry> + </row> + <row> + <entry><function>xml_set_default_handler</function></entry> + <entry> + Tout ce qui n'a pas trouvé de gestionnaire est transmis + au gestionnaire par défaut. Vous retrouverez par exemple, + les déclarations de type de document dans ce gestionnaire. + </entry> + </row> + <row> + <entry> + <function>xml_set_unparsed_entity_decl_handler</function> + </entry> + <entry> + Ce gestionnaire est appelé pour gérer les + déclaration des entités non analysés. + </entry> + </row> + <row> + <entry> + <function>xml_set_notation_decl_handler</function> + </entry> + <entry> + Ce gestionnaire est appelé pour gérer les notations. + </entry> + </row> + <row> + <entry> + <function>xml_set_external_entity_ref_handler</function> + </entry> + <entry> + Ce gestionnaire est appelé lorsque l'analyseur XML trouve une + référence à un fichier externe. Cela peut + être un fichier, ou une URL. Reportez vous à + <link linkend="example.xml-external-entity">entité externe</link> + pour un exemple. + </entry> + </row> + </tbody> + </tgroup> + </table> + </para> + </sect2> + <sect2 id="xml.case-folding"> + <title>Problèmes de casse</title> + <para> + Les fonctions de gestion des balises peuvent rencontrer des balises en + minuscule, majuscule ou encore dans un mélange des deux. En XML, + la procédure standard est d' "identifier les séquences de + caractère qui ne sont pas reconnues comme majuscule, et de les + remplacer par leur équivalent majuscule". En d'autres termes, + XML met toutes lettres en majuscules. + </para> + <para> + Par défaut, tous les noms des éléments qui sont + transmis aux fonctions de gestion sont mises en majuscule. Ce + comportement est contrôlé par l'analyseur XML, et + peut être lu et modifié avec les fonctions respectives + <function>xml_parser_get_option</function> et + <function>xml_parser_set_option</function>, respectivement. + </para> + </sect2> + <sect2 id="xml.error-codes"> + <title>Error Codes</title> + <para> + Les constantes suivantes sont définies comme des codes + d'erreurs XML : (retournée par <function>xml_parse</function>) + <simplelist> + <member>XML_ERROR_NONE</member> + <member>XML_ERROR_NO_MEMORY</member> + <member>XML_ERROR_SYNTAX</member> + <member>XML_ERROR_NO_ELEMENTS</member> + <member>XML_ERROR_INVALID_TOKEN</member> + <member>XML_ERROR_UNCLOSED_TOKEN</member> + <member>XML_ERROR_PARTIAL_CHAR</member> + <member>XML_ERROR_TAG_MISMATCH</member> + <member>XML_ERROR_DUPLICATE_ATTRIBUTE</member> + <member>XML_ERROR_JUNK_AFTER_DOC_ELEMENT</member> + <member>XML_ERROR_PARAM_ENTITY_REF</member> + <member>XML_ERROR_UNDEFINED_ENTITY</member> + <member>XML_ERROR_RECURSIVE_ENTITY_REF</member> + <member>XML_ERROR_ASYNC_ENTITY</member> + <member>XML_ERROR_BAD_CHAR_REF</member> + <member>XML_ERROR_BINARY_ENTITY_REF</member> + <member>XML_ERROR_ATTRIBUTE_EXTERNAL_ENTITY_REF</member> + <member>XML_ERROR_MISPLACED_XML_PI</member> + <member>XML_ERROR_UNKNOWN_ENCODING</member> + <member>XML_ERROR_INCORRECT_ENCODING</member> + <member>XML_ERROR_UNCLOSED_CDATA_SECTION</member> + <member>XML_ERROR_EXTERNAL_ENTITY_HANDLING</member> + </simplelist> + </para> + </sect2> + <sect2 id="xml.encoding"> + <title>Codage des caractères</title> + <para> + L'extension XML de PHP supporte les caractères + <ulink url="&url.unicode;">Unicode</ulink> grâce à + différents codages. Il y a deux types de codages de + caractères : le codage à la source et le codage à + la cible. PHP utilise le <literal>UTF-8</literal> comme + représentation interne. + </para> + <para> + L'encodage à la source est effectué lors de + <link linkend="function.xml-parse">l'analyse</link> du fichier par XML. + Lors de la <link linkend="function.xml-parser-create"> création + d'un analyseur XML</link>), un type de codage à la + source doit être spécifié (et il ne pourra plus + être modifié jusqu'à la destruction de + l'analyseur). Les codages supportés sont : + <literal>ISO-8859-1</literal>, <literal>US-ASCII</literal> et + <literal>UTF-8</literal>. Les deux derniers sont des codages + à un seul octet, c'est à dire que les caractères + sont représentés sur un seul octet. <literal>UTF-8</literal> + peut représenter des caractères composés par un + nombre variable de bits (jusqu'à 21), allant de 1 à + quatre octets. Le codage par défaut utilisé par PHP + <literal>ISO-8859-1</literal>. + </para> + <para> + Le codage à la cible est effectué lorsque PHP transfert + les données aux gestionnaires XML. Lorsqu'un analyseur est + créé, le codage à la cible est spécifié + de la même façon que le codage à la source, mais + il peut être modifié à tout moment. Le codage + à la cible affectera les balises, tout comme les + données brutes, et les noms des instructions exécutables. + </para> + <para> + Si l'analyseur XML rencontre un caractère qu'il ne + connaît pas (hors limite, par exemple), il retournera une erreur. + </para> + <para> + Si PHP rencontre un caractère dans le document XML analysé, + qu'il ne peut pas représenter dans le codage à la cible + choisi, le caractère sera remplacé par un point + d'interrogation (cette attitude est suceptible de changer + ultérieurement). + </para> + </sect2> + </sect1> + <sect1 id="xml.examples"> + <title>Quelques exemples</title> + <para> + Voici une liste d'exemple de code PHP qui analyse un document XML. + </para> + <sect2 id="example.xml-structure"> + <title>Exemple de structure XML</title> + <para> + Ce premier exemple affiche la structure de l'élément + de début dans un document avec indentation. + <example> + <title>Afficher une structure XML</title> + <programlisting role="php"> +$file = "data.xml"; +$depth = array(); +function startElement($parser, $name, $attrs) { + global $depth; + for ($i = 0; $i < $depth[$parser]; $i++) { + print " "; + } + print "$name\n"; + $depth[$parser]++; +} +function endElement($parser, $name) { + global $depth; + $depth[$parser]--; +} +$xml_parser = xml_parser_create(); +xml_set_element_handler($xml_parser, "startElement", "endElement"); +if (!($fp = fopen($file, "r"))) { + die("could not open XML input"); +} +while ($data = fread($fp, 4096)) { + if (!xml_parse($xml_parser, $data, feof($fp))) { + die(sprintf("XML error: %s at line %d", + xml_error_string(xml_get_error_code($xml_parser)), + xml_get_current_line_number($xml_parser))); + } +} +xml_parser_free($xml_parser); + </programlisting> + </example> + </para> + </sect2> + <sect2 id="example.xml-map-tags"> + <title>XML Transtypage XML -> HTML</title> + <para> + <example> + <title>XML Transtypage XML -> HTML</title> + <para> + Cet exemple remplace les balises XML d'un document par des balises + HTML. Les éléments inconnus seront ignorés. + Bien entendu, cet exemple sera appliqué à un type + précis de fichiers XML. + <programlisting role="php"> +$file = "data.xml"; +$map_array = array( + "BOLD" => "B", + "EMPHASIS" => "I", + "LITERAL" => "TT" +); +function startElement($parser, $name, $attrs) { + global $map_array; + if ($htmltag = $map_array[$name]) { + print "<$htmltag>"; + } +} +function endElement($parser, $name) { + global $map_array; + if ($htmltag = $map_array[$name]) { + print "</$htmltag>"; + } +} +function characterData($parser, $data) { + print $data; +} +$xml_parser = xml_parser_create(); +// use case-folding so we are sure to find the tag in $map_array +xml_parser_set_option($xml_parser, XML_OPTION_CASE_FOLDING, true); +xml_set_element_handler($xml_parser, "startElement", "endElement"); +xml_set_character_data_handler($xml_parser, "characterData"); +if (!($fp = fopen($file, "r"))) { + die("could not open XML input"); +} +while ($data = fread($fp, 4096)) { + if (!xml_parse($xml_parser, $data, feof($fp))) { + die(sprintf("XML error: %s at line %d", + xml_error_string(xml_get_error_code($xml_parser)), + xml_get_current_line_number($xml_parser))); + } +} +xml_parser_free($xml_parser); + </programlisting> + </para> + </example> + </para> + </sect2> + <sect2 id="example.xml-external-entity"> + <title>XML Entitée externe</title> + <para> + Cet exemple exploite les références externes de XML : + il est possible d'utiliser un gestionnaire d'entité externe + pour inclure et analyser les documents, tous comme les instructions + exécutables peuvent servir à inclure et analyser + d'autres documents, et aussi fournir une indication de confiance + (voir plus bas). + </para> + <para> + Le document XML qui est utilisé dans cet exemple est fourni plus + loin dans l'exemple (<filename>xmltest.xml</filename> et + <filename>xmltest2.xml</filename>). + </para> + <para> + <example> + <title>Entitée externe</title> + <programlisting role="php"> +$file = "xmltest.xml"; +function trustedFile($file) { + // only trust local files owned by ourselves + if (!eregi("^([a-z]+)://", $file) + && fileowner($file) == getmyuid()) { + return true; + } + return false; +} +function startElement($parser, $name, $attribs) { + print "&lt;<font color=\"#0000cc\">$name</font>"; + if (sizeof($attribs)) { + while (list($k, $v) = each($attribs)) { + print " <font color=\"#009900\">$k</font>=\"<font + color=\"#990000\">$v</font>\""; + } + } + print "&gt;"; +} +function endElement($parser, $name) { + print "&lt;/<font color=\"#0000cc\">$name</font>&gt;"; +} +function characterData($parser, $data) { + print "<b>$data</b>"; +} +function PIHandler($parser, $target, $data) { + switch (strtolower($target)) { + case "php": + global $parser_file; + // If the parsed document is "trusted", we say it is safe + // to execute PHP code inside it. If not, display the code + // instead. + if (trustedFile($parser_file[$parser])) { + eval($data); + } else { + printf("Untrusted PHP code: <i>%s</i>", + htmlspecialchars($data)); + } + break; + } +} +function defaultHandler($parser, $data) { + if (substr($data, 0, 1) == "&" && substr($data, -1, 1) == ";") { + printf('<font color="#aa00aa">%s</font>', + htmlspecialchars($data)); + } else { + printf('<font size="-1">%s</font>', + htmlspecialchars($data)); + } +} +function externalEntityRefHandler($parser, $openEntityNames, $base, $systemId, + $publicId) { + if ($systemId) { + if (!list($parser, $fp) = new_xml_parser($systemId)) { + printf("Could not open entity %s at %s\n", $openEntityNames, + $systemId); + return false; + } + while ($data = fread($fp, 4096)) { + if (!xml_parse($parser, $data, feof($fp))) { + printf("XML error: %s at line %d while parsing entity %s\n", + xml_error_string(xml_get_error_code($parser)), + xml_get_current_line_number($parser), $openEntityNames); + xml_parser_free($parser); + return false; + } + } + xml_parser_free($parser); + return true; + } + return false; +} +function new_xml_parser($file) { + global $parser_file; + $xml_parser = xml_parser_create(); + xml_parser_set_option($xml_parser, XML_OPTION_CASE_FOLDING, 1); + xml_set_element_handler($xml_parser, "startElement", "endElement"); + xml_set_character_data_handler($xml_parser, "characterData"); + xml_set_processing_instruction_handler($xml_parser, "PIHandler"); + xml_set_default_handler($xml_parser, "defaultHandler"); + xml_set_external_entity_ref_handler($xml_parser, "externalEntityRefHandler"); + if (!($fp = @fopen($file, "r"))) { + return false; + } + if (!is_array($parser_file)) { + settype($parser_file, "array"); + } + $parser_file[$xml_parser] = $file; + return array($xml_parser, $fp); +} +if (!(list($xml_parser, $fp) = new_xml_parser($file))) { + die("could not open XML input"); +} +print "<pre>"; +while ($data = fread($fp, 4096)) { + if (!xml_parse($xml_parser, $data, feof($fp))) { + die(sprintf("XML error: %s at line %d\n", + xml_error_string(xml_get_error_code($xml_parser)), + xml_get_current_line_number($xml_parser))); + } +} +print "</pre>"; +print "parse complete\n"; +xml_parser_free($xml_parser); +?> + </programlisting> + </example> + </para> + <para id="example.xml-xmltest.xml"> + <example> + <title>xmltest.xml</title> + <programlisting role="xml"> +<?xml version='1.0'?> +<!DOCTYPE chapter SYSTEM "/just/a/test.dtd" [ +<!ENTITY plainEntity "FOO entity"> +<!ENTITY systemEntity SYSTEM "xmltest2.xml"> +]> +<chapter> + <TITLE>Title &plainEntity;</TITLE> + <para> + <informaltable> + <tgroup cols="3"> + <tbody> + <row><entry>a1</entry><entry morerows="1">b1</entry><entry>c1</entry></row> + <row><entry>a2</entry><entry>c2</entry></row> + <row><entry>a3</entry><entry>b3</entry><entry>c3</entry></row> + </tbody> + </tgroup> + </informaltable> + </para> + &systemEntity; + <sect1 id="about"> + <title>About this Document</title> + <para> + <!-- this is a comment --> + <?php print 'Hi! This is PHP version '.phpversion(); ?> + </para> + </sect1> +</chapter> + </programlisting> + </example> + </para> + <para id="example.xml-xmltest2.xml"> + This file is included from <filename>xmltest.xml</filename>: + <example> + <title>xmltest2.xml</title> + <programlisting role="xml"> +<?xml version="1.0"?> +<!DOCTYPE foo [ +<!ENTITY testEnt "test entity"> +]> +<foo> + <element attrib="value"/> + &testEnt; + <?php print "This is some more PHP code being executed."; ?> +</foo> + </programlisting> + </example> + </para> + </sect2> + </sect1> + </partintro> + <refentry id="function.xml-parser-create"> + <refnamediv> + <refname>xml_parser_create</refname> + <refpurpose>Création d'un analyseur XML.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>xml_parser_create</function></funcdef> + <paramdef>string + <parameter><optional>encoding</optional></parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + <para> + <variablelist> + <varlistentry> + <term><parameter>encoding</parameter> (optional)</term> + <listitem> + <para> + Le codage de caractère de l'analyseur : les codages suivants + sont supportés : + <simplelist> + <member><literal>ISO-8859-1</literal> (par défaut)</member> + <member><literal>US-ASCII</literal></member> + <member><literal>UTF-8</literal></member> + </simplelist> + </para> + </listitem> + </varlistentry> + </variablelist> + Cette fonction crée un analyseur XML et retourne une + référence sur cet analyseur pour qu'il puisse + être utilisé ultérieurement par d'autres + fonctions XML. Retourne FALSE en cas d'erreur. + </para> + </refsect1> + </refentry> + <refentry id="function.xml-set-object"> + <refnamediv> + <refname>xml_set_object</refname> + <refpurpose> + Utilise un analyseur XML à l'intérieur d'un objet. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>void <function>xml_set_object</function></funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + <paramdef>object <parameter>&object</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + Cette fonction rend l'analyseur <parameter>parser</parameter> utilisable + depuis un objet. Toutes les méthodes de callback, affectées + par <function>xml_set_element_handler</function>, seront les méthodes + de cet objet. + </para> + <programlisting role="php"> +<?php +class xml { +var $parser; +function xml() { + $this->parser = xml_parser_create(); + xml_set_object($this->parser,&$this); + xml_set_element_handler($this->parser,"tag_open","tag_close"); + xml_set_character_data_handler($this->parser,"cdata"); +} +function parse($data) { + xml_parse($this->parser,$data); +} +function tag_open($parser,$tag,$attributes) { + var_dump($parser,$tag,$attributes); +} +function cdata($parser,$cdata) { + var_dump($parser,$cdata); +} +function tag_close($parser,$tag) { + var_dump($parser,$tag); +} +} // end of class xml +$xml_parser = new xml(); +$xml_parser->parse("<A ID=\"hallo\">PHP</A>"); +?> + </programlisting> + </refsect1> + </refentry> + <refentry id="function.xml-set-element-handler"> + <refnamediv> + <refname>xml_set_element_handler</refname> + <refpurpose>Affecte les gestionnaires de début et de fin.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int + <function>xml_set_element_handler</function> + </funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + <paramdef>string + <parameter>startElementHandler</parameter> + </paramdef> + <paramdef>string + <parameter>endElementHandler</parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + <para> + Affecte les gestionnaires de début et de fin de l'analyseur XML + <parameter>parser</parameter>. <parameter>startElementHandler</parameter> + et <parameter>endElementHandler</parameter> sont des chaînes qui + contiennent les noms de fonctions qui existent lorsque + <function>xml_parse</function> est appelé pour créer + <parameter>parser</parameter>. + </para> + <para> + La fonction <parameter>startElementHandler</parameter> doit + accepter trois paramètres: + <funcsynopsis> + <funcprototype> + <funcdef><replaceable>startElementHandler</replaceable></funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + <paramdef>string <parameter>name</parameter></paramdef> + <paramdef>array <parameter>attribs</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem> + <simpara> + Le premier paramètre, <replaceable>parser</replaceable>, est une + référence sur l'analyseur XML qui appelle cette fonction. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>name</parameter></term> + <listitem> + <simpara> + Le deuxième paramètre, <parameter>name</parameter>, contient + le nom de l'élément qui a provoqué l'appel du + gestionnaire. Si l'analyseur gère la + <link linkend="xml.case-folding">casse</link>, cet élément + sera en majuscule. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>attribs</parameter></term> + <listitem> + <simpara> + Le troisième paramètre, <parameter>attribs</parameter>, + contient un tableau associatif avec les attributs de + l'éléments (si il en existe). Les clés de ce tableau + seront les noms des attributs, et les valeurs seront les valeurs + correspondantes des attributs. Les noms des attributs seront mis en + majuscule si l'analyseur gère la + <link linkend="xml.case-folding">casse</link>. Les valeurs des attributs + seront intouchées. + </simpara> + <simpara> + L'ordre original des attributs peut être retrouvé en + passant en revue le tableau <parameter>attribs</parameter>, avec + la fonction <function>each</function>. La première clé + sera la première clé du tableau. + </simpara> + </listitem> + </varlistentry> + </variablelist> + </para> + <para> + La fonction <parameter>endElementHandler</parameter> doit accepter deux + paramètres: + <funcsynopsis> + <funcprototype> + <funcdef><replaceable>endElementHandler</replaceable></funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + <paramdef>string <parameter>name</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem> + <simpara> + Le premier paramètre, <replaceable>parser</replaceable>, est une + référence sur l'analyseur XML qui appelle cette fonction. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>name</parameter></term> + <listitem> + <simpara> + Le second paramètre, <parameter>name</parameter>, contient le + nom de l'élément qui a provoqué l'appel du + gestionnaire. Si l'analyseur gère la + <link linkend="xml.case-folding">casse</link>, cet + élément sera en majuscule. + </simpara> + </listitem> + </varlistentry> + </variablelist> + </para> + <para> + Si un gestionnaire recoit une chaîne vide, ou FALSE, c'est qu'il est en + train d'être désactivé. + </para> + <para> + Retourne TRUE si le gestionnaire est actif, et FALSE sinon, ou si + <parameter>parser</parameter> n'est pas un analyseur. + </para> + <para> + Il n'est pas pour l'instant possible d'utiliser des objets pour servir de + gestionnaire. Reportez vous à <function>xml_set_object</function> pour + utiliser l'analyseur XML depuis un objet. + </para> + </refsect1> + </refentry> + <refentry id="function.xml-set-character-data-handler"> + <refnamediv> + <refname>xml_set_character_data_handler</refname> + <refpurpose>Affecte les gestionnaires de caractère bruts.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int + <function>xml_set_character_data_handler</function> + </funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + <paramdef>string <parameter>handler</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + Affecte les gestionnaires de début et de fin de l'analyseur XML + <parameter>parser</parameter>. <parameter>handler</parameter> est une + chaîne qui contient le nom d'une fonction qui existe lorsque + <function>xml_parse</function> est appelé pour créer + <parameter>parser</parameter>. + </para> + <para> + La fonction <parameter>handler</parameter> doit accepter deux paramètres: + <funcsynopsis> + <funcprototype> + <funcdef><replaceable>handler</replaceable></funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + <paramdef>string <parameter>data</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem> + <simpara> + Le premier paramètre, <replaceable>parser</replaceable>, est + une référence sur l'analyseur XML qui appelle cette fonction. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>data</parameter></term> + <listitem> + <simpara> + Le second paramètre, <parameter>data</parameter>, contient + les caractères sous la forme d'une chaîne. + </simpara> + </listitem> + </varlistentry> + </variablelist></para> + <para> + Si un gestionnaire reçoit une chaîne vide ou FALSE, c'est + qu'il est en train d'être désactivé. + </para> + <para> + Retourne TRUE si le gestionnaire est actif, et FALSE sinon, ou si + <parameter>parser</parameter> n'est pas un analyseur. + </para> + <para> + Il n'est pas pour l'instant possible d'utiliser des objets pour servir de + gestionnaire. Reportez vous à <function>xml_set_object</function> pour + utiliser l'analyseur XML depuis un objet. + </para> + </refsect1> + </refentry> + <refentry id="function.xml-set-processing-instruction-handler"> + <refnamediv> + <refname>xml_set_processing_instruction_handler</refname> + <refpurpose> + Affecte les gestionnaires d'instructions exécutables. + .</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int + <function>xml_set_processing_instruction_handler</function> + </funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + <paramdef>string <parameter>handler</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + Affecte les gestionnaires d'instructions exécutables de l'analyseur + XML <parameter>parser</parameter>. <parameter>handler</parameter> est une + chaîne qui contient le nom d'une fonction qui existe lorsque + <function>xml_parse</function> est appelé pour créer + <parameter>parser</parameter>. + </para> + <para> + Une instruction exécutable a la forme suivante :: + <informalexample> + <programlisting><? + <replaceable>target</replaceable> + <replaceable>data</replaceable>?> + </programlisting> + </informalexample> + Vous pouvez mettre du code PHP entre ces balises, mais soyez conscient d'une + des limitations des instructions exécutables de XML : la balise + de fin d'instruction éxécutable (<literal>?></literal>) + ne peut être échappée, ce qui fait que cette + séquence NE DOIT JAMAIS apparaître dans le code PHP + placé dans le document PHP. Si un tel texte apparaît, + la balise de fin d'instruction exécutable sera reconnue, et + le reste du code sera considéré comme des données + brutes (et donc, pas exécutées). + </para> + <para> + La fonction <parameter>handler</parameter> doit accepter trois paramètres: + <funcsynopsis> + <funcprototype> + <funcdef><replaceable>handler</replaceable></funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + <paramdef>string <parameter>target</parameter></paramdef> + <paramdef>string <parameter>data</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem> + <simpara> + Le premier paramètre, <replaceable>parser</replaceable>, est une + référence sur l'analyseur XML qui appelle cette fonction. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>target</parameter></term> + <listitem> + <simpara> + Le second paramètre, <parameter>target</parameter>, + contient l'application cible. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>data</parameter></term> + <listitem><simpara> + Le troisième paramètre, <parameter>data</parameter>, contient + le code sous la forme d'une chaîne. + </simpara></listitem> + </varlistentry> + </variablelist></para> + <para> + Si un gestionnaire reçoit une chaîne vide, ou FALSE, + c'est qu'il est en train d'être désactivé. + </para> + <para> + Retourne TRUE si le gestionnaire est actif, et FALSE sinon, ou si + <parameter>parser</parameter> n'est pas un analyseur. + </para> + <para> + Il n'est pas pour l'instant possible d'utiliser des objets pour servir de + gestionnaire. Reportez vous à <function>xml_set_object</function> pour + utiliser l'analyseur XML depuis un objet. + </para> + </refsect1> + </refentry> + <refentry id="function.xml-set-default-handler"> + <refnamediv> + <refname>xml_set_default_handler</refname> + <refpurpose>Affecte le gestionnaire par défaut.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int + <function>xml_set_default_handler</function> + </funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + <paramdef>string <parameter>handler</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + Affecte le gestionnaire par défaut de l'analyseur XML + <parameter>parser</parameter>. <parameter>handler</parameter> est + une chaîne qui contient le nom d'une fonction qui existe lorsque + <function>xml_parse</function> est appelé pour créer + <parameter>parser</parameter>. + </para> + <para> + La fonction <parameter>handler</parameter> doit accepter deux paramètres: + <funcsynopsis> + <funcprototype> + <funcdef><replaceable>handler</replaceable></funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + <paramdef>string <parameter>data</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <variablelist> + <varlistentry> + <term> + <parameter>parser</parameter> + </term> + <listitem> + <simpara> + Le premier paramètre, <replaceable>parser</replaceable>, est une + référence sur l'analyseur XML qui appelle cette fonction. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>data</parameter> + </term> + <listitem> + <simpara> + Le second paramètre, <parameter>data</parameter>, contient les + caractères sous la forme d'une chaîne. Cela peut être + une déclaration XML, un type de document, une entité ou + d'autre données pour qui aucun gestionnaire n'est prévu. + </simpara> + </listitem> + </varlistentry> + </variablelist> + </para> + <para> + Si un gestionnaire reçoit une chaîne vide ou FALSE, c'est + qu'il est en train d'être désactivé. + </para> + <para> + Retourne TRUE si le gestionnaire est actif, et FALSE sinon, ou si + <parameter>parser</parameter> n'est pas un analyseur. + </para> + <para> + Il n'est pas pour l'instant possible d'utiliser des objets pour servir de + gestionnaire. Reportez vous à <function>xml_set_object</function> pour + utiliser l'analyseur XML depuis un objet. + </para> + </refsect1> + </refentry> + <refentry id="function.xml-set-unparsed-entity-decl-handler"> + <refnamediv> + <refname>xml_set_unparsed_entity_decl_handler</refname> + <refpurpose> + Affecte les gestionnaires d'entité non déclaré. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int + <function>xml_set_unparsed_entity_decl_handler</function> + </funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + <paramdef>string <parameter>handler</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + Affecte les gestionnaires d'entité non déclaré de + l'analyseur XML <parameter>parser</parameter>. <parameter>handler</parameter> + est une chaîne qui contient le nom d'une fonction qui existe lorsque + <function>xml_parse</function> est appelé pour créer + <parameter>parser</parameter>. + </para> + <para> + Ce gestionnaire sera appelé si l'analyseur XML rencontre une + déclaration d'entité externe avec une déclaration + de NDATA, comme suit : + <programlisting role="xml"> +<!ENTITY <parameter>name</parameter> {<parameter>publicId</parameter> | <parameter>systemId</parameter>} + NDATA <parameter>notationName</parameter>> + </programlisting> + </para> + <para> + Reportez vous à la section + <ulink url="&url.rec-xml;#sec-external-ent">des spécifications XML 1.0</ulink> + pour connaître les notations des entités externes. + </para> + <para> + La fonction <parameter>handler</parameter> doit accepter six paramètres: + <funcsynopsis> + <funcprototype> + <funcdef><replaceable>handler</replaceable></funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + <paramdef>string <parameter>entityName</parameter></paramdef> + <paramdef>string <parameter>base</parameter></paramdef> + <paramdef>string <parameter>systemId</parameter></paramdef> + <paramdef>string <parameter>publicId</parameter></paramdef> + <paramdef>string <parameter>notationName</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem> + <simpara> + Le premier paramètre, <replaceable>parser</replaceable>, est une + référence sur l'analyseur XML qui appelle cette fonction. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>entityName</parameter></term> + <listitem> + <simpara> + Le nom de l'entitée qui va être définie + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>base</parameter></term> + <listitem> + <simpara> + La meilleure base de résolution de l'identifiant système + de cette entité externe. Actuellement, ce paramètre est + toujours une chaîne vide. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>systemId</parameter></term> + <listitem> + <simpara> + Identifiant système pour cet entité externe. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>publicId</parameter></term> + <listitem> + <simpara> + Identifiant public pour cet entité externe. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>notationName</parameter></term> + <listitem> + <simpara> + Nom de la notation de cette entité. (Voir + <function>xml_set_notation_decl_handler</function>). + </simpara> + </listitem> + </varlistentry> + </variablelist></para> + <para> + Si un gestionnaire reçoit une chaîne vide ou FALSE, + c'est qu'il est en train d'être désactivé. + </para> + <para> + Retourne TRUE si le gestionnaire est actif, et FALSE sinon, ou si + <parameter>parser</parameter> n'est pas un analyseur. + </para> + <para> + Il n'est pas pour l'instant possible d'utiliser des objets pour servir de + gestionnaire. Reportez vous à <function>xml_set_object</function> pour + utiliser l'analyseur XML depuis un objet. + </para> + </refsect1> + </refentry> + <refentry id="function.xml-set-notation-decl-handler"> + <refnamediv> + <refname>xml_set_notation_decl_handler</refname> + <refpurpose>Affecte les gestionnaires de notation.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int + <function>xml_set_notation_decl_handler</function> + </funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + <paramdef>string <parameter>handler</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + Affecte les gestionnaires de début et de fin de l'analyseur XML + <parameter>parser</parameter>. <parameter>handler</parameter> est une + chaîne qui contient le nom d'une fonction qui existe lorsque + <function>xml_parse</function> est appelé pour créer + <parameter>parser</parameter>. + </para> + <para> + Une notation est une partie du DTD du document, qui a le format suivant : + <programlisting role="xml"><!NOTATION <parameter>name</parameter> {<parameter>systemId</parameter> | + <parameter>publicId</parameter>}></programlisting> + Reportez vous à la section + <ulink url="&url.rec-xml;#sec-external-ent">des spécifications XML 1.0</ulink> + pour connaître les notations des entités externes. + </para> + <para> + La fonction <parameter>handler</parameter> doit accepter cinq + paramètres: + <funcsynopsis> + <funcprototype> + <funcdef><replaceable>handler</replaceable></funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + <paramdef>string <parameter>notationName</parameter></paramdef> + <paramdef>string <parameter>base</parameter></paramdef> + <paramdef>string <parameter>systemId</parameter></paramdef> + <paramdef>string <parameter>publicId</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <variablelist> + <varlistentry> + <term> + <parameter>parser</parameter> + </term> + <listitem> + <simpara> + Le premier paramètre, <replaceable>parser</replaceable>, est une + référence sur l'analyseur XML qui appelle cette fonction. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>notationName</parameter></term> + <listitem> + <simpara> + Le nom de la notation,<parameter>name</parameter>, comme + précisé dans le format de notation ci dessus. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>base</parameter> + </term> + <listitem> + <simpara> + La meilleure base de résolution de l'identifiant système + de cette entité externe. Actuellement, ce paramètre + est toujours une chaîne vide. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>systemId</parameter></term> + <listitem> + <simpara> + Identifiant système pour cette entitée externe. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>publicId</parameter> + </term> + <listitem> + <simpara> + Identifiant public pour cet entité externe. + </simpara> + </listitem> + </varlistentry> + </variablelist> + </para> + <para> + Si un gestionnaire reçoit une chaîne vide ou FALSE, + c'est qu'il est en train d'être désactivé. + </para> + <para> + Retourne TRUE si le gestionnaire est actif, et FALSE sinon ou si + <parameter>parser</parameter> n'est pas un analyseur. + </para> + <para> + Il n'est pas pour l'instant possible d'utiliser des objets pour servir de + gestionnaires. Reportez vous à <function>xml_set_object</function> pour + utiliser l'analyseur XML depuis un objet. + </para> + </refsect1> + </refentry> + <refentry id="function.xml-set-external-entity-ref-handler"> + <refnamediv> + <refname>xml_set_external_entity_ref_handler</refname> + <refpurpose>Fixe le gestionnaire de référence externes.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int + <function>xml_set_external_entity_ref_handler</function> + </funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + <paramdef>string <parameter>handler</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + Fixe le gestionnaire d'entité externe de l'analyseur XML + <parameter>parser</parameter>. <parameter>handler</parameter> et + <parameter>endElementHandler</parameter> sont des chaînes qui + contiennent les noms de fonction qui existent lorsque + <function>xml_parse</function> est appelé + pour créer le <parameter>parser</parameter>. + </para> + <para> + La fonction <parameter>handler</parameter> doit accepter 5 + paramètres, et retourner un entier. Si la valeur retourné par + le gestionnaire est FALSE (comme par exemple si aucune valeur n'est + retournée), l'analyseur XML s'arrêtera, et la fonction + <function>xml_get_error_code</function> retournera + <systemitem class="constant">XML_ERROR_EXTERNAL_ENTITY_HANDLING</systemitem>. + <funcsynopsis> + <funcprototype> + <funcdef>int <replaceable>handler</replaceable></funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + <paramdef>string + <parameter>openEntityNames</parameter> + </paramdef> + <paramdef>string <parameter>base</parameter></paramdef> + <paramdef>string <parameter>systemId</parameter></paramdef> + <paramdef>string <parameter>publicId</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem> + <simpara> + Le premier paramètre,<replaceable>parser</replaceable>, est une + référence sur l'analyseur XML qui appelle cette fonction. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>openEntityNames</parameter></term> + <listitem> + <simpara> + Le deuxième paramètre, <parameter>openEntityNames</parameter>, + est i.e. liste de noms d'entité, séparés par des + espaces. Ces entités sont accessibles à l'analyse par cet + entité (y compris le nom de l'entité reférencé). + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>base</parameter></term> + <listitem> + <simpara> + La meilleure base de résolution de l'identifiant système + de cet entité externe. Actuellement, ce paramètre est + toujours une chaîne vide. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>systemId</parameter></term> + <listitem> + <simpara> + Identifiant système pour cet entité externe. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>publicId</parameter></term> + <listitem> + <simpara> + Le cinquième paramètre, <parameter>publicId</parameter>, + est l'identifiant public, comme spécifié dans la + déclaration d'entité, ou un chaîne vide, si + aucune déclaration n'a été spécifiée. + L'espace dans l'identifiant public sera normalisé comme + spécifié dans les spécifications XML. + </simpara> + </listitem> + </varlistentry> + </variablelist> + </para> + <para> + Si un gestionnaire reçoit une chaîne vide, ou FALSE, c'est qu'il est en train + d'être désactivé. + </para> + <para> + Retourne TRUE si le gestionnaire est actif, et FALSE sinon ou si + <parameter>parser</parameter> n'est pas un analyseur. + </para> + <para> + Il n'est pas pour l'instant possible d'utiliser des objets pour servir de + gestionnaire. Reportez vous à <function>xml_set_object</function> pour + utiliser l'analyseur XML depuis un objet. + </para> + </refsect1> + </refentry> + <refentry id="function.xml-parse"> + <refnamediv> + <refname>xml_parse</refname> + <refpurpose>Commence l'analyse d'un fichier XML.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>xml_parse</function></funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + <paramdef>string <parameter>data</parameter></paramdef> + <paramdef>int + <parameter><optional>isFinal</optional></parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + <para> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem> + <simpara> + une référence sur l'analyseur XML à utiliser. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>data</parameter></term> + <listitem> + <simpara> + Une partie des données à analyser. Un document peut + être analysé morceau par morceau, en appelant + <function>xml_parse</function> plusieurs fois, tant que le + paramètre <parameter>isFinal</parameter> est mis à + TRUE pour le dernier morceau. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>isFinal</parameter> (optional)</term> + <listitem> + <simpara> + Si il vaut TRUE, <parameter>data</parameter> est la dernière partie + à analyser. + </simpara> + </listitem> + </varlistentry> + </variablelist> + </para> + <para> + Lorsqu'un document XML est analysé, les gestionnaires + d'événements sont appelés aussi souvent que + nécessaire, et retournent TRUE ou FALSE. + </para> + <para> + TRUE est retourné lorsque l'analyse a été concluante, + et FALSE en cas d'échec, ou si <parameter>parser</parameter> n'est pas + un analyseur valide. Lors d'un échec d'analyse, la cause de l'erreur + peut être obtenue grâce aux fonctions + <function>xml_get_error_code</function>, <function>xml_error_string</function>, + <function>xml_get_current_line_number</function>, + <function>xml_get_current_column_number</function> et + <function>xml_get_current_byte_index</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.xml-get-error-code"> + <refnamediv> + <refname>xml_get_error_code</refname> + <refpurpose>Retourne le nombre courant de colonne d'un analyseur XML.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>xml_get_error_code</function></funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem> + <simpara> + Cette fonction retourne FALSE si <parameter>parser</parameter> n'est pas + valide, ou sinon, retourne le numéro de colonne courante de la + ligne courante de l'analyseur, qui correspond à la position + d'analyse courante de l'analyseur XML. + </simpara> + </listitem> + </varlistentry> + </variablelist> + </para> + <para> + Cette fonction retourne FALSE si <parameter>parser</parameter> n'est pas valide, + ou sinon, retourne le numéro de colonne courante de la ligne courante de + l'analyseur, qui correspond à la position d'analyse courante de + l'analyseur XML. + </para> + </refsect1> + </refentry> + <refentry id="function.xml-error-string"> + <refnamediv> + <refname>xml_error_string</refname> + <refpurpose>Lit le message d'erreur de l'analyseur XML.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>xml_error_string</function></funcdef> + <paramdef>int <parameter>code</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <variablelist> + <varlistentry> + <term><parameter>code</parameter></term> + <listitem> + <simpara> + Un message d'erreur, issu de <function>xml_get_error_code</function>. + </simpara> + </listitem> + </varlistentry> + </variablelist> + </para> + <para> + Retourne la chaîne avec un message textuel, décrivant l'erreur + <parameter>code</parameter>, ou FALSE si aucune description n'a + été trouvée. + </para> + </refsect1> + </refentry> + <refentry id="function.xml-get-current-line-number"> + <refnamediv> + <refname>xml_get_current_line_number</refname> + <refpurpose> + Retourne le numéro de ligne courant d'un analyseur XML. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int + <function>xml_get_current_line_number</function> + </funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem> + <simpara> + Une référence sur un analyseur XML valide. + </simpara> + </listitem> + </varlistentry> + </variablelist> + </para> + <para> + Cette fonction retourne FALSE si <parameter>parser</parameter> n'est + pas valide, ou sinon, retourne le numéro de la ligne en cours + d'analyse. + </para> + </refsect1> + </refentry> + <refentry id="function.xml-get-current-column-number"> + <refnamediv> + <refname>xml_get_current_column_number</refname> + <refpurpose> + Retourne le nombre courant de colonne d'un analyseur XML. + .</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int + <function>xml_get_current_column_number</function> + </funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem> + <simpara> + Une référence sur un analyseur XML valide. + </simpara> + </listitem> + </varlistentry> + </variablelist> + </para> + <para> + Cette fonction retourne FALSE si <parameter>parser</parameter> n'est + pas valide, ou sinon, retourne le numéro de colonne courante + de la ligne courante de l'analyseur, qui correspond à la + position d'analyse courante de l'analyseur XML. + </para> + </refsect1> + </refentry> + <refentry id="function.xml-get-current-byte-index"> + <refnamediv> + <refname>xml_get_current_byte_index</refname> + <refpurpose>Retourne l'index de l'octet courant d'un analyseur XML.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int + <function>xml_get_current_byte_index</function> + </funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem> + <simpara> + Une référence sur un analyseur XML valide. + </simpara> + </listitem> + </varlistentry> + </variablelist> + </para> + <para> + Cette fonction retourne FALSE si <parameter>parser</parameter> n'est pas + valide, ou sinon, retourne l'index de l'octet d'analyse courante de + l'analyseur XML. + </para> + </refsect1> + </refentry> + <refentry id="function.xml-parse-into-struct"> + <refnamediv> + <refname>xml_parse_into_struct</refname> + <refpurpose>Analyse une structure XML</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>xml_parse_into_struct</function></funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + <paramdef>string <parameter>data</parameter></paramdef> + <paramdef>array <parameter>&values</parameter></paramdef> + <paramdef>array <parameter>&index</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>xml_parse_into_struct</function> analyse le fichier + XML <parameter>data</parameter>, et le place dans deux tableaux : + le premier <parameter>index</parameter> contient des pointeurs + sur la position des valeurs correspondantes dans le tableau + <parameter>values</parameter> array. Ces deux paramètres sont + passés par références. + </para> + <para> + Ci dessous, vous trouverez un exemple qui illustre la structure + des deux tableaux générés par la fonction. On utilise une balise + simple <literal>note</literal>, placée dans une autre balise + <literal>para</literal>. On analyse le tout, et on + affiche la structure générée : + <informalexample> + <programlisting> +$simple = "<para><note>simple note</note></para>"; +$p = xml_parser_create(); +xml_parse_into_struct($p,$simple,&$vals,&$index); +xml_parser_free($p); +echo "Index array\n"; +print_r($index); +echo "\nVals array\n"; +print_r($vals); + </programlisting> + </informalexample> + Lors de l'éxécution du code, l'affichage sera : + <informalexample> + <programlisting> +Index array +Array +( + [PARA] => Array + ( + [0] => 0 + [1] => 2 + ) + [NOTE] => Array + ( + [0] => 1 + ) +) +Vals array +Array +( + [0] => Array + ( + [tag] => PARA + [type] => open + [level] => 1 + ) + [1] => Array + ( + [tag] => NOTE + [type] => complete + [level] => 2 + [value] => simple note + ) + [2] => Array + ( + [tag] => PARA + [type] => close + [level] => 1 + ) +) + </programlisting> + </informalexample> + </para> + <para> + L'analyse événementielle (comme celle de expat), peut se révéler + complexe lorsque le document XML est complexe. Cette fonction ne + génère pas d'objet de type DOM, mais il génère plutôt des + structures qui peuvent être parcourues à la façon d'un arbre. + Considérons le fichier suivant, qui représente une petite base + de données XML : + <example> + <title>moldb.xml - Petite base de données moléculaire</title> + <programlisting> +<?xml version="1.0"?> +<moldb> + <molecule> + <name>Alanine</name> + <symbol>ala</symbol> + <code>A</code> + <type>hydrophobic</type> + </molecule> + <molecule> + <name>Lysine</name> + <symbol>lys</symbol> + <code>K</code> + <type>charged</type> + </molecule> +</moldb> + </programlisting> + </example> + Et maitenant, un code qui analyse le document, et génère les + objet ad hoc : + <example> + <title> + parsemoldb.php - analyse moldb.xml et crée un tableau + d'objet moléculaires + </title> + <programlisting role="php"> +<?php +class AminoAcid { + var $name; // nom de l'amino acide + var $symbol; // symbole en trois lettres + var $code; // code en une lettre + var $type; // hydrophobe, chargé ou neutre + function AminoAcid ($aa) { + foreach ($aa as $k=>$v) + $this->$k = $aa[$k]; + } +} +function readDatabase($filename) { + // read the xml database of aminoacids + $data = implode("",file($filename)); + $parser = xml_parser_create(); + xml_parser_set_option($parser,XML_OPTION_CASE_FOLDING,0); + xml_parser_set_option($parser,XML_OPTION_SKIP_WHITE,1); + xml_parse_into_struct($parser,$data,&$values,&$tags); + xml_parser_free($parser); + // parcourt les structures + foreach ($tags as $key=>$val) { + if ($key == "molecule") { + $molranges = $val; + // chaque paire contigue sont les définitions supérieures + // et inférieures de la molécule + for ($i=0; $i < count($molranges); $i+=2) { + $offset = $molranges[$i] + 1; + $len = $molranges[$i + 1] - $offset; + $tdb[] = parseMol(array_slice($values, $offset, $len)); + } + } else { + continue; + } + } + return $tdb; +} +function parseMol($mvalues) { + for ($i=0; $i < count($mvalues); $i++) + $mol[$mvalues[$i]["tag"]] = $mvalues[$i]["value"]; + return new AminoAcid($mol); +} +$db = readDatabase("moldb.xml"); +echo "** Database of AminoAcid objects:\n"; +print_r($db); +?> + </programlisting> + </example> + Après exécution de <filename>parsemoldb.php</filename>, la variable + <varname>$db</varname> contient un tableau d'objets + <classname>AminoAcid</classname>, et l'affichage le confirme : + <informalexample> + <programlisting> +** Database of AminoAcid objects: +Array +( + [0] => aminoacid Object + ( + [name] => Alanine + [symbol] => ala + [code] => A + [type] => hydrophobic + ) + [1] => aminoacid Object + ( + [name] => Lysine + [symbol] => lys + [code] => K + [type] => charged + ) +) + </programlisting> + </informalexample> + </para> + </refsect1> + </refentry> + <refentry id="function.xml-parser-free"> + <refnamediv> + <refname>xml_parser_free</refname> + <refpurpose> Détruit un analyseur XML.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>xml_parser_free</function></funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem> + <simpara> + Une référence sur un analyseur XML. + </simpara> + </listitem> + </varlistentry> + </variablelist></para> + <para> + Cette fonction retourne FALSE si <parameter>parser</parameter> + n'est pas une référence valide, ou sinon, détruit + l'analyseur et retourne TRUE. + </para> + </refsect1> + </refentry> + <refentry id="function.xml-parser-set-option"> + <refnamediv> + <refname>xml_parser_set_option</refname> + <refpurpose>Affecte les options d'un analyseur XML.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>xml_parser_set_option</function></funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + <paramdef>int <parameter>option</parameter></paramdef> + <paramdef>mixed <parameter>value</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem> + <simpara> + Une référence vers un analyseur XML. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>option</parameter></term> + <listitem> + <simpara> + L'option à modifier. Voir ci dessous : + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>value</parameter></term> + <listitem> + <simpara> + La nouvelle valeur de l'option. + </simpara> + </listitem> + </varlistentry> + </variablelist> + </para> + <para> + Cette fonction retourne FALSE si <parameter>parser</parameter> n'est pas une + référence valide sur un analyseur XML, ou si l'option + n'a pas pu être modifiée. Sinon, l'option est effectivement + modifiée, et la fonction retourne TRUE. + </para> + <para> + Les options suivantes sont disponibles : + <table> + <title>options d'analyseur XML </title> + <tgroup cols="3"> + <thead> + <row> + <entry>Option</entry> + <entry>Type de données</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>XML_OPTION_CASE_FOLDING</entry> + <entry>entier</entry> + <entry> + Contrôle la gestion de la <link linkend="xml.case-folding">casse</link> + des balises de cet analyseur XML. Par défaut, activé. + </entry> + </row> + <row> + <entry>XML_OPTION_TARGET_ENCODING</entry> + <entry>string</entry> + <entry> + Modifie le <link linkend="xml.encoding">codage à la cible</link> + utilisé par cet analyseur XML. Par défaut, c'est celui + qui a été spécifié lors de l'appel de + <function>xml_parser_create</function>. Les codages supportés + sont <literal>ISO-8859-1</literal>, <literal>US-ASCII</literal> + et <literal>UTF-8</literal>. + </entry> + </row> + </tbody> + </tgroup> + </table> + </para> + </refsect1> + </refentry> + <refentry id="function.xml-parser-get-option"> + <refnamediv> + <refname>xml_parser_get_option</refname> + <refpurpose>Lit les options d'un analyseur XML.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>mixed + <function>xml_parser_get_option</function> + </funcdef> + <paramdef>int <parameter>parser</parameter></paramdef> + <paramdef>int <parameter>option</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <variablelist> + <varlistentry> + <term><parameter>parser</parameter></term> + <listitem> + <simpara> + Une référence sur un analyseur XML valide. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>option</parameter></term> + <listitem> + <simpara> + L'option demandée. Reportez vous à + <function>xml_parser_set_option</function> pour avoir la liste des + options disponibles. + </simpara> + </listitem> + </varlistentry> + </variablelist> + </para> + <para> + Cette fonction retourne FALSE si <parameter>parser</parameter> + n'est pas valide, ou sinon, retourne la valeur de l'option demandée. + </para> + <para> + Reportez vous à <function>xml_parser_set_option</function> pour avoir la + liste des options disponibles. + </para> + </refsect1> + </refentry> + <refentry id="function.utf8-decode"> + <refnamediv> + <refname>utf8_decode</refname> + <refpurpose> + Converti un une chaîne UTF-8 en ISO-8859 + .</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>utf8_decode</function></funcdef> + <paramdef>string <parameter>data</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>utf8_decode</function> décode la chaîne + <parameter>data</parameter>, en supposant qu'elle est au format + <literal>UTF-8</literal>, et la convertit au format + <literal>ISO-8859-1</literal>. + </para> + <para> + Voir aussi <function>utf8_encode</function>pour plus de + détails sur le codage <literal>UTF-8</literal>. + </para> + </refsect1> + </refentry> + <refentry id="function.utf8-encode"> + <refnamediv> + <refname>utf8_encode</refname> + <refpurpose>Convertit un une chaîne ISO-8859-1 en UTF-8.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>utf8_encode</function></funcdef> + <paramdef>string <parameter>data</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + Cette fonction code la chaîne data au format <literal>UTF-8</literal>, + et retourne la version codée. <literal>UTF-8</literal> est un + mécanisme standardisé utilisé par Unicode pour + coder les caractère de grande taille dans des flots d'octets. + <literal>UTF-8</literal> est transparent pour les caractères + <abbrev>ASCII</abbrev>, il est auto-synchronisé (c'est à + dire qu'un programme peut toujours savoir dans un flot d'octet oú + un caractère commence), et peut être utilisé pour + faire des comparaisons de chaînes standard, comme pour le tri. PHP + utilise l'<literal>UTF-8</literal> pour coder les caractères + jusqu'à 4 octets comme ceci : + <table> + <title>UTF-8 encoding</title> + <tgroup cols="3"> + <thead> + <row> + <entry>octets</entry> + <entry>bits</entry> + <entry>représentation</entry> + </row> + </thead> + <tbody> + <row> + <entry>1</entry> + <entry>7</entry> + <entry>0bbbbbbb</entry> + </row> + <row> + <entry>2</entry> + <entry>11</entry> + <entry>110bbbbb 10bbbbbb</entry> + </row> + <row> + <entry>3</entry> + <entry>16</entry> + <entry>1110bbbb 10bbbbbb 10bbbbbb</entry> + </row> + <row> + <entry>4</entry> + <entry>21</entry> + <entry>11110bbb 10bbbbbb 10bbbbbb 10bbbbbb</entry> + </row> + </tbody> + </tgroup> + </table> + Chaque <replaceable>b</replaceable> représente un bit qui peut + être utilisé pour enregistrer un caractère. + </para> + </refsect1> + </refentry> + </reference> +<!-- Keep this comment at the end of the file +Local variables: +mode: sgml +sgml-omittag:t +sgml-shorttag:t +sgml-minimize-attributes:nil +sgml-always-quote-attributes:t +sgml-indent-step:1 +sgml-indent-data:t +sgml-parent-document:nil +sgml-default-dtd-file:"../../manual.ced" +sgml-exposed-tags:nil +sgml-local-catalogs:nil +sgml-local-ecat-files:nil +End: +-->