doc-fr/reference/xml/functions/xml-parser-set-option.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 9fb00a4cf8563ea56d53cb1f72e2856b68899646 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.xml-parser-set-option" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>xml_parser_set_option</refname>
  <refpurpose>Affecte les options d'un analyseur XML</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>xml_parser_set_option</methodname>
   <methodparam><type>XMLParser</type><parameter>parser</parameter></methodparam>
   <methodparam><type>int</type><parameter>option</parameter></methodparam>
   <methodparam><type class="union"><type>string</type><type>int</type><type>bool</type></type>
<parameter>value</parameter></methodparam>
  </methodsynopsis>
  <para>
   Affecte les options d'un analyseur XML.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>parser</parameter></term>
     <listitem>
      <para>
       Une référence vers un analyseur XML.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>option</parameter></term>
     <listitem>
      <para>
       L'option à modifier. Voir ci-dessous.
      </para>
      <para>
       Les options suivantes sont disponibles :
       <table>
        <title>Options de l'analyseur XML</title>
        <tgroup cols="3">
         <thead>
          <row>
           <entry>Option</entry>
           <entry>Type de données</entry>
           <entry>Description</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry><constant>XML_OPTION_CASE_FOLDING</constant></entry>
           <entry>bool</entry>
           <entry>
            Contrôle la gestion de la <link linkend="xml.case-folding">casse</link>
            des balises de cet analyseur XML. Par défaut, activé.
           </entry>
          </row>
          <row>
           <entry><constant>XML_OPTION_SKIP_TAGSTART</constant></entry>
           <entry>bool</entry>
           <entry>
            Spécifie combien de caractères doivent être éludés du début du nom de la balise.
           </entry>
          </row>
          <row>
           <entry><constant>XML_OPTION_SKIP_WHITE</constant></entry>
           <entry>&integer;</entry>
           <entry>
            Élude ou non les valeurs contenant des caractères blancs.
           </entry>
          </row>
          <row>
           <entry><constant>XML_OPTION_TARGET_ENCODING</constant></entry>
           <entry>string</entry> 
           <entry>
            Modifie le <link linkend="xml.encoding">codage à la cible</link>
            utilisé par cet analyseur XML. Par défaut, c'est celui
            qui a été spécifié lors de l'appel de
            <function>xml_parser_create</function>. Les codages supportés
            sont <literal>ISO-8859-1</literal>, <literal>US-ASCII</literal>
            et <literal>UTF-8</literal>.
           </entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>value</parameter></term>
     <listitem>
      <para>
       La nouvelle valeur de l'option.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Renvoie &true; en cas de succès ou &false; en cas d'échec.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Lève une <classname>ValueError</classname> lorsque qu'une valeur invalide est passée
   à <parameter>option</parameter>.
  </para>
  <para>
   Antérieur à PHP 8.0.0, passer une valeur invalide à <parameter>option</parameter>
   générait un avertissement <constant>E_WARNING</constant>
   et faisait retourner à la fonction la valeur &false;.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.3.0</entry>
      <entry>
       Le paramètre <parameter>value</parameter> accepte désormais également les booléens.
       Les options <constant>XML_OPTION_CASE_FOLDING</constant> et <constant>XML_OPTION_SKIP_WHITE</constant>
       sont désormais des options booléennes.
      </entry>
     </row>
      &xml.changelog.parser-param;
     <row>
      <entry>8.0.0</entry>
      <entry>
       Une exception <classname>ValueError</classname> est désormais lancée si
       le <parameter>option</parameter> est invalide.
      </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
-->