doc-fr/reference/xml/functions/xml-set-external-entity-ref-handler.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 3db49ee0a331a657dd97b539a749f53d3965b593 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.xml-set-external-entity-ref-handler" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>xml_set_external_entity_ref_handler</refname>
  <refpurpose>Configure le gestionnaire XML de références externes</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>xml_set_external_entity_ref_handler</methodname>
   <methodparam><type>XMLParser</type><parameter>parser</parameter></methodparam>
   <methodparam><type>callable</type><parameter>handler</parameter></methodparam>
  </methodsynopsis>
  <para>
   Affecte le gestionnaire d'entité externe de l'analyseur XML
   <parameter>parser</parameter>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>parser</parameter></term>
     <listitem>
      <para>
       Une référence d'analyseur XML à définir comme fonction
       de référence d'entités externes.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>handler</parameter></term>
     <listitem>
      <para>
       <parameter>handler</parameter> est une chaîne qui
       contient les noms de fonctions 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ée par
       le gestionnaire est &false; (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
       <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>open_entity_names</parameter></methodparam>
        <methodparam><type>string</type><parameter>base</parameter></methodparam>
        <methodparam><type>string</type><parameter>system_id</parameter></methodparam>
        <methodparam><type>string</type><parameter>public_id</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>open_entity_names</parameter></term>
         <listitem>
          <simpara>
           Le deuxième paramètre, <parameter>open_entity_names</parameter>,
           est la liste de noms d'entités, séparés par des
           espaces. Ces entités sont accessibles à l'analyse par cette
           entité (y compris le nom de l'entité référencée).
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><parameter>base</parameter></term>
         <listitem>
          <simpara>
           La meilleure base de résolution de l'identifiant système
           (<parameter>system_id</parameter>)
           de cette entité externe. Actuellement, ce paramètre est
           toujours une chaîne vide.
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><parameter>system_id</parameter></term>
         <listitem>
          <simpara>
           Identifiant système pour cette entité externe.
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><parameter>public_id</parameter></term>
         <listitem>
          <simpara>
           Le cinquième paramètre, <parameter>public_id</parameter>,
           est l'identifiant public, comme spécifié dans la
           déclaration d'entité, ou une 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>
      &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;
     <row>
      <entry>7.3.0</entry>
      <entry>
       La valeur de retour de <parameter>handler</parameter> n'est désormais
       plus ignoré quand l'extension a été compilé contre libxml. Auparavant,
       la valeur de retour était ignoré et l'analyse ne s'arrêtait jamais.
      </entry>
     </row>
    </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
-->