Files
doc-fr/reference/xml/functions/xml-set-element-handler.xml
2023-11-14 03:14:25 +00:00

158 lines
5.1 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 5a14f904d231d294e2e5b4fb5d2fc4d2fd9eddee Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<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 role="description">
&reftitle.description;
<methodsynopsis>
<type>true</type><methodname>xml_set_element_handler</methodname>
<methodparam><type>XMLParser</type><parameter>parser</parameter></methodparam>
<methodparam><type>callable</type><parameter>start_handler</parameter></methodparam>
<methodparam><type>callable</type><parameter>end_handler</parameter></methodparam>
</methodsynopsis>
<para>
Affecte les gestionnaires de début et de fin de l'analyseur XML
<parameter>parser</parameter>.
</para>
<para>
<parameter>start_handler</parameter> est appelé quand un nouvel élément XML
est ouvert. <parameter>end_handler</parameter> est appelé quand un élément
XML est fermé.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&xml.parser.param;
<varlistentry>
<term><parameter>start_handler</parameter></term>
<listitem>
&xml.handler.description;
<para>
La signature du gestionnaire doit être :
<methodsynopsis>
<type>void</type><methodname><replaceable>start_element_handler</replaceable></methodname>
<methodparam><type>XMLParser</type><parameter>parser</parameter></methodparam>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>array</type><parameter>attributes</parameter></methodparam>
</methodsynopsis>
<variablelist>
&xml.handler.parser.param;
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<simpara>
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>attributes</parameter></term>
<listitem>
<simpara>
Un tableau associatif avec les attributs de l'élément.
Le tableau est vide s'il n'y a pas d'attributs.
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 <emphasis>seront inchangées</emphasis>.
</simpara>
<simpara>
L'ordre dans lequel <parameter>attributes</parameter> est traversé
est identique à l'ordre dans lequel les attributs ont été déclaré.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>end_handler</parameter></term>
<listitem>
&xml.handler.description;
<para>
La signature du gestionnaire doit être :
<methodsynopsis>
<type>void</type><methodname><replaceable>end_element_handler</replaceable></methodname>
<methodparam><type>XMLParser</type><parameter>parser</parameter></methodparam>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
<variablelist>
&xml.handler.parser.param;
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<simpara>
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>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.true.always;
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&xml.changelog.parser-param;
</tbody>
</tgroup>
</informaltable>
</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:"~/.phpdoc/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
-->