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

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 5a14f904d231d294e2e5b4fb5d2fc4d2fd9eddee 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>true</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>
    &xml.parser.param;
    <varlistentry>
     <term><parameter>handler</parameter></term>
     <listitem>
      &xml.handler.description;
      <para>
       La signature du gestionnaire doit être :
       <methodsynopsis>
        <type>bool</type><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 class="union"><type>string</type><type>false</type></type><parameter>base</parameter></methodparam>
        <methodparam><type>string</type><parameter>system_id</parameter></methodparam>
        <methodparam><type class="union"><type>string</type><type>false</type></type><parameter>public_id</parameter></methodparam>
       </methodsynopsis>
       <variablelist>
        &xml.handler.parser.param;
        <varlistentry>
         <term><parameter>open_entity_names</parameter></term>
         <listitem>
          <simpara>
           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 racine pour la résolution de l'identifiant système
           (<parameter>system_id</parameter>) de l'entité externe.
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><parameter>system_id</parameter></term>
         <listitem>
          <simpara>
           L'identifiant système tel que spécifié dans la
           déclaration d'entité
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><parameter>public_id</parameter></term>
         <listitem>
          <simpara>
           L'identifiant public tel que 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>
       Le gestionnaire devrait retourner &true; si l'entité a été géré,
       sinon &false;.
       Quand &false; est retourné l'analyseur XML arrêtera l'analyse et
       <function>xml_get_error_code</function> retournera
       <constant>XML_ERROR_EXTERNAL_ENTITY_HANDLING</constant>.
      </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;
     <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
-->