doc-fr/reference/xml/functions/xml-set-element-handler.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.14 $ -->
<!-- EN-Revision: 1.7 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->

<refentry xml:id="function.xml-set-element-handler" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>xml_set_element_handler</refname>
  <refpurpose>Affecte les gestionnaires de début et de fin de balise XML</refpurpose>
 </refnamediv>
 <refsect1>
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>xml_set_element_handler</methodname>
   <methodparam><type>resource</type><parameter>parser</parameter></methodparam>
   <methodparam><type>callback</type><parameter>start_element_handler</parameter></methodparam>
   <methodparam><type>callback</type><parameter>end_element_handler</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>xml_set_element_handler</function> affecte les gestionnaires
   de début et de fin de l'analyseur XML
   <parameter>parser</parameter>. <parameter>start_element_handler</parameter>
   et <parameter>end_element_handler</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>start_element_handler</parameter> doit
   accepter trois paramètres :
   <methodsynopsis>
    <methodname><replaceable>start_element_handler</replaceable></methodname>
    <methodparam><type>resource</type><parameter>parser</parameter></methodparam>
    <methodparam><type>string</type><parameter>name</parameter></methodparam>
    <methodparam><type>array</type><parameter>attribs</parameter></methodparam>
   </methodsynopsis>
   <variablelist>
    <varlistentry>
     <term><parameter>parser</parameter></term>
     <listitem>
      <simpara>
       Le premier paramètre, <parameter>parser</parameter>, 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 majuscules.
      </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 (s'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
       majuscules si l'analyseur gère la
       <link linkend="xml.case-folding">casse</link>. Les valeurs des attributs
       seront inchangé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 :
   <methodsynopsis>
    <methodname><replaceable>end_element_handler</replaceable></methodname>
    <methodparam><type>resource</type><parameter>parser</parameter></methodparam>
    <methodparam><type>string</type><parameter>name</parameter></methodparam>
   </methodsynopsis>
   <variablelist>
    <varlistentry>
     <term><parameter>parser</parameter></term>
     <listitem>
      <simpara>
       Le premier paramètre, <parameter>parser</parameter>, 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 majuscules.
      </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>
   <function>xml_set_element_handler</function> retourne &true;
   si le gestionnaire est actif, et &false; sinon, ou si
   <parameter>parser</parameter> n'est pas un analyseur.
  </para>
  &note.func-callback;
 </refsect1>
</refentry>

<!-- 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
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->