Files
doc-fr/reference/xml/functions/xml-set-start-namespace-decl-handler.xml
2021-09-24 04:13:47 +01:00

157 lines
4.8 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 3db49ee0a331a657dd97b539a749f53d3965b593 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.xml-set-start-namespace-decl-handler" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>xml_set_start_namespace_decl_handler</refname>
<refpurpose>Configure le gestionnaire de caractères</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>xml_set_start_namespace_decl_handler</methodname>
<methodparam><type>XMLParser</type><parameter>parser</parameter></methodparam>
<methodparam><type>callable</type><parameter>handler</parameter></methodparam>
</methodsynopsis>
<para>
Définit le gestionnaire à appeler lorsque l'espace de noms est déclaré.
Les déclarations d'espace de noms surviennent dans les balises de départ.
Mais le gestionnaire de départ, appelé lors de la déclaration de l'espace
de noms, est appelé avant le gestionnaire de la balise de départ pour
chaque espace de noms déclaré dans cette balise.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>parser</parameter></term>
<listitem>
<para>
Une référence vers l'analyseur XML.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>handler</parameter></term>
<listitem>
<para>
<parameter>handler</parameter> est une chaîne contenant le nom
d'une fonction devant exister lorsque la fonction
<function>xml_parse</function> est appelé pour l'analyseur
<parameter>parser</parameter>.
</para>
<para>
La fonction nommée par le paramètre <parameter>handler</parameter>
doit accepter 3 paramètres, et doit retourner une valeur entière.
Si la valeur retournée par le gestionnaire vaut &false; (ce qui sera
le cas lorsqu'aucune valeur n'est retourné), l'analyseur XML arrêtera
l'analyse et la fonction <function>xml_get_error_code</function> retournera
<constant>XML_ERROR_EXTERNAL_ENTITY_HANDLING</constant>.
<methodsynopsis>
<methodname><replaceable>handler</replaceable></methodname>
<methodparam><type>XMLParser</type><parameter>parser</parameter></methodparam>
<methodparam><type>string</type><parameter>prefix</parameter></methodparam>
<methodparam><type>string</type><parameter>uri</parameter></methodparam>
</methodsynopsis>
<variablelist>
<varlistentry>
<term><parameter>parser</parameter></term>
<listitem>
<simpara>
Le premier paramètre, <parameter>parser</parameter>, est une référence
à l'analyseur XML appelée par le gestionnaire.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>prefix</parameter></term>
<listitem>
<simpara>
Le préfixe est une &string; utilisée pour référencer
l'espace de noms d'un objet XML.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>uri</parameter></term>
<listitem>
<simpara>
Identifiant de ressource uniforme (URI) d'un
espace de noms.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
Si une chaîne vide, ou la valeur &false;, est passée en guise de fonction
pour le gestionnaire, il sera désactivé.
</para>
&note.func-callback;
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</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>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>xml_set_end_namespace_decl_handler</function></member>
</simplelist>
</para>
</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
-->